Scheduler: Added EventId documentation
[senf.git] / doclib / Doxyfile.global
1 OUTPUT_DIRECTORY       = doc
2 INPUT                  = .
3 FILE_PATTERNS          = *.c *.cc *.cci *.ct *.cti *.h *.hh *.ih *.mpp *.dox
4 EXCLUDE_PATTERNS       = *.test.cc *.test.hh .* *~ "#*#"
5 IMAGE_PATH             = .
6 INPUT_FILTER           = "$(TOPDIR)/doclib/filter.pl"
7 STRIP_FROM_INC_PATH    = $(TOPDIR)
8
9 ALIASES                = "fixme=\xrefitem fixme \"Fix\" \"Fixmes\"" \
10                          "idea=\xrefitem idea \"Idea\" \"Ideas\"" \
11                          "implementation=\par \"Implementation note:\"" \
12                          "doc=\xrefitem doc \"Documentation request\" \"Documentation Requests\"" \
13                          "autotoc=\htmlonly <div id=\"autotoc\"></div> \endhtmlonly"
14 REPEAT_BRIEF           = YES
15 ALWAYS_DETAILED_SEC    = YES
16 MULTILINE_CPP_IS_BRIEF = YES
17 DETAILS_AT_TOP         = YES
18 BUILTIN_STL_SUPPORT    = YES
19 EXTRACT_ALL            = YES
20 EXTRACT_PRIVATE        = NO
21 EXTRACT_STATIC         = NO
22 SUBGROUPING            = NO
23 HIDE_FRIEND_COMPOUNDS  = YES
24 INTERNAL_DOCS          = YES
25 SOURCE_BROWSER         = YES
26 ALPHABETICAL_INDEX     = YES
27 COLS_IN_ALPHA_INDEX    = 3
28 SEARCHENGINE           = YES
29 FULL_PATH_NAMES        = YES
30
31 MACRO_EXPANSION        = YES
32 EXPAND_ONLY_PREDEF     = YES
33 PREDEFINED             = \
34     DOXYGEN \
35     "SENF_PPI_MODULE(x)=" \
36     "SENF_PARSER()=" \
37     "SENF_FIXED_PARSER()=" \
38     "SENF_PARSER_INHERIT(name)=" \
39     "SENF_PARSER_FIELD(name,type)=type name() const" \
40     "SENF_PARSER_FIELD_RO(name,type)=type::value_type name() const" \
41     "SENF_PARSER_BITFIELD(name, bits, type)=senf::ParseField_ ## type(bits) name() const" \
42     "SENF_PARSER_BITFIELD_RO(name, bits, type)=senf::ParseField_ ## type(bits)::value_type name() const" \
43     "SENF_PARSER_CUSTOM_FIELD(name, type, size, isize)=type name() const" \
44     "SENF_PARSER_PRIVATE_FIELD(name,type)=private: type name() const; public:" \
45     "SENF_PARSER_PRIVATE_FIELD_RO(name, type)=private: type::value_type name() const; public:" \
46     "SENF_PARSER_PRIVATE_BITFIELD(name, bits, type)=private: senf::ParseField_ ## type(bits) name() const; public:" \
47     "SENF_PARSER_PRIVATE_BITFIELD_RO(name, bits, type)=private: senf::ParseField_ ## type(bits)::value_type name() const; public:" \
48     "SENF_PARSER_SKIP(x)=" \
49     "SENF_PARSER_SKIP_BITS(x)=" \
50     "SENF_PARSER_GOTO(x)=" \
51     "SENF_PARSER_GOTO_OFFSET(x)=" \
52     "SENF_PARSER_LABEL(x)=" \
53     "SENF_PARSER_INIT()=void init()" \
54     "SENF_PARSER_FINALIZE(name)=" \
55     "ParseField_unsigned(b)=UIntFieldParser<?,?+b>" \
56     "ParseField_signed(b)=IntFieldParser<?,?+b>" \
57     "ParseField_bool(b)=FlagParser<?>" \
58     "SENF_PARSER_ARRAY(name,elt_type,size)=senf::Parse_Array<size,elt_type> name() const" \
59     "SENF_PARSER_LIST_B(name,elt_type,size_type)=senf::Parse_ListB<elt_type,size_type>::parser name() const" \
60     "SENF_PARSER_LIST_N(name,elt_type,size_type)=senf::Parse_ListN<elt_type,size_type>::parser name() const" \
61     "SENF_PARSER_VARIANT(name,chooser,types)=senf::Parse_Variant_Direct<chooser ## _t,?,types>::parser name() const" \
62     "SENF_PARSER_PRIVATE_VARIANT(name,chooser,types)=private: senf::Parse_Variant_Direct<chooser ## _t,?,types>::parser name() const; public:" \
63     "SENF_PARSER_VEC_N(name,elt_type,size_type)=senf::Parse_VectorN<elt_type,size_type> name() const" \
64     "SENF_LOG_CLASS_AREA()=" \
65     "SENF_LOG_DEFAULT_AREA(area)=" \
66     "SENF_LOG_DEFAULT_STREAM(stream)="
67 EXPAND_AS_DEFINED      = prefix_ SENF_LOG_DEF_STREAM SENF_LOG_DEF_AREA SENF_LOG_DEF_AREA_I
68
69 HTML_HEADER            = "$(TOPDIR)/doclib/doxy-header.html"
70 HTML_FOOTER            = "$(TOPDIR)/doclib/doxy-footer.html"
71 GENERATE_LATEX         = NO
72 GENERATE_MAN           = NO
73 GENERATE_XML           = YES
74
75 HAVE_DOT               = YES
76 CLASS_GRAPH            = YES
77 COLLABORATION_GRAPH    = NO
78 TEMPLATE_RELATIONS     = NO
79 INCLUDE_GRAPH          = YES
80 INCLUDED_BY_GRAPH      = YES
81 GROUP_GRAPHS           = NO
82 MAX_DOT_GRAPH_DEPTH    = 3
83 DOT_GRAPH_MAX_NODES    = 10
84 DOT_MULTI_TARGETS      = YES
85 DOT_CLEANUP            = NO
86 DOT_PATH               = "$(TOPDIR)/doclib"
87
88 @INCLUDE = "$(TOPDIR)/Doxyfile.local"
89
90 # Local Variables:
91 # mode: indented-text
92 # indent-tabs-mode: nil
93 # End: