44c1bf4b8b74c9c3f72a7646dc14f712610b2fbf
[senf.git] / site_scons / lib / Doxyfile.yap
1
2 INPUT                  = .
3 RECURSIVE              = NO
4 PROJECT_NAME           = "${PROJECTNAME}"
5 PROJECT_NUMBER         = "(Version ${REVISION})"
6
7 ###########################################################################
8 # Layout customization
9
10 DOXYFILE_ENCODING      = UTF-8
11 INPUT_ENCODING         = UTF-8
12
13 ALWAYS_DETAILED_SEC    = YES
14 MULTILINE_CPP_IS_BRIEF = YES
15 DETAILS_AT_TOP         = YES
16
17 ALIASES                = "fixme=\xrefitem fixme \"Fix\" \"Fixmes\"" \
18                          "idea=\xrefitem idea \"Idea\" \"Ideas\"" \
19                          "implementation=\par \"Implementation note:\"" \
20                          "doc=\xrefitem doc \"Documentation request\" \"Documentation Requests\"" \
21                          "autotoc=\htmlonly <div id=\"autotoc\"></div> \endhtmlonly" \
22                          "seechapter=<b>\htmlonly &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&rarr;&nbsp;\endhtmlonly see </b>"
23
24 BUILTIN_STL_SUPPORT    = YES
25
26 SUBGROUPING            = NO
27 EXTRACT_ALL            = YES
28 HIDE_FRIEND_COMPOUNDS  = YES
29 INTERNAL_DOCS          = YES
30
31 FILE_PATTERNS          = *.c \
32                          *.cc \
33                          *.cci \
34                          *.ct \
35                          *.cti \
36                          *.h \
37                          *.hh \
38                          *.ih \
39                          *.mpp \
40                          *.dox
41 EXCLUDE_PATTERNS       = *.test.cc \
42                          *.test.hh \
43                          .* \
44                          *~ \
45                          "#*#"
46 EXCLUDE_SYMBOLS        = boost std
47 IMAGE_PATH             = .
48
49 SOURCE_BROWSER         = YES
50 ALPHABETICAL_INDEX     = YES
51 COLS_IN_ALPHA_INDEX    = 3
52
53 GENERATE_LATEX         = NO
54 GENERATE_XML           = NO
55 GENERATE_MAN           = NO
56
57 MACRO_EXPANSION        = YES
58 EXPAND_ONLY_PREDEF     = YES
59 PREDEFINED             = DOXYGEN \
60                          "SENF_PPI_MODULE(x)=" \
61                          "SENF_PARSER()=" \
62                          "SENF_FIXED_PARSER()=" \
63                          "SENF_PARSER_INHERIT(name)=" \
64                          "SENF_PARSER_FIELD(name,type)=type name() const" \
65                          "SENF_PARSER_FIELD_RO(name,type)=type::value_type name() const" \
66                          "SENF_PARSER_BITFIELD(name, bits, type)=senf::ParseField_ ## type(bits) name() const" \
67                          "SENF_PARSER_BITFIELD_RO(name, bits, type)=senf::ParseField_ ## type(bits)::value_type name() const" \
68                          "SENF_PARSER_CUSTOM_FIELD(name, type, size, isize)=type name() const" \
69                          "SENF_PARSER_PRIVATE_FIELD(name,type)=private: type name() const; public:" \
70                          "SENF_PARSER_PRIVATE_FIELD_RO(name, type)=private: type::value_type name() const; public:" \
71                          "SENF_PARSER_PRIVATE_BITFIELD(name, bits, type)=private: senf::ParseField_ ## type(bits) name() const; public:" \
72                          "SENF_PARSER_PRIVATE_BITFIELD_RO(name, bits, type)=private: senf::ParseField_ ## type(bits)::value_type name() const; public:" \
73                          "SENF_PARSER_SKIP(x)=" \
74                          "SENF_PARSER_SKIP_BITS(x)=" \
75                          "SENF_PARSER_GOTO(x)=" \
76                          "SENF_PARSER_GOTO_OFFSET(x)=" \
77                          "SENF_PARSER_LABEL(x)=" \
78                          "SENF_PARSER_INIT()=void init()" \
79                          "SENF_PARSER_FINALIZE(name)=" \
80                          "ParseField_unsigned(b)=UIntFieldParser<?,?+b>" \
81                          "ParseField_signed(b)=IntFieldParser<?,?+b>" \
82                          "ParseField_bool(b)=FlagParser<?>" \
83                          "SENF_PARSER_ARRAY(name,elt_type,size)=senf::Parse_Array<size,elt_type> name() const" \
84                          "SENF_PARSER_LIST_B(name,elt_type,size_type)=senf::Parse_ListB<elt_type,size_type>::parser name() const" \
85                          "SENF_PARSER_LIST_N(name,elt_type,size_type)=senf::Parse_ListN<elt_type,size_type>::parser name() const" \
86                          "SENF_PARSER_VARIANT(name,chooser,types)=senf::Parse_Variant_Direct<chooser ## _t,?,types>::parser name() const" \
87                          "SENF_PARSER_PRIVATE_VARIANT(name,chooser,types)=private: senf::Parse_Variant_Direct<chooser ## _t,?,types>::parser name() const; public:" \
88                          "SENF_PARSER_VEC_N(name,elt_type,size_type)=senf::Parse_VectorN<elt_type,size_type> name() const" \
89                          "SENF_LOG_CLASS_AREA()=" \
90                          "SENF_LOG_DEFAULT_AREA(area)=" \
91                          "SENF_LOG_DEFAULT_STREAM(stream)=" \
92                          "BOOST_PP_ITERATE()=" \
93                          "BOOST_PARAMETER_KEYWORD(ns, name)=unspecified_keyword_type name;"
94 EXPAND_AS_DEFINED      = prefix_ \
95                          SENF_LOG_DEF_STREAM \
96                          SENF_LOG_DEF_AREA \
97                          SENF_LOG_DEF_AREA_I
98
99 EXTERNAL_GROUPS        = NO
100
101 HAVE_DOT               = YES
102 COLLABORATION_GRAPH    = NO
103 GROUP_GRAPHS           = NO
104 GRAPHICAL_HIERARCHY    = NO
105 DIRECTORY_GRAPH        = NO
106 DOT_GRAPH_MAX_NODES    = 10
107 MAX_DOT_GRAPH_DEPTH    = 5
108 DOT_MULTI_TARGETS      = YES
109 DOT_CLEANUP            = NO
110
111 SEARCHENGINE           = YES
112
113 ###########################################################################
114 # The following options are MANDATORY to integrate with the build system
115
116 OUTPUT_DIRECTORY       = $(output_dir)
117 STRIP_FROM_INC_PATH    = $(TOPDIR)
118 LAYOUT_FILE            = $(LIBDIR)/DoxygenLayout.xml
119 GENERATE_HTML          = $(html)
120 HTML_OUTPUT            = $(html_dir)
121 HTML_HEADER            = $(TOPDIR)/$(output_dir)/doxyheader.html
122 HTML_FOOTER            = $(TOPDIR)/$(output_dir)/doxyfooter.html
123 INPUT_FILTER           = $(LIBDIR)/filter.pl
124 TAGFILES               = $(tagfiles)
125 GENERATE_TAGFILE       = $(generate_tagfile)
126 DOT_PATH               = $(LIBDIR)
127