comparison Doxyfile @ 165:de1a008fa912

* update doxyfile
author cannam
date Wed, 09 Jul 2008 10:41:13 +0000
parents 8e11b0bbcb3c
children
comparison
equal deleted inserted replaced
164:0b9cdcc900ad 165:de1a008fa912
1 # Doxyfile 1.4.4 1 # Doxyfile 1.5.5
2 2
3 # This file describes the settings to be used by the documentation system 3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project 4 # doxygen (www.doxygen.org) for a project
5 # 5 #
6 # All text after a hash (#) is considered a comment and will be ignored 6 # All text after a hash (#) is considered a comment and will be ignored
12 12
13 #--------------------------------------------------------------------------- 13 #---------------------------------------------------------------------------
14 # Project related configuration options 14 # Project related configuration options
15 #--------------------------------------------------------------------------- 15 #---------------------------------------------------------------------------
16 16
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project. 26 # by quotes) that should identify the project.
19 27
20 PROJECT_NAME = Vamp Plugin SDK 28 PROJECT_NAME = VampPluginSDK
21 29
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or 31 # This could be handy for archiving the generated documentation or
24 # if some version control system is used. 32 # if some version control system is used.
25 33
26 PROJECT_NUMBER = 1.2 34 PROJECT_NUMBER = 1.2
27 35
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put. 37 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location 38 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used. 39 # where doxygen was started. If left blank the current directory will be used.
32 40
33 OUTPUT_DIRECTORY = doc 41 OUTPUT_DIRECTORY = doc
34 42
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36 # 4096 sub-directories (in 2 levels) under the output directory of each output 44 # 4096 sub-directories (in 2 levels) under the output directory of each output
37 # format and will distribute the generated files over these directories. 45 # format and will distribute the generated files over these directories.
38 # Enabling this option can be useful when feeding doxygen a huge amount of 46 # Enabling this option can be useful when feeding doxygen a huge amount of
39 # source files, where putting all generated files in the same directory would 47 # source files, where putting all generated files in the same directory would
40 # otherwise cause performance problems for the file system. 48 # otherwise cause performance problems for the file system.
41 49
42 CREATE_SUBDIRS = NO 50 CREATE_SUBDIRS = NO
43 51
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
45 # documentation generated by doxygen is written. Doxygen will use this 53 # documentation generated by doxygen is written. Doxygen will use this
46 # information to generate all constant output in the proper language. 54 # information to generate all constant output in the proper language.
47 # The default language is English, other supported languages are: 55 # The default language is English, other supported languages are:
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
52 # Swedish, and Ukrainian. 60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61 # and Ukrainian.
53 62
54 OUTPUT_LANGUAGE = English 63 OUTPUT_LANGUAGE = English
55 64
56 # This tag can be used to specify the encoding used in the generated output. 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57 # The encoding is not always determined by the language that is chosen, 66 # include brief member descriptions after the members that are listed in
58 # but also whether or not the output is meant for Windows or non-Windows users. 67 # the file and class documentation (similar to JavaDoc).
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60 # forces the Windows encoding (this is the default for the Windows binary),
61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
62 # all platforms other than Windows).
63
64 USE_WINDOWS_ENCODING = NO
65
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67 # include brief member descriptions after the members that are listed in
68 # the file and class documentation (similar to JavaDoc).
69 # Set to NO to disable this. 68 # Set to NO to disable this.
70 69
71 BRIEF_MEMBER_DESC = YES 70 BRIEF_MEMBER_DESC = YES
72 71
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74 # the brief description of a member or function before the detailed description. 73 # the brief description of a member or function before the detailed description.
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76 # brief descriptions will be completely suppressed. 75 # brief descriptions will be completely suppressed.
77 76
78 REPEAT_BRIEF = YES 77 REPEAT_BRIEF = YES
79 78
80 # This tag implements a quasi-intelligent brief description abbreviator 79 # This tag implements a quasi-intelligent brief description abbreviator
81 # that is used to form the text in various listings. Each string 80 # that is used to form the text in various listings. Each string
82 # in this list, if found as the leading text of the brief description, will be 81 # in this list, if found as the leading text of the brief description, will be
83 # stripped from the text and the result after processing the whole list, is 82 # stripped from the text and the result after processing the whole list, is
84 # used as the annotated text. Otherwise, the brief description is used as-is. 83 # used as the annotated text. Otherwise, the brief description is used as-is.
85 # If left blank, the following values are used ("$name" is automatically 84 # If left blank, the following values are used ("$name" is automatically
86 # replaced with the name of the entity): "The $name class" "The $name widget" 85 # replaced with the name of the entity): "The $name class" "The $name widget"
87 # "The $name file" "is" "provides" "specifies" "contains" 86 # "The $name file" "is" "provides" "specifies" "contains"
88 # "represents" "a" "an" "the" 87 # "represents" "a" "an" "the"
89 88
90 ABBREVIATE_BRIEF = 89 ABBREVIATE_BRIEF =
91 90
92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93 # Doxygen will generate a detailed section even if there is only a brief 92 # Doxygen will generate a detailed section even if there is only a brief
94 # description. 93 # description.
95 94
96 ALWAYS_DETAILED_SEC = NO 95 ALWAYS_DETAILED_SEC = NO
97 96
98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99 # inherited members of a class in the documentation of that class as if those 98 # inherited members of a class in the documentation of that class as if those
100 # members were ordinary class members. Constructors, destructors and assignment 99 # members were ordinary class members. Constructors, destructors and assignment
101 # operators of the base classes will not be shown. 100 # operators of the base classes will not be shown.
102 101
103 INLINE_INHERITED_MEMB = YES 102 INLINE_INHERITED_MEMB = YES
104 103
105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106 # path before files name in the file list and in the header files. If set 105 # path before files name in the file list and in the header files. If set
107 # to NO the shortest path that makes the file name unique will be used 106 # to NO the shortest path that makes the file name unique will be used.
108 107
109 FULL_PATH_NAMES = NO 108 FULL_PATH_NAMES = NO
110 109
111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112 # can be used to strip a user-defined part of the path. Stripping is 111 # can be used to strip a user-defined part of the path. Stripping is
113 # only done if one of the specified strings matches the left-hand part of 112 # only done if one of the specified strings matches the left-hand part of
114 # the path. The tag can be used to show relative paths in the file list. 113 # the path. The tag can be used to show relative paths in the file list.
115 # If left blank the directory from which doxygen is run is used as the 114 # If left blank the directory from which doxygen is run is used as the
116 # path to strip. 115 # path to strip.
117 116
118 STRIP_FROM_PATH = 117 STRIP_FROM_PATH =
119 118
120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121 # the path mentioned in the documentation of a class, which tells 120 # the path mentioned in the documentation of a class, which tells
122 # the reader which header file to include in order to use a class. 121 # the reader which header file to include in order to use a class.
123 # If left blank only the name of the header file containing the class 122 # If left blank only the name of the header file containing the class
124 # definition is used. Otherwise one should specify the include paths that 123 # definition is used. Otherwise one should specify the include paths that
125 # are normally passed to the compiler using the -I flag. 124 # are normally passed to the compiler using the -I flag.
126 125
127 STRIP_FROM_INC_PATH = 126 STRIP_FROM_INC_PATH =
128 127
129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
130 # (but less readable) file names. This can be useful is your file systems 129 # (but less readable) file names. This can be useful is your file systems
131 # doesn't support long names like on DOS, Mac, or CD-ROM. 130 # doesn't support long names like on DOS, Mac, or CD-ROM.
132 131
133 SHORT_NAMES = NO 132 SHORT_NAMES = NO
134 133
135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136 # will interpret the first line (until the first dot) of a JavaDoc-style 135 # will interpret the first line (until the first dot) of a JavaDoc-style
137 # comment as the brief description. If set to NO, the JavaDoc 136 # comment as the brief description. If set to NO, the JavaDoc
138 # comments will behave just like the Qt-style comments (thus requiring an 137 # comments will behave just like regular Qt-style comments
139 # explicit @brief command for a brief description. 138 # (thus requiring an explicit @brief command for a brief description.)
140 139
141 JAVADOC_AUTOBRIEF = YES 140 JAVADOC_AUTOBRIEF = YES
142 141
143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
144 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 143 # interpret the first line (until the first dot) of a Qt-style
145 # comments) as a brief description. This used to be the default behaviour. 144 # comment as the brief description. If set to NO, the comments
146 # The new default is to treat a multi-line C++ comment block as a detailed 145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
147
148 QT_AUTOBRIEF = NO
149
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
147 # description. Set this tag to YES if you prefer the old behaviour instead. 154 # description. Set this tag to YES if you prefer the old behaviour instead.
148 155
149 MULTILINE_CPP_IS_BRIEF = NO 156 MULTILINE_CPP_IS_BRIEF = NO
150 157
151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 158 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
152 # will output the detailed description near the top, like JavaDoc. 159 # will output the detailed description near the top, like JavaDoc.
153 # If set to NO, the detailed description appears after the member 160 # If set to NO, the detailed description appears after the member
154 # documentation. 161 # documentation.
155 162
156 DETAILS_AT_TOP = YES 163 DETAILS_AT_TOP = YES
157 164
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 165 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159 # member inherits the documentation from any documented member that it 166 # member inherits the documentation from any documented member that it
160 # re-implements. 167 # re-implements.
161 168
162 INHERIT_DOCS = YES 169 INHERIT_DOCS = YES
163 170
164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165 # tag is set to YES, then doxygen will reuse the documentation of the first 172 # a new page for each member. If set to NO, the documentation of a member will
166 # member in the group (if any) for the other members of the group. By default 173 # be part of the file/class/namespace that contains it.
174
175 SEPARATE_MEMBER_PAGES = NO
176
177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
178 # Doxygen uses this value to replace tabs by spaces in code fragments.
179
180 TAB_SIZE = 8
181
182 # This tag can be used to specify a number of aliases that acts
183 # as commands in the documentation. An alias has the form "name=value".
184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
185 # put the command \sideeffect (or @sideeffect) in the documentation, which
186 # will result in a user-defined paragraph with heading "Side Effects:".
187 # You can put \n's in the value part of an alias to insert newlines.
188
189 ALIASES =
190
191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192 # sources only. Doxygen will then generate output that is more tailored for C.
193 # For instance, some of the names that are used will be different. The list
194 # of all members will be omitted, etc.
195
196 OPTIMIZE_OUTPUT_FOR_C = NO
197
198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199 # sources only. Doxygen will then generate output that is more tailored for
200 # Java. For instance, namespaces will be presented as packages, qualified
201 # scopes will look different, etc.
202
203 OPTIMIZE_OUTPUT_JAVA = NO
204
205 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206 # sources only. Doxygen will then generate output that is more tailored for
207 # Fortran.
208
209 OPTIMIZE_FOR_FORTRAN = NO
210
211 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212 # sources. Doxygen will then generate output that is tailored for
213 # VHDL.
214
215 OPTIMIZE_OUTPUT_VHDL = NO
216
217 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218 # to include (a tag file for) the STL sources as input, then you should
219 # set this tag to YES in order to let doxygen match functions declarations and
220 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221 # func(std::string) {}). This also make the inheritance and collaboration
222 # diagrams that involve STL classes more complete and accurate.
223
224 BUILTIN_STL_SUPPORT = NO
225
226 # If you use Microsoft's C++/CLI language, you should set this option to YES to
227 # enable parsing support.
228
229 CPP_CLI_SUPPORT = NO
230
231 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232 # Doxygen will parse them like normal C++ but will assume all classes use public
233 # instead of private inheritance when no explicit protection keyword is present.
234
235 SIP_SUPPORT = NO
236
237 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
238 # tag is set to YES, then doxygen will reuse the documentation of the first
239 # member in the group (if any) for the other members of the group. By default
167 # all members of a group must be documented explicitly. 240 # all members of a group must be documented explicitly.
168 241
169 DISTRIBUTE_GROUP_DOC = NO 242 DISTRIBUTE_GROUP_DOC = NO
170 243
171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 244 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
172 # a new page for each member. If set to NO, the documentation of a member will 245 # the same type (for instance a group of public functions) to be put as a
173 # be part of the file/class/namespace that contains it. 246 # subgroup of that type (e.g. under the Public Functions section). Set it to
174 247 # NO to prevent subgrouping. Alternatively, this can be done per class using
175 SEPARATE_MEMBER_PAGES = NO
176
177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
178 # Doxygen uses this value to replace tabs by spaces in code fragments.
179
180 TAB_SIZE = 8
181
182 # This tag can be used to specify a number of aliases that acts
183 # as commands in the documentation. An alias has the form "name=value".
184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
185 # put the command \sideeffect (or @sideeffect) in the documentation, which
186 # will result in a user-defined paragraph with heading "Side Effects:".
187 # You can put \n's in the value part of an alias to insert newlines.
188
189 ALIASES =
190
191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192 # sources only. Doxygen will then generate output that is more tailored for C.
193 # For instance, some of the names that are used will be different. The list
194 # of all members will be omitted, etc.
195
196 OPTIMIZE_OUTPUT_FOR_C = NO
197
198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
199 # only. Doxygen will then generate output that is more tailored for Java.
200 # For instance, namespaces will be presented as packages, qualified scopes
201 # will look different, etc.
202
203 OPTIMIZE_OUTPUT_JAVA = NO
204
205 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
206 # the same type (for instance a group of public functions) to be put as a
207 # subgroup of that type (e.g. under the Public Functions section). Set it to
208 # NO to prevent subgrouping. Alternatively, this can be done per class using
209 # the \nosubgrouping command. 248 # the \nosubgrouping command.
210 249
211 SUBGROUPING = YES 250 SUBGROUPING = YES
212 251
252 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
253 # is documented as struct, union, or enum with the name of the typedef. So
254 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
255 # with name TypeT. When disabled the typedef will appear as a member of a file,
256 # namespace, or class. And the struct will be named TypeS. This can typically
257 # be useful for C code in case the coding convention dictates that all compound
258 # types are typedef'ed and only the typedef is referenced, never the tag name.
259
260 TYPEDEF_HIDES_STRUCT = NO
261
213 #--------------------------------------------------------------------------- 262 #---------------------------------------------------------------------------
214 # Build related configuration options 263 # Build related configuration options
215 #--------------------------------------------------------------------------- 264 #---------------------------------------------------------------------------
216 265
217 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 266 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
218 # documentation are documented, even if no documentation was available. 267 # documentation are documented, even if no documentation was available.
219 # Private class members and static file members will be hidden unless 268 # Private class members and static file members will be hidden unless
220 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 269 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
221 270
222 EXTRACT_ALL = YES 271 EXTRACT_ALL = YES
223 272
224 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 273 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
225 # will be included in the documentation. 274 # will be included in the documentation.
226 275
227 EXTRACT_PRIVATE = YES 276 EXTRACT_PRIVATE = YES
228 277
229 # If the EXTRACT_STATIC tag is set to YES all static members of a file 278 # If the EXTRACT_STATIC tag is set to YES all static members of a file
230 # will be included in the documentation. 279 # will be included in the documentation.
231 280
232 EXTRACT_STATIC = YES 281 EXTRACT_STATIC = YES
233 282
234 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 283 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
235 # defined locally in source files will be included in the documentation. 284 # defined locally in source files will be included in the documentation.
236 # If set to NO only classes defined in header files are included. 285 # If set to NO only classes defined in header files are included.
237 286
238 EXTRACT_LOCAL_CLASSES = YES 287 EXTRACT_LOCAL_CLASSES = YES
239 288
240 # This flag is only useful for Objective-C code. When set to YES local 289 # This flag is only useful for Objective-C code. When set to YES local
241 # methods, which are defined in the implementation section but not in 290 # methods, which are defined in the implementation section but not in
242 # the interface are included in the documentation. 291 # the interface are included in the documentation.
243 # If set to NO (the default) only methods in the interface are included. 292 # If set to NO (the default) only methods in the interface are included.
244 293
245 EXTRACT_LOCAL_METHODS = NO 294 EXTRACT_LOCAL_METHODS = NO
246 295
247 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 296 # If this flag is set to YES, the members of anonymous namespaces will be
248 # undocumented members of documented classes, files or namespaces. 297 # extracted and appear in the documentation as a namespace called
249 # If set to NO (the default) these members will be included in the 298 # 'anonymous_namespace{file}', where file will be replaced with the base
250 # various overviews, but no documentation section is generated. 299 # name of the file that contains the anonymous namespace. By default
300 # anonymous namespace are hidden.
301
302 EXTRACT_ANON_NSPACES = NO
303
304 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
305 # undocumented members of documented classes, files or namespaces.
306 # If set to NO (the default) these members will be included in the
307 # various overviews, but no documentation section is generated.
251 # This option has no effect if EXTRACT_ALL is enabled. 308 # This option has no effect if EXTRACT_ALL is enabled.
252 309
253 HIDE_UNDOC_MEMBERS = NO 310 HIDE_UNDOC_MEMBERS = NO
254 311
255 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 312 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
256 # undocumented classes that are normally visible in the class hierarchy. 313 # undocumented classes that are normally visible in the class hierarchy.
257 # If set to NO (the default) these classes will be included in the various 314 # If set to NO (the default) these classes will be included in the various
258 # overviews. This option has no effect if EXTRACT_ALL is enabled. 315 # overviews. This option has no effect if EXTRACT_ALL is enabled.
259 316
260 HIDE_UNDOC_CLASSES = NO 317 HIDE_UNDOC_CLASSES = NO
261 318
262 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 319 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
263 # friend (class|struct|union) declarations. 320 # friend (class|struct|union) declarations.
264 # If set to NO (the default) these declarations will be included in the 321 # If set to NO (the default) these declarations will be included in the
265 # documentation. 322 # documentation.
266 323
267 HIDE_FRIEND_COMPOUNDS = NO 324 HIDE_FRIEND_COMPOUNDS = NO
268 325
269 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 326 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
270 # documentation blocks found inside the body of a function. 327 # documentation blocks found inside the body of a function.
271 # If set to NO (the default) these blocks will be appended to the 328 # If set to NO (the default) these blocks will be appended to the
272 # function's detailed documentation block. 329 # function's detailed documentation block.
273 330
274 HIDE_IN_BODY_DOCS = NO 331 HIDE_IN_BODY_DOCS = NO
275 332
276 # The INTERNAL_DOCS tag determines if documentation 333 # The INTERNAL_DOCS tag determines if documentation
277 # that is typed after a \internal command is included. If the tag is set 334 # that is typed after a \internal command is included. If the tag is set
278 # to NO (the default) then the documentation will be excluded. 335 # to NO (the default) then the documentation will be excluded.
279 # Set it to YES to include the internal documentation. 336 # Set it to YES to include the internal documentation.
280 337
281 INTERNAL_DOCS = NO 338 INTERNAL_DOCS = NO
282 339
283 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 340 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
284 # file names in lower-case letters. If set to YES upper-case letters are also 341 # file names in lower-case letters. If set to YES upper-case letters are also
285 # allowed. This is useful if you have classes or files whose names only differ 342 # allowed. This is useful if you have classes or files whose names only differ
286 # in case and if your file system supports case sensitive file names. Windows 343 # in case and if your file system supports case sensitive file names. Windows
287 # and Mac users are advised to set this option to NO. 344 # and Mac users are advised to set this option to NO.
288 345
289 CASE_SENSE_NAMES = YES 346 CASE_SENSE_NAMES = YES
290 347
291 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 348 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
292 # will show members with their full class and namespace scopes in the 349 # will show members with their full class and namespace scopes in the
293 # documentation. If set to YES the scope will be hidden. 350 # documentation. If set to YES the scope will be hidden.
294 351
295 HIDE_SCOPE_NAMES = NO 352 HIDE_SCOPE_NAMES = NO
296 353
297 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 354 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
298 # will put a list of the files that are included by a file in the documentation 355 # will put a list of the files that are included by a file in the documentation
299 # of that file. 356 # of that file.
300 357
301 SHOW_INCLUDE_FILES = YES 358 SHOW_INCLUDE_FILES = YES
302 359
303 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 360 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
304 # is inserted in the documentation for inline members. 361 # is inserted in the documentation for inline members.
305 362
306 INLINE_INFO = YES 363 INLINE_INFO = YES
307 364
308 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 365 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
309 # will sort the (detailed) documentation of file and class members 366 # will sort the (detailed) documentation of file and class members
310 # alphabetically by member name. If set to NO the members will appear in 367 # alphabetically by member name. If set to NO the members will appear in
311 # declaration order. 368 # declaration order.
312 369
313 SORT_MEMBER_DOCS = NO 370 SORT_MEMBER_DOCS = NO
314 371
315 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 372 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
316 # brief documentation of file, namespace and class members alphabetically 373 # brief documentation of file, namespace and class members alphabetically
317 # by member name. If set to NO (the default) the members will appear in 374 # by member name. If set to NO (the default) the members will appear in
318 # declaration order. 375 # declaration order.
319 376
320 SORT_BRIEF_DOCS = NO 377 SORT_BRIEF_DOCS = NO
321 378
322 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 379 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
323 # sorted by fully-qualified names, including namespaces. If set to 380 # hierarchy of group names into alphabetical order. If set to NO (the default)
324 # NO (the default), the class list will be sorted only by class name, 381 # the group names will appear in their defined order.
325 # not including the namespace part. 382
383 SORT_GROUP_NAMES = NO
384
385 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
386 # sorted by fully-qualified names, including namespaces. If set to
387 # NO (the default), the class list will be sorted only by class name,
388 # not including the namespace part.
326 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 389 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
327 # Note: This option applies only to the class list, not to the 390 # Note: This option applies only to the class list, not to the
328 # alphabetical list. 391 # alphabetical list.
329 392
330 SORT_BY_SCOPE_NAME = NO 393 SORT_BY_SCOPE_NAME = NO
331 394
332 # The GENERATE_TODOLIST tag can be used to enable (YES) or 395 # The GENERATE_TODOLIST tag can be used to enable (YES) or
333 # disable (NO) the todo list. This list is created by putting \todo 396 # disable (NO) the todo list. This list is created by putting \todo
334 # commands in the documentation. 397 # commands in the documentation.
335 398
336 GENERATE_TODOLIST = YES 399 GENERATE_TODOLIST = YES
337 400
338 # The GENERATE_TESTLIST tag can be used to enable (YES) or 401 # The GENERATE_TESTLIST tag can be used to enable (YES) or
339 # disable (NO) the test list. This list is created by putting \test 402 # disable (NO) the test list. This list is created by putting \test
340 # commands in the documentation. 403 # commands in the documentation.
341 404
342 GENERATE_TESTLIST = YES 405 GENERATE_TESTLIST = YES
343 406
344 # The GENERATE_BUGLIST tag can be used to enable (YES) or 407 # The GENERATE_BUGLIST tag can be used to enable (YES) or
345 # disable (NO) the bug list. This list is created by putting \bug 408 # disable (NO) the bug list. This list is created by putting \bug
346 # commands in the documentation. 409 # commands in the documentation.
347 410
348 GENERATE_BUGLIST = YES 411 GENERATE_BUGLIST = YES
349 412
350 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 413 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
351 # disable (NO) the deprecated list. This list is created by putting 414 # disable (NO) the deprecated list. This list is created by putting
352 # \deprecated commands in the documentation. 415 # \deprecated commands in the documentation.
353 416
354 GENERATE_DEPRECATEDLIST= YES 417 GENERATE_DEPRECATEDLIST= YES
355 418
356 # The ENABLED_SECTIONS tag can be used to enable conditional 419 # The ENABLED_SECTIONS tag can be used to enable conditional
357 # documentation sections, marked by \if sectionname ... \endif. 420 # documentation sections, marked by \if sectionname ... \endif.
358 421
359 ENABLED_SECTIONS = 422 ENABLED_SECTIONS =
360 423
361 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 424 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
362 # the initial value of a variable or define consists of for it to appear in 425 # the initial value of a variable or define consists of for it to appear in
363 # the documentation. If the initializer consists of more lines than specified 426 # the documentation. If the initializer consists of more lines than specified
364 # here it will be hidden. Use a value of 0 to hide initializers completely. 427 # here it will be hidden. Use a value of 0 to hide initializers completely.
365 # The appearance of the initializer of individual variables and defines in the 428 # The appearance of the initializer of individual variables and defines in the
366 # documentation can be controlled using \showinitializer or \hideinitializer 429 # documentation can be controlled using \showinitializer or \hideinitializer
367 # command in the documentation regardless of this setting. 430 # command in the documentation regardless of this setting.
368 431
369 MAX_INITIALIZER_LINES = 30 432 MAX_INITIALIZER_LINES = 30
370 433
371 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 434 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
372 # at the bottom of the documentation of classes and structs. If set to YES the 435 # at the bottom of the documentation of classes and structs. If set to YES the
373 # list will mention the files that were used to generate the documentation. 436 # list will mention the files that were used to generate the documentation.
374 437
375 SHOW_USED_FILES = YES 438 SHOW_USED_FILES = YES
376 439
377 # If the sources in your project are distributed over multiple directories 440 # If the sources in your project are distributed over multiple directories
378 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 441 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
379 # in the documentation. The default is YES. 442 # in the documentation. The default is NO.
380 443
381 SHOW_DIRECTORIES = YES 444 SHOW_DIRECTORIES = YES
382 445
383 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 446 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
384 # doxygen should invoke to get the current version for each file (typically from the 447 # doxygen should invoke to get the current version for each file (typically from
385 # version control system). Doxygen will invoke the program by executing (via 448 # the version control system). Doxygen will invoke the program by executing (via
386 # popen()) the command <command> <input-file>, where <command> is the value of 449 # popen()) the command <command> <input-file>, where <command> is the value of
387 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 450 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
388 # provided by doxygen. Whatever the progam writes to standard output 451 # provided by doxygen. Whatever the program writes to standard output
389 # is used as the file version. See the manual for examples. 452 # is used as the file version. See the manual for examples.
390 453
391 FILE_VERSION_FILTER = 454 FILE_VERSION_FILTER =
392 455
393 #--------------------------------------------------------------------------- 456 #---------------------------------------------------------------------------
394 # configuration options related to warning and progress messages 457 # configuration options related to warning and progress messages
395 #--------------------------------------------------------------------------- 458 #---------------------------------------------------------------------------
396 459
397 # The QUIET tag can be used to turn on/off the messages that are generated 460 # The QUIET tag can be used to turn on/off the messages that are generated
398 # by doxygen. Possible values are YES and NO. If left blank NO is used. 461 # by doxygen. Possible values are YES and NO. If left blank NO is used.
399 462
400 QUIET = NO 463 QUIET = NO
401 464
402 # The WARNINGS tag can be used to turn on/off the warning messages that are 465 # The WARNINGS tag can be used to turn on/off the warning messages that are
403 # generated by doxygen. Possible values are YES and NO. If left blank 466 # generated by doxygen. Possible values are YES and NO. If left blank
404 # NO is used. 467 # NO is used.
405 468
406 WARNINGS = YES 469 WARNINGS = YES
407 470
408 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 471 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
409 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 472 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
410 # automatically be disabled. 473 # automatically be disabled.
411 474
412 WARN_IF_UNDOCUMENTED = YES 475 WARN_IF_UNDOCUMENTED = YES
413 476
414 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 477 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
415 # potential errors in the documentation, such as not documenting some 478 # potential errors in the documentation, such as not documenting some
416 # parameters in a documented function, or documenting parameters that 479 # parameters in a documented function, or documenting parameters that
417 # don't exist or using markup commands wrongly. 480 # don't exist or using markup commands wrongly.
418 481
419 WARN_IF_DOC_ERROR = YES 482 WARN_IF_DOC_ERROR = YES
420 483
421 # This WARN_NO_PARAMDOC option can be abled to get warnings for 484 # This WARN_NO_PARAMDOC option can be abled to get warnings for
422 # functions that are documented, but have no documentation for their parameters 485 # functions that are documented, but have no documentation for their parameters
423 # or return value. If set to NO (the default) doxygen will only warn about 486 # or return value. If set to NO (the default) doxygen will only warn about
424 # wrong or incomplete parameter documentation, but not about the absence of 487 # wrong or incomplete parameter documentation, but not about the absence of
425 # documentation. 488 # documentation.
426 489
427 WARN_NO_PARAMDOC = YES 490 WARN_NO_PARAMDOC = YES
428 491
429 # The WARN_FORMAT tag determines the format of the warning messages that 492 # The WARN_FORMAT tag determines the format of the warning messages that
430 # doxygen can produce. The string should contain the $file, $line, and $text 493 # doxygen can produce. The string should contain the $file, $line, and $text
431 # tags, which will be replaced by the file and line number from which the 494 # tags, which will be replaced by the file and line number from which the
432 # warning originated and the warning text. Optionally the format may contain 495 # warning originated and the warning text. Optionally the format may contain
433 # $version, which will be replaced by the version of the file (if it could 496 # $version, which will be replaced by the version of the file (if it could
434 # be obtained via FILE_VERSION_FILTER) 497 # be obtained via FILE_VERSION_FILTER)
435 498
436 WARN_FORMAT = "$file:$line: $text" 499 WARN_FORMAT = "$file:$line: $text"
437 500
438 # The WARN_LOGFILE tag can be used to specify a file to which warning 501 # The WARN_LOGFILE tag can be used to specify a file to which warning
439 # and error messages should be written. If left blank the output is written 502 # and error messages should be written. If left blank the output is written
440 # to stderr. 503 # to stderr.
441 504
442 WARN_LOGFILE = docs/doxygen/warning.log 505 WARN_LOGFILE = docs/doxygen/warning.log
443 506
444 #--------------------------------------------------------------------------- 507 #---------------------------------------------------------------------------
445 # configuration options related to the input files 508 # configuration options related to the input files
446 #--------------------------------------------------------------------------- 509 #---------------------------------------------------------------------------
447 510
448 # The INPUT tag can be used to specify the files and/or directories that contain 511 # The INPUT tag can be used to specify the files and/or directories that contain
449 # documented source files. You may enter file names like "myfile.cpp" or 512 # documented source files. You may enter file names like "myfile.cpp" or
450 # directories like "/usr/src/myproject". Separate the files or directories 513 # directories like "/usr/src/myproject". Separate the files or directories
451 # with spaces. 514 # with spaces.
452 515
453 INPUT = vamp vamp-sdk vamp-sdk/hostext examples host 516 INPUT = vamp \
454 517 vamp-sdk \
455 # If the value of the INPUT tag contains directories, you can use the 518 vamp-sdk/hostext \
456 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 519 examples \
457 # and *.h) to filter out the source-files in the directories. If left 520 host
458 # blank the following patterns are tested: 521
459 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 522 # This tag can be used to specify the character encoding of the source files
460 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm 523 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
524 # also the default input encoding. Doxygen uses libiconv (or the iconv built
525 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
526 # the list of possible encodings.
527
528 INPUT_ENCODING = UTF-8
529
530 # If the value of the INPUT tag contains directories, you can use the
531 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
532 # and *.h) to filter out the source-files in the directories. If left
533 # blank the following patterns are tested:
534 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
535 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
461 536
462 FILE_PATTERNS = *.h \ 537 FILE_PATTERNS = *.h \
463 *.C \ 538 *.C \
464 *.cpp \ 539 *.cpp \
465 *.cc \ 540 *.cc \
466 doc-overview 541 doc-overview
467 542
468 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 543 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
469 # should be searched for input files as well. Possible values are YES and NO. 544 # should be searched for input files as well. Possible values are YES and NO.
470 # If left blank NO is used. 545 # If left blank NO is used.
471 546
472 RECURSIVE = NO 547 RECURSIVE = NO
473 548
474 # The EXCLUDE tag can be used to specify files and/or directories that should 549 # The EXCLUDE tag can be used to specify files and/or directories that should
475 # excluded from the INPUT source files. This way you can easily exclude a 550 # excluded from the INPUT source files. This way you can easily exclude a
476 # subdirectory from a directory tree whose root is specified with the INPUT tag. 551 # subdirectory from a directory tree whose root is specified with the INPUT tag.
477 552
478 EXCLUDE = 553 EXCLUDE =
479 554
480 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 555 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
481 # directories that are symbolic links (a Unix filesystem feature) are excluded 556 # directories that are symbolic links (a Unix filesystem feature) are excluded
482 # from the input. 557 # from the input.
483 558
484 EXCLUDE_SYMLINKS = NO 559 EXCLUDE_SYMLINKS = NO
485 560
486 # If the value of the INPUT tag contains directories, you can use the 561 # If the value of the INPUT tag contains directories, you can use the
487 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 562 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
488 # certain files from those directories. Note that the wildcards are matched 563 # certain files from those directories. Note that the wildcards are matched
489 # against the file with absolute path, so to exclude all test directories 564 # against the file with absolute path, so to exclude all test directories
490 # for example use the pattern */test/* 565 # for example use the pattern */test/*
491 566
492 EXCLUDE_PATTERNS = qrc_*.cpp \ 567 EXCLUDE_PATTERNS = qrc_*.cpp \
493 moc_*.cpp \ 568 moc_*.cpp \
494 *.moc.cpp \ 569 *.moc.cpp \
495 *_skel.cpp 570 *_skel.cpp
496 571
497 # The EXAMPLE_PATH tag can be used to specify one or more files or 572 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
498 # directories that contain example code fragments that are included (see 573 # (namespaces, classes, functions, etc.) that should be excluded from the
574 # output. The symbol name can be a fully qualified name, a word, or if the
575 # wildcard * is used, a substring. Examples: ANamespace, AClass,
576 # AClass::ANamespace, ANamespace::*Test
577
578 EXCLUDE_SYMBOLS =
579
580 # The EXAMPLE_PATH tag can be used to specify one or more files or
581 # directories that contain example code fragments that are included (see
499 # the \include command). 582 # the \include command).
500 583
501 EXAMPLE_PATH = 584 EXAMPLE_PATH =
502 585
503 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 586 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
504 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 587 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
505 # and *.h) to filter out the source-files in the directories. If left 588 # and *.h) to filter out the source-files in the directories. If left
506 # blank all files are included. 589 # blank all files are included.
507 590
508 EXAMPLE_PATTERNS = 591 EXAMPLE_PATTERNS =
509 592
510 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 593 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
511 # searched for input files to be used with the \include or \dontinclude 594 # searched for input files to be used with the \include or \dontinclude
512 # commands irrespective of the value of the RECURSIVE tag. 595 # commands irrespective of the value of the RECURSIVE tag.
513 # Possible values are YES and NO. If left blank NO is used. 596 # Possible values are YES and NO. If left blank NO is used.
514 597
515 EXAMPLE_RECURSIVE = NO 598 EXAMPLE_RECURSIVE = NO
516 599
517 # The IMAGE_PATH tag can be used to specify one or more files or 600 # The IMAGE_PATH tag can be used to specify one or more files or
518 # directories that contain image that are included in the documentation (see 601 # directories that contain image that are included in the documentation (see
519 # the \image command). 602 # the \image command).
520 603
521 IMAGE_PATH = 604 IMAGE_PATH =
522 605
523 # The INPUT_FILTER tag can be used to specify a program that doxygen should 606 # The INPUT_FILTER tag can be used to specify a program that doxygen should
524 # invoke to filter for each input file. Doxygen will invoke the filter program 607 # invoke to filter for each input file. Doxygen will invoke the filter program
525 # by executing (via popen()) the command <filter> <input-file>, where <filter> 608 # by executing (via popen()) the command <filter> <input-file>, where <filter>
526 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 609 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
527 # input file. Doxygen will then use the output that the filter program writes 610 # input file. Doxygen will then use the output that the filter program writes
528 # to standard output. If FILTER_PATTERNS is specified, this tag will be 611 # to standard output. If FILTER_PATTERNS is specified, this tag will be
529 # ignored. 612 # ignored.
530 613
531 INPUT_FILTER = 614 INPUT_FILTER =
532 615
533 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 616 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
534 # basis. Doxygen will compare the file name with each pattern and apply the 617 # basis. Doxygen will compare the file name with each pattern and apply the
535 # filter if there is a match. The filters are a list of the form: 618 # filter if there is a match. The filters are a list of the form:
536 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 619 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
537 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 620 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
538 # is applied to all files. 621 # is applied to all files.
539 622
540 FILTER_PATTERNS = 623 FILTER_PATTERNS =
541 624
542 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 625 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
543 # INPUT_FILTER) will be used to filter the input files when producing source 626 # INPUT_FILTER) will be used to filter the input files when producing source
544 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 627 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
545 628
546 FILTER_SOURCE_FILES = NO 629 FILTER_SOURCE_FILES = NO
547 630
548 #--------------------------------------------------------------------------- 631 #---------------------------------------------------------------------------
549 # configuration options related to source browsing 632 # configuration options related to source browsing
550 #--------------------------------------------------------------------------- 633 #---------------------------------------------------------------------------
551 634
552 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 635 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
553 # be generated. Documented entities will be cross-referenced with these sources. 636 # be generated. Documented entities will be cross-referenced with these sources.
554 # Note: To get rid of all source code in the generated output, make sure also 637 # Note: To get rid of all source code in the generated output, make sure also
555 # VERBATIM_HEADERS is set to NO. 638 # VERBATIM_HEADERS is set to NO.
556 639
557 SOURCE_BROWSER = YES 640 SOURCE_BROWSER = YES
558 641
559 # Setting the INLINE_SOURCES tag to YES will include the body 642 # Setting the INLINE_SOURCES tag to YES will include the body
560 # of functions and classes directly in the documentation. 643 # of functions and classes directly in the documentation.
561 644
562 INLINE_SOURCES = NO 645 INLINE_SOURCES = NO
563 646
564 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 647 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
565 # doxygen to hide any special comment blocks from generated source code 648 # doxygen to hide any special comment blocks from generated source code
566 # fragments. Normal C and C++ comments will always remain visible. 649 # fragments. Normal C and C++ comments will always remain visible.
567 650
568 STRIP_CODE_COMMENTS = YES 651 STRIP_CODE_COMMENTS = YES
569 652
570 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 653 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
571 # then for each documented function all documented 654 # then for each documented function all documented
572 # functions referencing it will be listed. 655 # functions referencing it will be listed.
573 656
574 REFERENCED_BY_RELATION = YES 657 REFERENCED_BY_RELATION = YES
575 658
576 # If the REFERENCES_RELATION tag is set to YES (the default) 659 # If the REFERENCES_RELATION tag is set to YES (the default)
577 # then for each documented function all documented entities 660 # then for each documented function all documented entities
578 # called/used by that function will be listed. 661 # called/used by that function will be listed.
579 662
580 REFERENCES_RELATION = YES 663 REFERENCES_RELATION = YES
581 664
582 # If the USE_HTAGS tag is set to YES then the references to source code 665 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
583 # will point to the HTML generated by the htags(1) tool instead of doxygen 666 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
584 # built-in source browser. The htags tool is part of GNU's global source 667 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
585 # tagging system (see http://www.gnu.org/software/global/global.html). You 668 # link to the source code. Otherwise they will link to the documentstion.
669
670 REFERENCES_LINK_SOURCE = YES
671
672 # If the USE_HTAGS tag is set to YES then the references to source code
673 # will point to the HTML generated by the htags(1) tool instead of doxygen
674 # built-in source browser. The htags tool is part of GNU's global source
675 # tagging system (see http://www.gnu.org/software/global/global.html). You
586 # will need version 4.8.6 or higher. 676 # will need version 4.8.6 or higher.
587 677
588 #USE_HTAGS = NO 678 USE_HTAGS = NO
589 679
590 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 680 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
591 # will generate a verbatim copy of the header file for each class for 681 # will generate a verbatim copy of the header file for each class for
592 # which an include is specified. Set to NO to disable this. 682 # which an include is specified. Set to NO to disable this.
593 683
594 VERBATIM_HEADERS = YES 684 VERBATIM_HEADERS = YES
595 685
596 #--------------------------------------------------------------------------- 686 #---------------------------------------------------------------------------
597 # configuration options related to the alphabetical class index 687 # configuration options related to the alphabetical class index
598 #--------------------------------------------------------------------------- 688 #---------------------------------------------------------------------------
599 689
600 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 690 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
601 # of all compounds will be generated. Enable this if the project 691 # of all compounds will be generated. Enable this if the project
602 # contains a lot of classes, structs, unions or interfaces. 692 # contains a lot of classes, structs, unions or interfaces.
603 693
604 ALPHABETICAL_INDEX = NO 694 ALPHABETICAL_INDEX = NO
605 695
606 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 696 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
607 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 697 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
608 # in which this list will be split (can be a number in the range [1..20]) 698 # in which this list will be split (can be a number in the range [1..20])
609 699
610 COLS_IN_ALPHA_INDEX = 3 700 COLS_IN_ALPHA_INDEX = 3
611 701
612 # In case all classes in a project start with a common prefix, all 702 # In case all classes in a project start with a common prefix, all
613 # classes will be put under the same header in the alphabetical index. 703 # classes will be put under the same header in the alphabetical index.
614 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 704 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
615 # should be ignored while generating the index headers. 705 # should be ignored while generating the index headers.
616 706
617 IGNORE_PREFIX = 707 IGNORE_PREFIX =
618 708
619 #--------------------------------------------------------------------------- 709 #---------------------------------------------------------------------------
620 # configuration options related to the HTML output 710 # configuration options related to the HTML output
621 #--------------------------------------------------------------------------- 711 #---------------------------------------------------------------------------
622 712
623 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 713 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
624 # generate HTML output. 714 # generate HTML output.
625 715
626 GENERATE_HTML = YES 716 GENERATE_HTML = YES
627 717
628 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 718 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
629 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 719 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
630 # put in front of it. If left blank `html' will be used as the default path. 720 # put in front of it. If left blank `html' will be used as the default path.
631 721
632 HTML_OUTPUT = html 722 HTML_OUTPUT = html
633 723
634 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 724 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
635 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 725 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
636 # doxygen will generate files with .html extension. 726 # doxygen will generate files with .html extension.
637 727
638 HTML_FILE_EXTENSION = .html 728 HTML_FILE_EXTENSION = .html
639 729
640 # The HTML_HEADER tag can be used to specify a personal HTML header for 730 # The HTML_HEADER tag can be used to specify a personal HTML header for
641 # each generated HTML page. If it is left blank doxygen will generate a 731 # each generated HTML page. If it is left blank doxygen will generate a
642 # standard header. 732 # standard header.
643 733
644 HTML_HEADER = 734 HTML_HEADER =
645 735
646 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 736 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
647 # each generated HTML page. If it is left blank doxygen will generate a 737 # each generated HTML page. If it is left blank doxygen will generate a
648 # standard footer. 738 # standard footer.
649 739
650 HTML_FOOTER = 740 HTML_FOOTER =
651 741
652 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 742 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
653 # style sheet that is used by each HTML page. It can be used to 743 # style sheet that is used by each HTML page. It can be used to
654 # fine-tune the look of the HTML output. If the tag is left blank doxygen 744 # fine-tune the look of the HTML output. If the tag is left blank doxygen
655 # will generate a default style sheet. Note that doxygen will try to copy 745 # will generate a default style sheet. Note that doxygen will try to copy
656 # the style sheet file to the HTML output directory, so don't put your own 746 # the style sheet file to the HTML output directory, so don't put your own
657 # stylesheet in the HTML output directory as well, or it will be erased! 747 # stylesheet in the HTML output directory as well, or it will be erased!
658 748
659 HTML_STYLESHEET = 749 HTML_STYLESHEET =
660 750
661 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 751 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
662 # files or namespaces will be aligned in HTML using tables. If set to 752 # files or namespaces will be aligned in HTML using tables. If set to
663 # NO a bullet list will be used. 753 # NO a bullet list will be used.
664 754
665 HTML_ALIGN_MEMBERS = YES 755 HTML_ALIGN_MEMBERS = YES
666 756
667 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 757 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
668 # will be generated that can be used as input for tools like the 758 # will be generated that can be used as input for tools like the
669 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 759 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
670 # of the generated HTML documentation. 760 # of the generated HTML documentation.
671 761
672 GENERATE_HTMLHELP = NO 762 GENERATE_HTMLHELP = NO
673 763
674 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 764 # If the GENERATE_DOCSET tag is set to YES, additional index files
675 # be used to specify the file name of the resulting .chm file. You 765 # will be generated that can be used as input for Apple's Xcode 3
676 # can add a path in front of the file if the result should not be 766 # integrated development environment, introduced with OSX 10.5 (Leopard).
767 # To create a documentation set, doxygen will generate a Makefile in the
768 # HTML output directory. Running make will produce the docset in that
769 # directory and running "make install" will install the docset in
770 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
771 # it at startup.
772
773 GENERATE_DOCSET = NO
774
775 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
776 # feed. A documentation feed provides an umbrella under which multiple
777 # documentation sets from a single provider (such as a company or product suite)
778 # can be grouped.
779
780 DOCSET_FEEDNAME = "Doxygen generated docs"
781
782 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
783 # should uniquely identify the documentation set bundle. This should be a
784 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
785 # will append .docset to the name.
786
787 DOCSET_BUNDLE_ID = org.doxygen.Project
788
789 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
790 # documentation will contain sections that can be hidden and shown after the
791 # page has loaded. For this to work a browser that supports
792 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
793 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
794
795 HTML_DYNAMIC_SECTIONS = NO
796
797 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
798 # be used to specify the file name of the resulting .chm file. You
799 # can add a path in front of the file if the result should not be
677 # written to the html output directory. 800 # written to the html output directory.
678 801
679 CHM_FILE = 802 CHM_FILE =
680 803
681 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 804 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
682 # be used to specify the location (absolute path including file name) of 805 # be used to specify the location (absolute path including file name) of
683 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 806 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
684 # the HTML help compiler on the generated index.hhp. 807 # the HTML help compiler on the generated index.hhp.
685 808
686 HHC_LOCATION = 809 HHC_LOCATION =
687 810
688 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 811 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
689 # controls if a separate .chi index file is generated (YES) or that 812 # controls if a separate .chi index file is generated (YES) or that
690 # it should be included in the master .chm file (NO). 813 # it should be included in the master .chm file (NO).
691 814
692 GENERATE_CHI = NO 815 GENERATE_CHI = NO
693 816
694 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 817 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
695 # controls whether a binary table of contents is generated (YES) or a 818 # controls whether a binary table of contents is generated (YES) or a
696 # normal table of contents (NO) in the .chm file. 819 # normal table of contents (NO) in the .chm file.
697 820
698 BINARY_TOC = NO 821 BINARY_TOC = NO
699 822
700 # The TOC_EXPAND flag can be set to YES to add extra items for group members 823 # The TOC_EXPAND flag can be set to YES to add extra items for group members
701 # to the contents of the HTML help documentation and to the tree view. 824 # to the contents of the HTML help documentation and to the tree view.
702 825
703 TOC_EXPAND = NO 826 TOC_EXPAND = NO
704 827
705 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 828 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
706 # top of each HTML page. The value NO (the default) enables the index and 829 # top of each HTML page. The value NO (the default) enables the index and
707 # the value YES disables it. 830 # the value YES disables it.
708 831
709 DISABLE_INDEX = NO 832 DISABLE_INDEX = NO
710 833
711 # This tag can be used to set the number of enum values (range [1..20]) 834 # This tag can be used to set the number of enum values (range [1..20])
712 # that doxygen will group on one line in the generated HTML documentation. 835 # that doxygen will group on one line in the generated HTML documentation.
713 836
714 ENUM_VALUES_PER_LINE = 4 837 ENUM_VALUES_PER_LINE = 4
715 838
716 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 839 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
717 # generated containing a tree-like index structure (just like the one that 840 # generated containing a tree-like index structure (just like the one that
718 # is generated for HTML Help). For this to work a browser that supports 841 # is generated for HTML Help). For this to work a browser that supports
719 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 842 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
720 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 843 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
721 # probably better off using the HTML help feature. 844 # probably better off using the HTML help feature.
722 845
723 GENERATE_TREEVIEW = YES 846 GENERATE_TREEVIEW = YES
724 847
725 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 848 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
726 # used to set the initial width (in pixels) of the frame in which the tree 849 # used to set the initial width (in pixels) of the frame in which the tree
727 # is shown. 850 # is shown.
728 851
729 TREEVIEW_WIDTH = 250 852 TREEVIEW_WIDTH = 250
730 853
731 #--------------------------------------------------------------------------- 854 #---------------------------------------------------------------------------
732 # configuration options related to the LaTeX output 855 # configuration options related to the LaTeX output
733 #--------------------------------------------------------------------------- 856 #---------------------------------------------------------------------------
734 857
735 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 858 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
736 # generate Latex output. 859 # generate Latex output.
737 860
738 GENERATE_LATEX = NO 861 GENERATE_LATEX = NO
739 862
740 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 863 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
741 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 864 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
742 # put in front of it. If left blank `latex' will be used as the default path. 865 # put in front of it. If left blank `latex' will be used as the default path.
743 866
744 LATEX_OUTPUT = latex 867 LATEX_OUTPUT = latex
745 868
746 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 869 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
747 # invoked. If left blank `latex' will be used as the default command name. 870 # invoked. If left blank `latex' will be used as the default command name.
748 871
749 LATEX_CMD_NAME = latex 872 LATEX_CMD_NAME = latex
750 873
751 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 874 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
752 # generate index for LaTeX. If left blank `makeindex' will be used as the 875 # generate index for LaTeX. If left blank `makeindex' will be used as the
753 # default command name. 876 # default command name.
754 877
755 MAKEINDEX_CMD_NAME = makeindex 878 MAKEINDEX_CMD_NAME = makeindex
756 879
757 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 880 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
758 # LaTeX documents. This may be useful for small projects and may help to 881 # LaTeX documents. This may be useful for small projects and may help to
759 # save some trees in general. 882 # save some trees in general.
760 883
761 COMPACT_LATEX = NO 884 COMPACT_LATEX = NO
762 885
763 # The PAPER_TYPE tag can be used to set the paper type that is used 886 # The PAPER_TYPE tag can be used to set the paper type that is used
764 # by the printer. Possible values are: a4, a4wide, letter, legal and 887 # by the printer. Possible values are: a4, a4wide, letter, legal and
765 # executive. If left blank a4wide will be used. 888 # executive. If left blank a4wide will be used.
766 889
767 PAPER_TYPE = a4wide 890 PAPER_TYPE = a4wide
768 891
769 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 892 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
770 # packages that should be included in the LaTeX output. 893 # packages that should be included in the LaTeX output.
771 894
772 EXTRA_PACKAGES = 895 EXTRA_PACKAGES =
773 896
774 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 897 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
775 # the generated latex document. The header should contain everything until 898 # the generated latex document. The header should contain everything until
776 # the first chapter. If it is left blank doxygen will generate a 899 # the first chapter. If it is left blank doxygen will generate a
777 # standard header. Notice: only use this tag if you know what you are doing! 900 # standard header. Notice: only use this tag if you know what you are doing!
778 901
779 LATEX_HEADER = 902 LATEX_HEADER =
780 903
781 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 904 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
782 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 905 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
783 # contain links (just like the HTML output) instead of page references 906 # contain links (just like the HTML output) instead of page references
784 # This makes the output suitable for online browsing using a pdf viewer. 907 # This makes the output suitable for online browsing using a pdf viewer.
785 908
786 PDF_HYPERLINKS = NO 909 PDF_HYPERLINKS = NO
787 910
788 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 911 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
789 # plain latex in the generated Makefile. Set this option to YES to get a 912 # plain latex in the generated Makefile. Set this option to YES to get a
790 # higher quality PDF documentation. 913 # higher quality PDF documentation.
791 914
792 USE_PDFLATEX = NO 915 USE_PDFLATEX = NO
793 916
794 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 917 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
795 # command to the generated LaTeX files. This will instruct LaTeX to keep 918 # command to the generated LaTeX files. This will instruct LaTeX to keep
796 # running if errors occur, instead of asking the user for help. 919 # running if errors occur, instead of asking the user for help.
797 # This option is also used when generating formulas in HTML. 920 # This option is also used when generating formulas in HTML.
798 921
799 LATEX_BATCHMODE = NO 922 LATEX_BATCHMODE = NO
800 923
801 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 924 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
802 # include the index chapters (such as File Index, Compound Index, etc.) 925 # include the index chapters (such as File Index, Compound Index, etc.)
803 # in the output. 926 # in the output.
804 927
805 LATEX_HIDE_INDICES = NO 928 LATEX_HIDE_INDICES = NO
806 929
807 #--------------------------------------------------------------------------- 930 #---------------------------------------------------------------------------
808 # configuration options related to the RTF output 931 # configuration options related to the RTF output
809 #--------------------------------------------------------------------------- 932 #---------------------------------------------------------------------------
810 933
811 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 934 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
812 # The RTF output is optimized for Word 97 and may not look very pretty with 935 # The RTF output is optimized for Word 97 and may not look very pretty with
813 # other RTF readers or editors. 936 # other RTF readers or editors.
814 937
815 GENERATE_RTF = NO 938 GENERATE_RTF = NO
816 939
817 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 940 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
818 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 941 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
819 # put in front of it. If left blank `rtf' will be used as the default path. 942 # put in front of it. If left blank `rtf' will be used as the default path.
820 943
821 RTF_OUTPUT = rtf 944 RTF_OUTPUT = rtf
822 945
823 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 946 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
824 # RTF documents. This may be useful for small projects and may help to 947 # RTF documents. This may be useful for small projects and may help to
825 # save some trees in general. 948 # save some trees in general.
826 949
827 COMPACT_RTF = NO 950 COMPACT_RTF = NO
828 951
829 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 952 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
830 # will contain hyperlink fields. The RTF file will 953 # will contain hyperlink fields. The RTF file will
831 # contain links (just like the HTML output) instead of page references. 954 # contain links (just like the HTML output) instead of page references.
832 # This makes the output suitable for online browsing using WORD or other 955 # This makes the output suitable for online browsing using WORD or other
833 # programs which support those fields. 956 # programs which support those fields.
834 # Note: wordpad (write) and others do not support links. 957 # Note: wordpad (write) and others do not support links.
835 958
836 RTF_HYPERLINKS = NO 959 RTF_HYPERLINKS = NO
837 960
838 # Load stylesheet definitions from file. Syntax is similar to doxygen's 961 # Load stylesheet definitions from file. Syntax is similar to doxygen's
839 # config file, i.e. a series of assignments. You only have to provide 962 # config file, i.e. a series of assignments. You only have to provide
840 # replacements, missing definitions are set to their default value. 963 # replacements, missing definitions are set to their default value.
841 964
842 RTF_STYLESHEET_FILE = 965 RTF_STYLESHEET_FILE =
843 966
844 # Set optional variables used in the generation of an rtf document. 967 # Set optional variables used in the generation of an rtf document.
845 # Syntax is similar to doxygen's config file. 968 # Syntax is similar to doxygen's config file.
846 969
847 RTF_EXTENSIONS_FILE = 970 RTF_EXTENSIONS_FILE =
848 971
849 #--------------------------------------------------------------------------- 972 #---------------------------------------------------------------------------
850 # configuration options related to the man page output 973 # configuration options related to the man page output
851 #--------------------------------------------------------------------------- 974 #---------------------------------------------------------------------------
852 975
853 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 976 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
854 # generate man pages 977 # generate man pages
855 978
856 GENERATE_MAN = NO 979 GENERATE_MAN = NO
857 980
858 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 981 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
859 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 982 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
860 # put in front of it. If left blank `man' will be used as the default path. 983 # put in front of it. If left blank `man' will be used as the default path.
861 984
862 MAN_OUTPUT = man 985 MAN_OUTPUT = man
863 986
864 # The MAN_EXTENSION tag determines the extension that is added to 987 # The MAN_EXTENSION tag determines the extension that is added to
865 # the generated man pages (default is the subroutine's section .3) 988 # the generated man pages (default is the subroutine's section .3)
866 989
867 MAN_EXTENSION = .3 990 MAN_EXTENSION = .3
868 991
869 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 992 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
870 # then it will generate one additional man file for each entity 993 # then it will generate one additional man file for each entity
871 # documented in the real man page(s). These additional files 994 # documented in the real man page(s). These additional files
872 # only source the real man page, but without them the man command 995 # only source the real man page, but without them the man command
873 # would be unable to find the correct page. The default is NO. 996 # would be unable to find the correct page. The default is NO.
874 997
875 MAN_LINKS = NO 998 MAN_LINKS = NO
876 999
877 #--------------------------------------------------------------------------- 1000 #---------------------------------------------------------------------------
878 # configuration options related to the XML output 1001 # configuration options related to the XML output
879 #--------------------------------------------------------------------------- 1002 #---------------------------------------------------------------------------
880 1003
881 # If the GENERATE_XML tag is set to YES Doxygen will 1004 # If the GENERATE_XML tag is set to YES Doxygen will
882 # generate an XML file that captures the structure of 1005 # generate an XML file that captures the structure of
883 # the code including all documentation. 1006 # the code including all documentation.
884 1007
885 GENERATE_XML = NO 1008 GENERATE_XML = NO
886 1009
887 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1010 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
888 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1011 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
889 # put in front of it. If left blank `xml' will be used as the default path. 1012 # put in front of it. If left blank `xml' will be used as the default path.
890 1013
891 XML_OUTPUT = xml 1014 XML_OUTPUT = xml
892 1015
893 # The XML_SCHEMA tag can be used to specify an XML schema, 1016 # The XML_SCHEMA tag can be used to specify an XML schema,
894 # which can be used by a validating XML parser to check the 1017 # which can be used by a validating XML parser to check the
895 # syntax of the XML files. 1018 # syntax of the XML files.
896 1019
897 XML_SCHEMA = 1020 XML_SCHEMA =
898 1021
899 # The XML_DTD tag can be used to specify an XML DTD, 1022 # The XML_DTD tag can be used to specify an XML DTD,
900 # which can be used by a validating XML parser to check the 1023 # which can be used by a validating XML parser to check the
901 # syntax of the XML files. 1024 # syntax of the XML files.
902 1025
903 XML_DTD = 1026 XML_DTD =
904 1027
905 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1028 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
906 # dump the program listings (including syntax highlighting 1029 # dump the program listings (including syntax highlighting
907 # and cross-referencing information) to the XML output. Note that 1030 # and cross-referencing information) to the XML output. Note that
908 # enabling this will significantly increase the size of the XML output. 1031 # enabling this will significantly increase the size of the XML output.
909 1032
910 XML_PROGRAMLISTING = YES 1033 XML_PROGRAMLISTING = YES
911 1034
912 #--------------------------------------------------------------------------- 1035 #---------------------------------------------------------------------------
913 # configuration options for the AutoGen Definitions output 1036 # configuration options for the AutoGen Definitions output
914 #--------------------------------------------------------------------------- 1037 #---------------------------------------------------------------------------
915 1038
916 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1039 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
917 # generate an AutoGen Definitions (see autogen.sf.net) file 1040 # generate an AutoGen Definitions (see autogen.sf.net) file
918 # that captures the structure of the code including all 1041 # that captures the structure of the code including all
919 # documentation. Note that this feature is still experimental 1042 # documentation. Note that this feature is still experimental
920 # and incomplete at the moment. 1043 # and incomplete at the moment.
921 1044
922 GENERATE_AUTOGEN_DEF = NO 1045 GENERATE_AUTOGEN_DEF = NO
923 1046
924 #--------------------------------------------------------------------------- 1047 #---------------------------------------------------------------------------
925 # configuration options related to the Perl module output 1048 # configuration options related to the Perl module output
926 #--------------------------------------------------------------------------- 1049 #---------------------------------------------------------------------------
927 1050
928 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1051 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
929 # generate a Perl module file that captures the structure of 1052 # generate a Perl module file that captures the structure of
930 # the code including all documentation. Note that this 1053 # the code including all documentation. Note that this
931 # feature is still experimental and incomplete at the 1054 # feature is still experimental and incomplete at the
932 # moment. 1055 # moment.
933 1056
934 GENERATE_PERLMOD = NO 1057 GENERATE_PERLMOD = NO
935 1058
936 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1059 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
937 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1060 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
938 # to generate PDF and DVI output from the Perl module output. 1061 # to generate PDF and DVI output from the Perl module output.
939 1062
940 PERLMOD_LATEX = NO 1063 PERLMOD_LATEX = NO
941 1064
942 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1065 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
943 # nicely formatted so it can be parsed by a human reader. This is useful 1066 # nicely formatted so it can be parsed by a human reader. This is useful
944 # if you want to understand what is going on. On the other hand, if this 1067 # if you want to understand what is going on. On the other hand, if this
945 # tag is set to NO the size of the Perl module output will be much smaller 1068 # tag is set to NO the size of the Perl module output will be much smaller
946 # and Perl will parse it just the same. 1069 # and Perl will parse it just the same.
947 1070
948 PERLMOD_PRETTY = YES 1071 PERLMOD_PRETTY = YES
949 1072
950 # The names of the make variables in the generated doxyrules.make file 1073 # The names of the make variables in the generated doxyrules.make file
951 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1074 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
952 # This is useful so different doxyrules.make files included by the same 1075 # This is useful so different doxyrules.make files included by the same
953 # Makefile don't overwrite each other's variables. 1076 # Makefile don't overwrite each other's variables.
954 1077
955 PERLMOD_MAKEVAR_PREFIX = 1078 PERLMOD_MAKEVAR_PREFIX =
956 1079
957 #--------------------------------------------------------------------------- 1080 #---------------------------------------------------------------------------
958 # Configuration options related to the preprocessor 1081 # Configuration options related to the preprocessor
959 #--------------------------------------------------------------------------- 1082 #---------------------------------------------------------------------------
960 1083
961 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1084 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
962 # evaluate all C-preprocessor directives found in the sources and include 1085 # evaluate all C-preprocessor directives found in the sources and include
963 # files. 1086 # files.
964 1087
965 ENABLE_PREPROCESSING = YES 1088 ENABLE_PREPROCESSING = YES
966 1089
967 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1090 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
968 # names in the source code. If set to NO (the default) only conditional 1091 # names in the source code. If set to NO (the default) only conditional
969 # compilation will be performed. Macro expansion can be done in a controlled 1092 # compilation will be performed. Macro expansion can be done in a controlled
970 # way by setting EXPAND_ONLY_PREDEF to YES. 1093 # way by setting EXPAND_ONLY_PREDEF to YES.
971 1094
972 MACRO_EXPANSION = NO 1095 MACRO_EXPANSION = NO
973 1096
974 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1097 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
975 # then the macro expansion is limited to the macros specified with the 1098 # then the macro expansion is limited to the macros specified with the
976 # PREDEFINED and EXPAND_AS_PREDEFINED tags. 1099 # PREDEFINED and EXPAND_AS_DEFINED tags.
977 1100
978 EXPAND_ONLY_PREDEF = NO 1101 EXPAND_ONLY_PREDEF = NO
979 1102
980 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1103 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
981 # in the INCLUDE_PATH (see below) will be search if a #include is found. 1104 # in the INCLUDE_PATH (see below) will be search if a #include is found.
982 1105
983 SEARCH_INCLUDES = NO 1106 SEARCH_INCLUDES = NO
984 1107
985 # The INCLUDE_PATH tag can be used to specify one or more directories that 1108 # The INCLUDE_PATH tag can be used to specify one or more directories that
986 # contain include files that are not input files but should be processed by 1109 # contain include files that are not input files but should be processed by
987 # the preprocessor. 1110 # the preprocessor.
988 1111
989 INCLUDE_PATH = 1112 INCLUDE_PATH =
990 1113
991 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1114 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
992 # patterns (like *.h and *.hpp) to filter out the header-files in the 1115 # patterns (like *.h and *.hpp) to filter out the header-files in the
993 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1116 # directories. If left blank, the patterns specified with FILE_PATTERNS will
994 # be used. 1117 # be used.
995 1118
996 INCLUDE_FILE_PATTERNS = 1119 INCLUDE_FILE_PATTERNS =
997 1120
998 # The PREDEFINED tag can be used to specify one or more macro names that 1121 # The PREDEFINED tag can be used to specify one or more macro names that
999 # are defined before the preprocessor is started (similar to the -D option of 1122 # are defined before the preprocessor is started (similar to the -D option of
1000 # gcc). The argument of the tag is a list of macros of the form: name 1123 # gcc). The argument of the tag is a list of macros of the form: name
1001 # or name=definition (no spaces). If the definition and the = are 1124 # or name=definition (no spaces). If the definition and the = are
1002 # omitted =1 is assumed. To prevent a macro definition from being 1125 # omitted =1 is assumed. To prevent a macro definition from being
1003 # undefined via #undef or recursively expanded use the := operator 1126 # undefined via #undef or recursively expanded use the := operator
1004 # instead of the = operator. 1127 # instead of the = operator.
1005 1128
1006 PREDEFINED = HAVE_FFTW3F HAVE_FISHSOUND HAVE_JACK HAVE_LIBLO HAVE_LRDF HAVE_MAD HAVE_OGGZ HAVE_PORTAUDIO HAVE_SAMPLERATE HAVE_SNDFILE HAVE_VAMP 1129 PREDEFINED = HAVE_FFTW3F \
1007 1130 HAVE_FISHSOUND \
1008 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1131 HAVE_JACK \
1009 # this tag can be used to specify a list of macro names that should be expanded. 1132 HAVE_LIBLO \
1010 # The macro definition that is found in the sources will be used. 1133 HAVE_LRDF \
1134 HAVE_MAD \
1135 HAVE_OGGZ \
1136 HAVE_PORTAUDIO \
1137 HAVE_SAMPLERATE \
1138 HAVE_SNDFILE \
1139 HAVE_VAMP
1140
1141 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1142 # this tag can be used to specify a list of macro names that should be expanded.
1143 # The macro definition that is found in the sources will be used.
1011 # Use the PREDEFINED tag if you want to use a different macro definition. 1144 # Use the PREDEFINED tag if you want to use a different macro definition.
1012 1145
1013 EXPAND_AS_DEFINED = 1146 EXPAND_AS_DEFINED =
1014 1147
1015 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1148 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1016 # doxygen's preprocessor will remove all function-like macros that are alone 1149 # doxygen's preprocessor will remove all function-like macros that are alone
1017 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1150 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1018 # function macros are typically used for boiler-plate code, and will confuse 1151 # function macros are typically used for boiler-plate code, and will confuse
1019 # the parser if not removed. 1152 # the parser if not removed.
1020 1153
1021 SKIP_FUNCTION_MACROS = YES 1154 SKIP_FUNCTION_MACROS = YES
1022 1155
1023 #--------------------------------------------------------------------------- 1156 #---------------------------------------------------------------------------
1024 # Configuration::additions related to external references 1157 # Configuration::additions related to external references
1025 #--------------------------------------------------------------------------- 1158 #---------------------------------------------------------------------------
1026 1159
1027 # The TAGFILES option can be used to specify one or more tagfiles. 1160 # The TAGFILES option can be used to specify one or more tagfiles.
1028 # Optionally an initial location of the external documentation 1161 # Optionally an initial location of the external documentation
1029 # can be added for each tagfile. The format of a tag file without 1162 # can be added for each tagfile. The format of a tag file without
1030 # this location is as follows: 1163 # this location is as follows:
1031 # TAGFILES = file1 file2 ... 1164 # TAGFILES = file1 file2 ...
1032 # Adding location for the tag files is done as follows: 1165 # Adding location for the tag files is done as follows:
1033 # TAGFILES = file1=loc1 "file2 = loc2" ... 1166 # TAGFILES = file1=loc1 "file2 = loc2" ...
1034 # where "loc1" and "loc2" can be relative or absolute paths or 1167 # where "loc1" and "loc2" can be relative or absolute paths or
1035 # URLs. If a location is present for each tag, the installdox tool 1168 # URLs. If a location is present for each tag, the installdox tool
1036 # does not have to be run to correct the links. 1169 # does not have to be run to correct the links.
1037 # Note that each tag file must have a unique name 1170 # Note that each tag file must have a unique name
1038 # (where the name does NOT include the path) 1171 # (where the name does NOT include the path)
1039 # If a tag file is not located in the directory in which doxygen 1172 # If a tag file is not located in the directory in which doxygen
1040 # is run, you must also specify the path to the tagfile here. 1173 # is run, you must also specify the path to the tagfile here.
1041 1174
1042 TAGFILES = 1175 TAGFILES =
1043 1176
1044 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1177 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1045 # a tag file that is based on the input files it reads. 1178 # a tag file that is based on the input files it reads.
1046 1179
1047 GENERATE_TAGFILE = 1180 GENERATE_TAGFILE =
1048 1181
1049 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1182 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1050 # in the class index. If set to NO only the inherited external classes 1183 # in the class index. If set to NO only the inherited external classes
1051 # will be listed. 1184 # will be listed.
1052 1185
1053 ALLEXTERNALS = NO 1186 ALLEXTERNALS = NO
1054 1187
1055 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1188 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1056 # in the modules index. If set to NO, only the current project's groups will 1189 # in the modules index. If set to NO, only the current project's groups will
1057 # be listed. 1190 # be listed.
1058 1191
1059 EXTERNAL_GROUPS = YES 1192 EXTERNAL_GROUPS = YES
1060 1193
1061 # The PERL_PATH should be the absolute path and name of the perl script 1194 # The PERL_PATH should be the absolute path and name of the perl script
1062 # interpreter (i.e. the result of `which perl'). 1195 # interpreter (i.e. the result of `which perl').
1063 1196
1064 PERL_PATH = /usr/bin/perl 1197 PERL_PATH = /usr/bin/perl
1065 1198
1066 #--------------------------------------------------------------------------- 1199 #---------------------------------------------------------------------------
1067 # Configuration options related to the dot tool 1200 # Configuration options related to the dot tool
1068 #--------------------------------------------------------------------------- 1201 #---------------------------------------------------------------------------
1069 1202
1070 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1203 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1071 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1204 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1072 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1205 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1073 # this option is superseded by the HAVE_DOT option below. This is only a 1206 # this option is superseded by the HAVE_DOT option below. This is only a
1074 # fallback. It is recommended to install and use dot, since it yields more 1207 # fallback. It is recommended to install and use dot, since it yields more
1075 # powerful graphs. 1208 # powerful graphs.
1076 1209
1077 CLASS_DIAGRAMS = NO 1210 CLASS_DIAGRAMS = NO
1078 1211
1079 # If set to YES, the inheritance and collaboration graphs will hide 1212 # You can define message sequence charts within doxygen comments using the \msc
1080 # inheritance and usage relations if the target is undocumented 1213 # command. Doxygen will then run the mscgen tool (see
1214 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1215 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1216 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1217 # default search path.
1218
1219 MSCGEN_PATH =
1220
1221 # If set to YES, the inheritance and collaboration graphs will hide
1222 # inheritance and usage relations if the target is undocumented
1081 # or is not a class. 1223 # or is not a class.
1082 1224
1083 HIDE_UNDOC_RELATIONS = YES 1225 HIDE_UNDOC_RELATIONS = YES
1084 1226
1085 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1227 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1086 # available from the path. This tool is part of Graphviz, a graph visualization 1228 # available from the path. This tool is part of Graphviz, a graph visualization
1087 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1229 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1088 # have no effect if this option is set to NO (the default) 1230 # have no effect if this option is set to NO (the default)
1089 1231
1090 HAVE_DOT = YES 1232 HAVE_DOT = YES
1091 1233
1092 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1234 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1093 # will generate a graph for each documented class showing the direct and 1235 # will generate a graph for each documented class showing the direct and
1094 # indirect inheritance relations. Setting this tag to YES will force the 1236 # indirect inheritance relations. Setting this tag to YES will force the
1095 # the CLASS_DIAGRAMS tag to NO. 1237 # the CLASS_DIAGRAMS tag to NO.
1096 1238
1097 CLASS_GRAPH = YES 1239 CLASS_GRAPH = YES
1098 1240
1099 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1241 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1100 # will generate a graph for each documented class showing the direct and 1242 # will generate a graph for each documented class showing the direct and
1101 # indirect implementation dependencies (inheritance, containment, and 1243 # indirect implementation dependencies (inheritance, containment, and
1102 # class references variables) of the class with other documented classes. 1244 # class references variables) of the class with other documented classes.
1103 1245
1104 COLLABORATION_GRAPH = NO 1246 COLLABORATION_GRAPH = NO
1105 1247
1106 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1248 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1107 # will generate a graph for groups, showing the direct groups dependencies 1249 # will generate a graph for groups, showing the direct groups dependencies
1108 1250
1109 GROUP_GRAPHS = YES 1251 GROUP_GRAPHS = YES
1110 1252
1111 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1253 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1112 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1254 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1113 # Language. 1255 # Language.
1114 1256
1115 UML_LOOK = NO 1257 UML_LOOK = NO
1116 1258
1117 # If set to YES, the inheritance and collaboration graphs will show the 1259 # If set to YES, the inheritance and collaboration graphs will show the
1118 # relations between templates and their instances. 1260 # relations between templates and their instances.
1119 1261
1120 TEMPLATE_RELATIONS = NO 1262 TEMPLATE_RELATIONS = NO
1121 1263
1122 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1264 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1123 # tags are set to YES then doxygen will generate a graph for each documented 1265 # tags are set to YES then doxygen will generate a graph for each documented
1124 # file showing the direct and indirect include dependencies of the file with 1266 # file showing the direct and indirect include dependencies of the file with
1125 # other documented files. 1267 # other documented files.
1126 1268
1127 INCLUDE_GRAPH = YES 1269 INCLUDE_GRAPH = YES
1128 1270
1129 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1271 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1130 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1272 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1131 # documented header file showing the documented files that directly or 1273 # documented header file showing the documented files that directly or
1132 # indirectly include this file. 1274 # indirectly include this file.
1133 1275
1134 INCLUDED_BY_GRAPH = YES 1276 INCLUDED_BY_GRAPH = YES
1135 1277
1136 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1278 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1137 # generate a call dependency graph for every global function or class method. 1279 # doxygen will generate a call dependency graph for every global function
1138 # Note that enabling this option will significantly increase the time of a run. 1280 # or class method. Note that enabling this option will significantly increase
1139 # So in most cases it will be better to enable call graphs for selected 1281 # the time of a run. So in most cases it will be better to enable call graphs
1140 # functions only using the \callgraph command. 1282 # for selected functions only using the \callgraph command.
1141 1283
1142 CALL_GRAPH = NO 1284 CALL_GRAPH = NO
1143 1285
1144 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1286 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1287 # doxygen will generate a caller dependency graph for every global function
1288 # or class method. Note that enabling this option will significantly increase
1289 # the time of a run. So in most cases it will be better to enable caller
1290 # graphs for selected functions only using the \callergraph command.
1291
1292 CALLER_GRAPH = NO
1293
1294 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1145 # will graphical hierarchy of all classes instead of a textual one. 1295 # will graphical hierarchy of all classes instead of a textual one.
1146 1296
1147 GRAPHICAL_HIERARCHY = YES 1297 GRAPHICAL_HIERARCHY = YES
1148 1298
1149 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1299 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1150 # then doxygen will show the dependencies a directory has on other directories 1300 # then doxygen will show the dependencies a directory has on other directories
1151 # in a graphical way. The dependency relations are determined by the #include 1301 # in a graphical way. The dependency relations are determined by the #include
1152 # relations between the files in the directories. 1302 # relations between the files in the directories.
1153 1303
1154 DIRECTORY_GRAPH = YES 1304 DIRECTORY_GRAPH = YES
1155 1305
1156 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1306 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1157 # generated by dot. Possible values are png, jpg, or gif 1307 # generated by dot. Possible values are png, jpg, or gif
1158 # If left blank png will be used. 1308 # If left blank png will be used.
1159 1309
1160 DOT_IMAGE_FORMAT = png 1310 DOT_IMAGE_FORMAT = png
1161 1311
1162 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1312 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1163 # found. If left blank, it is assumed the dot tool can be found in the path. 1313 # found. If left blank, it is assumed the dot tool can be found in the path.
1164 1314
1165 DOT_PATH = 1315 DOT_PATH =
1166 1316
1167 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1317 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1168 # contain dot files that are included in the documentation (see the 1318 # contain dot files that are included in the documentation (see the
1169 # \dotfile command). 1319 # \dotfile command).
1170 1320
1171 DOTFILE_DIRS = 1321 DOTFILE_DIRS =
1172 1322
1173 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1323 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1174 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1324 # nodes that will be shown in the graph. If the number of nodes in a graph
1175 # this value, doxygen will try to truncate the graph, so that it fits within 1325 # becomes larger than this value, doxygen will truncate the graph, which is
1176 # the specified constraint. Beware that most browsers cannot cope with very 1326 # visualized by representing a node as a red box. Note that doxygen if the
1177 # large images. 1327 # number of direct children of the root node in a graph is already larger than
1178 1328 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1179 MAX_DOT_GRAPH_WIDTH = 1024 1329 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1180 1330
1181 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1331 DOT_GRAPH_MAX_NODES = 50
1182 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1332
1183 # this value, doxygen will try to truncate the graph, so that it fits within 1333 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1184 # the specified constraint. Beware that most browsers cannot cope with very 1334 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1185 # large images. 1335 # from the root by following a path via at most 3 edges will be shown. Nodes
1186 1336 # that lay further from the root node will be omitted. Note that setting this
1187 MAX_DOT_GRAPH_HEIGHT = 1024 1337 # option to 1 or 2 may greatly reduce the computation time needed for large
1188 1338 # code bases. Also note that the size of a graph can be further restricted by
1189 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1339 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1190 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1191 # from the root by following a path via at most 3 edges will be shown. Nodes
1192 # that lay further from the root node will be omitted. Note that setting this
1193 # option to 1 or 2 may greatly reduce the computation time needed for large
1194 # code bases. Also note that a graph may be further truncated if the graph's
1195 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1196 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1197 # the graph is not depth-constrained.
1198 1340
1199 MAX_DOT_GRAPH_DEPTH = 0 1341 MAX_DOT_GRAPH_DEPTH = 0
1200 1342
1201 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1343 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1202 # background. This is disabled by default, which results in a white background. 1344 # background. This is enabled by default, which results in a transparent
1203 # Warning: Depending on the platform used, enabling this option may lead to 1345 # background. Warning: Depending on the platform used, enabling this option
1204 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1346 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1205 # read). 1347 # become hard to read).
1206 1348
1207 DOT_TRANSPARENT = NO 1349 DOT_TRANSPARENT = NO
1208 1350
1209 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1351 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1210 # files in one run (i.e. multiple -o and -T options on the command line). This 1352 # files in one run (i.e. multiple -o and -T options on the command line). This
1211 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1353 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1212 # support this, this feature is disabled by default. 1354 # support this, this feature is disabled by default.
1213 1355
1214 DOT_MULTI_TARGETS = YES 1356 DOT_MULTI_TARGETS = YES
1215 1357
1216 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1358 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1217 # generate a legend page explaining the meaning of the various boxes and 1359 # generate a legend page explaining the meaning of the various boxes and
1218 # arrows in the dot generated graphs. 1360 # arrows in the dot generated graphs.
1219 1361
1220 GENERATE_LEGEND = YES 1362 GENERATE_LEGEND = YES
1221 1363
1222 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1364 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1223 # remove the intermediate dot files that are used to generate 1365 # remove the intermediate dot files that are used to generate
1224 # the various graphs. 1366 # the various graphs.
1225 1367
1226 DOT_CLEANUP = YES 1368 DOT_CLEANUP = YES
1227 1369
1228 #--------------------------------------------------------------------------- 1370 #---------------------------------------------------------------------------
1229 # Configuration::additions related to the search engine 1371 # Configuration::additions related to the search engine
1230 #--------------------------------------------------------------------------- 1372 #---------------------------------------------------------------------------
1231 1373
1232 # The SEARCHENGINE tag specifies whether or not a search engine should be 1374 # The SEARCHENGINE tag specifies whether or not a search engine should be
1233 # used. If set to NO the values of all tags below this one will be ignored. 1375 # used. If set to NO the values of all tags below this one will be ignored.
1234 1376
1235 SEARCHENGINE = NO 1377 SEARCHENGINE = NO