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