2 <group name='Project' docs='Project related configuration options'>
3 <option type='string' id='DOXYFILE_ENCODING' format='string' docs='
4 This tag specifies the encoding used for all characters in the config file
5 that follow. The default is UTF-8 which is also the encoding used for all
6 text before the first occurrence of this tag. Doxygen uses libiconv (or the
7 iconv built into libc) for the transcoding. See
8 http://www.gnu.org/software/libiconv for the list of possible encodings.
10 <option type='string' id='PROJECT_NAME' format='string' docs='
11 The PROJECT_NAME tag is a single word (or sequence of words) that should
12 identify the project. Note that if you do not use Doxywizard you need
13 to put quotes around the project name if it contains spaces.' defval='My Project'/>
14 <option type='string' id='PROJECT_NUMBER' format='string' docs='
15 The PROJECT_NUMBER tag can be used to enter a project or revision number.
16 This could be handy for archiving the generated documentation or
17 if some version control system is used.
19 <option type='string' id='PROJECT_BRIEF' format='string' docs='
20 Using the PROJECT_BRIEF tag one can provide an optional one line description
21 for a project that appears at the top of each page and should give viewer
22 a quick idea about the purpose of the project. Keep the description short.
24 <option type='string' id='PROJECT_LOGO' format='file' docs='
25 With the PROJECT_LOGO tag one can specify an logo or icon that is
26 included in the documentation. The maximum height of the logo should not
27 exceed 55 pixels and the maximum width should not exceed 200 pixels.
28 Doxygen will copy the logo to the output directory.
30 <option type='string' id='OUTPUT_DIRECTORY' format='dir' docs='
31 The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
32 base path where the generated documentation will be put.
33 If a relative path is entered, it will be relative to the location
34 where doxygen was started. If left blank the current directory will be used.
36 <option type='bool' id='CREATE_SUBDIRS' docs='
37 If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
38 4096 sub-directories (in 2 levels) under the output directory of each output
39 format and will distribute the generated files over these directories.
40 Enabling this option can be useful when feeding doxygen a huge amount of
41 source files, where putting all generated files in the same directory would
42 otherwise cause performance problems for the file system.
44 <option type='enum' id='OUTPUT_LANGUAGE' defval='English' docs='
45 The OUTPUT_LANGUAGE tag is used to specify the language in which all
46 documentation generated by doxygen is written. Doxygen will use this
47 information to generate all constant output in the proper language.
48 The default language is English, other supported languages are:
49 Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
50 Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
51 Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
52 messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
53 Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
54 Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
56 <value name='Afrikaans'/>
57 <value name='Arabic'/>
58 <value name='Brazilian'/>
59 <value name='Catalan'/>
60 <value name='Chinese'/>
61 <value name='Chinese-Traditional'/>
62 <value name='Croatian'/>
64 <value name='Danish'/>
66 <value name='English'/>
67 <value name='Esperanto'/>
69 <value name='Finnish'/>
70 <value name='French'/>
71 <value name='German'/>
73 <value name='Hungarian'/>
74 <value name='Italian'/>
75 <value name='Japanese'/>
76 <value name='Japanese-en'/>
77 <value name='Korean'/>
78 <value name='Korean-en'/>
79 <value name='Norwegian'/>
80 <value name='Macedonian'/>
81 <value name='Persian'/>
82 <value name='Polish'/>
83 <value name='Portuguese'/>
84 <value name='Romanian'/>
85 <value name='Russian'/>
86 <value name='Serbian'/>
87 <value name='Slovak'/>
88 <value name='Slovene'/>
89 <value name='Spanish'/>
90 <value name='Swedish'/>
91 <value name='Turkish'/>
92 <value name='Ukrainian'/>
93 <value name='Vietnamese'/>
95 <option type='bool' id='BRIEF_MEMBER_DESC' docs='
96 If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
97 include brief member descriptions after the members that are listed in
98 the file and class documentation (similar to JavaDoc).
99 Set to NO to disable this.
101 <option type='bool' id='REPEAT_BRIEF' docs='
102 If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
103 the brief description of a member or function before the detailed description.
104 Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
105 brief descriptions will be completely suppressed.
107 <option type='list' id='ABBREVIATE_BRIEF' format='string' docs='
108 This tag implements a quasi-intelligent brief description abbreviator
109 that is used to form the text in various listings. Each string
110 in this list, if found as the leading text of the brief description, will be
111 stripped from the text and the result after processing the whole list, is
112 used as the annotated text. Otherwise, the brief description is used as-is.
113 If left blank, the following values are used ("$name" is automatically
114 replaced with the name of the entity): "The $name class" "The $name widget"
115 "The $name file" "is" "provides" "specifies" "contains"
116 "represents" "a" "an" "the"
118 <value name='The $name class'/>
119 <value name='The $name widget'/>
120 <value name='The $name file'/>
122 <value name='provides'/>
123 <value name='specifies'/>
124 <value name='contains'/>
125 <value name='represents'/>
130 <option type='bool' id='ALWAYS_DETAILED_SEC' docs='
131 If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
132 Doxygen will generate a detailed section even if there is only a brief
135 <option type='bool' id='INLINE_INHERITED_MEMB' docs='
136 If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
137 inherited members of a class in the documentation of that class as if those
138 members were ordinary class members. Constructors, destructors and assignment
139 operators of the base classes will not be shown.
141 <option type='bool' id='FULL_PATH_NAMES' docs='
142 If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
143 path before files name in the file list and in the header files. If set
144 to NO the shortest path that makes the file name unique will be used.
146 <option type='list' id='STRIP_FROM_PATH' format='string' docs='
147 If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
148 can be used to strip a user-defined part of the path. Stripping is
149 only done if one of the specified strings matches the left-hand part of
150 the path. The tag can be used to show relative paths in the file list.
151 If left blank the directory from which doxygen is run is used as the
152 path to strip. Note that you specify absolute paths here, but also
153 relative paths, which will be relative from the directory where doxygen is
154 started.' depends='FULL_PATH_NAMES'>
157 <option type='list' id='STRIP_FROM_INC_PATH' format='string' docs='
158 The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
159 the path mentioned in the documentation of a class, which tells
160 the reader which header file to include in order to use a class.
161 If left blank only the name of the header file containing the class
162 definition is used. Otherwise one should specify the include paths that
163 are normally passed to the compiler using the -I flag.
166 <option type='bool' id='SHORT_NAMES' docs='
167 If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
168 (but less readable) file names. This can be useful if your file system
169 doesn't support long names like on DOS, Mac, or CD-ROM.
171 <option type='bool' id='JAVADOC_AUTOBRIEF' docs='
172 If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
173 will interpret the first line (until the first dot) of a JavaDoc-style
174 comment as the brief description. If set to NO, the JavaDoc
175 comments will behave just like regular Qt-style comments
176 (thus requiring an explicit @brief command for a brief description.)
178 <option type='bool' id='QT_AUTOBRIEF' docs='
179 If the QT_AUTOBRIEF tag is set to YES then Doxygen will
180 interpret the first line (until the first dot) of a Qt-style
181 comment as the brief description. If set to NO, the comments
182 will behave just like regular Qt-style comments (thus requiring
183 an explicit \brief command for a brief description.)
185 <option type='bool' id='MULTILINE_CPP_IS_BRIEF' docs='
186 The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
187 treat a multi-line C++ special comment block (i.e. a block of //! or ///
188 comments) as a brief description. This used to be the default behaviour.
189 The new default is to treat a multi-line C++ comment block as a detailed
190 description. Set this tag to YES if you prefer the old behaviour instead.
192 <option type='bool' id='INHERIT_DOCS' docs='
193 If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
194 member inherits the documentation from any documented member that it
197 <option type='bool' id='SEPARATE_MEMBER_PAGES' docs='
198 If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
199 a new page for each member. If set to NO, the documentation of a member will
200 be part of the file/class/namespace that contains it.
202 <option type='int' id='TAB_SIZE' docs='
203 The TAB_SIZE tag can be used to set the number of spaces in a tab.
204 Doxygen uses this value to replace tabs by spaces in code fragments.
205 ' minval='1' maxval='16' defval='4'/>
206 <option type='list' id='ALIASES' format='string' docs='
207 This tag can be used to specify a number of aliases that acts
208 as commands in the documentation. An alias has the form "name=value".
209 For example adding "sideeffect=\par Side Effects:\n" will allow you to
210 put the command \sideeffect (or @sideeffect) in the documentation, which
211 will result in a user-defined paragraph with heading "Side Effects:".
212 You can put \n's in the value part of an alias to insert newlines.
214 <option type='list' id='TCL_SUBST' format='string' docs='
215 This tag can be used to specify a number of word-keyword mappings (TCL only).
216 A mapping has the form "name=value". For example adding
217 "class=itcl::class" will allow you to use the command class in the
220 <option type='bool' id='OPTIMIZE_OUTPUT_FOR_C' docs='
221 Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
222 sources only. Doxygen will then generate output that is more tailored for C.
223 For instance, some of the names that are used will be different. The list
224 of all members will be omitted, etc.
226 <option type='bool' id='OPTIMIZE_OUTPUT_JAVA' docs='
227 Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
228 sources only. Doxygen will then generate output that is more tailored for
229 Java. For instance, namespaces will be presented as packages, qualified
230 scopes will look different, etc.
232 <option type='bool' id='OPTIMIZE_FOR_FORTRAN' docs='
233 Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
234 sources only. Doxygen will then generate output that is more tailored for
237 <option type='bool' id='OPTIMIZE_OUTPUT_VHDL' docs='
238 Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
239 sources. Doxygen will then generate output that is tailored for
242 <option type='list' id='EXTENSION_MAPPING' format='string' docs='
243 Doxygen selects the parser to use depending on the extension of the files it
244 parses. With this tag you can assign which parser to use for a given
245 extension. Doxygen has a built-in mapping, but you can override or extend it
246 using this tag. The format is ext=language, where ext is a file extension,
247 and language is one of the parsers supported by doxygen: IDL, Java,
248 Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
249 C++. For instance to make doxygen treat .inc files as Fortran files (default
250 is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
251 that for custom extensions you also need to set FILE_PATTERNS otherwise the
252 files are not read by doxygen.
255 <option type='bool' id='MARKDOWN_SUPPORT' docs='
256 If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
257 comments according to the Markdown format, which allows for more readable
258 documentation. See http://daringfireball.net/projects/markdown/ for details.
259 The output of markdown processing is further processed by doxygen, so you
260 can mix doxygen, HTML, and XML commands with Markdown formatting.
261 Disable only in case of backward compatibilities issues.
263 <option type='bool' id='AUTOLINK_SUPPORT' docs='
264 When enabled doxygen tries to link words that correspond to documented classes,
265 or namespaces to their corresponding documentation. Such a link can be
266 prevented in individual cases by by putting a % sign in front of the word or
267 globally by setting AUTOLINK_SUPPORT to NO.
269 <option type='bool' id='BUILTIN_STL_SUPPORT' docs='
270 If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
271 to include (a tag file for) the STL sources as input, then you should
272 set this tag to YES in order to let doxygen match functions declarations and
273 definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
274 func(std::string) {}). This also makes the inheritance and collaboration
275 diagrams that involve STL classes more complete and accurate.
277 <option type='bool' id='CPP_CLI_SUPPORT' docs='
278 If you use Microsoft's C++/CLI language, you should set this option to YES to
279 enable parsing support.
281 <option type='bool' id='SIP_SUPPORT' docs='
282 Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
283 Doxygen will parse them like normal C++ but will assume all classes use public
284 instead of private inheritance when no explicit protection keyword is present.
286 <option type='bool' id='IDL_PROPERTY_SUPPORT' docs='
287 For Microsoft's IDL there are propget and propput attributes to indicate
288 getter and setter methods for a property. Setting this option to YES (the
289 default) will make doxygen replace the get and set methods by a property in
290 the documentation. This will only work if the methods are indeed getting or
291 setting a simple type. If this is not the case, or you want to show the
292 methods anyway, you should set this option to NO.
294 <option type='bool' id='DISTRIBUTE_GROUP_DOC' docs='
295 If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
296 tag is set to YES, then doxygen will reuse the documentation of the first
297 member in the group (if any) for the other members of the group. By default
298 all members of a group must be documented explicitly.
300 <option type='bool' id='SUBGROUPING' docs='
301 Set the SUBGROUPING tag to YES (the default) to allow class member groups of
302 the same type (for instance a group of public functions) to be put as a
303 subgroup of that type (e.g. under the Public Functions section). Set it to
304 NO to prevent subgrouping. Alternatively, this can be done per class using
305 the \nosubgrouping command.
307 <option type='bool' id='INLINE_GROUPED_CLASSES' docs='
308 When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
309 unions are shown inside the group in which they are included (e.g. using
310 @ingroup) instead of on a separate page (for HTML and Man pages) or
311 section (for LaTeX and RTF).
313 <option type='bool' id='INLINE_SIMPLE_STRUCTS' docs='
314 When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
315 unions with only public data fields will be shown inline in the documentation
316 of the scope in which they are defined (i.e. file, namespace, or group
317 documentation), provided this scope is documented. If set to NO (the default),
318 structs, classes, and unions are shown on a separate page (for HTML and Man
319 pages) or section (for LaTeX and RTF).' defval='0'/>
320 <option type='bool' id='TYPEDEF_HIDES_STRUCT' docs='
321 When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
322 is documented as struct, union, or enum with the name of the typedef. So
323 typedef struct TypeS {} TypeT, will appear in the documentation as a struct
324 with name TypeT. When disabled the typedef will appear as a member of a file,
325 namespace, or class. And the struct will be named TypeS. This can typically
326 be useful for C code in case the coding convention dictates that all compound
327 types are typedef'ed and only the typedef is referenced, never the tag name.
329 <option type='int' id='SYMBOL_CACHE_SIZE' docs='
330 The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
331 determine which symbols to keep in memory and which to flush to disk.
332 When the cache is full, less often used symbols will be written to disk.
333 For small to medium size projects (<1000 input files) the default value is
334 probably good enough. For larger projects a too small cache size can cause
335 doxygen to be busy swapping symbols to and from disk most of the time
336 causing a significant performance penalty.
337 If the system has enough physical memory increasing the cache will improve the
338 performance by keeping more symbols in memory. Note that the value works on
339 a logarithmic scale so increasing the size by one will roughly double the
340 memory usage. The cache size is given by this formula:
341 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
342 corresponding to a cache size of 2^16 = 65536 symbols.
343 ' minval='0' maxval='9' defval='0'/>
344 <option type='int' id='LOOKUP_CACHE_SIZE' docs='
345 Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
346 set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
347 their name and scope. Since this can be an expensive process and often the
348 same symbol appear multiple times in the code, doxygen keeps a cache of
349 pre-resolved symbols. If the cache is too small doxygen will become slower.
350 If the cache is too large, memory is wasted. The cache size is given by this
351 formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
352 corresponding to a cache size of 2^16 = 65536 symbols.
353 ' minval='0' maxval='9' defval='0'/>
355 <group name='Build' docs='Build related configuration options'>
356 <option type='bool' id='EXTRACT_ALL' docs='
357 If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
358 documentation are documented, even if no documentation was available.
359 Private class members and static file members will be hidden unless
360 the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
362 <option type='bool' id='EXTRACT_PRIVATE' docs='
363 If the EXTRACT_PRIVATE tag is set to YES all private members of a class
364 will be included in the documentation.
366 <option type='bool' id='EXTRACT_PACKAGE' docs='
367 If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
368 scope will be included in the documentation.
370 <option type='bool' id='EXTRACT_STATIC' docs='
371 If the EXTRACT_STATIC tag is set to YES all static members of a file
372 will be included in the documentation.
374 <option type='bool' id='EXTRACT_LOCAL_CLASSES' docs='
375 If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
376 defined locally in source files will be included in the documentation.
377 If set to NO only classes defined in header files are included.
379 <option type='bool' id='EXTRACT_LOCAL_METHODS' docs='
380 This flag is only useful for Objective-C code. When set to YES local
381 methods, which are defined in the implementation section but not in
382 the interface are included in the documentation.
383 If set to NO (the default) only methods in the interface are included.
385 <option type='bool' id='EXTRACT_ANON_NSPACES' docs='
386 If this flag is set to YES, the members of anonymous namespaces will be
387 extracted and appear in the documentation as a namespace called
388 'anonymous_namespace{file}', where file will be replaced with the base
389 name of the file that contains the anonymous namespace. By default
390 anonymous namespaces are hidden.
392 <option type='bool' id='HIDE_UNDOC_MEMBERS' docs='
393 If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
394 undocumented members of documented classes, files or namespaces.
395 If set to NO (the default) these members will be included in the
396 various overviews, but no documentation section is generated.
397 This option has no effect if EXTRACT_ALL is enabled.
399 <option type='bool' id='HIDE_UNDOC_CLASSES' docs='
400 If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
401 undocumented classes that are normally visible in the class hierarchy.
402 If set to NO (the default) these classes will be included in the various
403 overviews. This option has no effect if EXTRACT_ALL is enabled.
405 <option type='bool' id='HIDE_FRIEND_COMPOUNDS' docs='
406 If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
407 friend (class|struct|union) declarations.
408 If set to NO (the default) these declarations will be included in the
411 <option type='bool' id='HIDE_IN_BODY_DOCS' docs='
412 If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
413 documentation blocks found inside the body of a function.
414 If set to NO (the default) these blocks will be appended to the
415 function's detailed documentation block.
417 <option type='bool' id='INTERNAL_DOCS' docs='
418 The INTERNAL_DOCS tag determines if documentation
419 that is typed after a \internal command is included. If the tag is set
420 to NO (the default) then the documentation will be excluded.
421 Set it to YES to include the internal documentation.
423 <option type='bool' id='CASE_SENSE_NAMES' docs='
424 If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
425 file names in lower-case letters. If set to YES upper-case letters are also
426 allowed. This is useful if you have classes or files whose names only differ
427 in case and if your file system supports case sensitive file names. Windows
428 and Mac users are advised to set this option to NO.
429 ' defval='0' altdefval='portable_fileSystemIsCaseSensitive()'/>
430 <option type='bool' id='HIDE_SCOPE_NAMES' docs='
431 If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
432 will show members with their full class and namespace scopes in the
433 documentation. If set to YES the scope will be hidden.
435 <option type='bool' id='SHOW_INCLUDE_FILES' docs='
436 If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
437 will put a list of the files that are included by a file in the documentation
440 <option type='bool' id='FORCE_LOCAL_INCLUDES' docs='
441 If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
442 will list include files with double quotes in the documentation
443 rather than with sharp brackets.
445 <option type='bool' id='INLINE_INFO' docs='
446 If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
447 is inserted in the documentation for inline members.
449 <option type='bool' id='SORT_MEMBER_DOCS' docs='
450 If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
451 will sort the (detailed) documentation of file and class members
452 alphabetically by member name. If set to NO the members will appear in
455 <option type='bool' id='SORT_BRIEF_DOCS' docs='
456 If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
457 brief documentation of file, namespace and class members alphabetically
458 by member name. If set to NO (the default) the members will appear in
461 <option type='bool' id='SORT_MEMBERS_CTORS_1ST' docs='
462 If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
463 will sort the (brief and detailed) documentation of class members so that
464 constructors and destructors are listed first. If set to NO (the default)
465 the constructors will appear in the respective orders defined by
466 SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
467 This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
468 and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.' defval='0'/>
469 <option type='bool' id='SORT_GROUP_NAMES' docs='
470 If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
471 hierarchy of group names into alphabetical order. If set to NO (the default)
472 the group names will appear in their defined order.
474 <option type='bool' id='SORT_BY_SCOPE_NAME' docs='
475 If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
476 sorted by fully-qualified names, including namespaces. If set to
477 NO (the default), the class list will be sorted only by class name,
478 not including the namespace part.
479 Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
480 Note: This option applies only to the class list, not to the
483 <option type='bool' id='STRICT_PROTO_MATCHING' docs='
484 If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
485 do proper type resolution of all parameters of a function it will reject a
486 match between the prototype and the implementation of a member function even
487 if there is only one candidate or it is obvious which candidate to choose
488 by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
489 will still accept a match between prototype and implementation in such cases.
491 <option type='bool' id='GENERATE_TODOLIST' docs='
492 The GENERATE_TODOLIST tag can be used to enable (YES) or
493 disable (NO) the todo list. This list is created by putting \todo
494 commands in the documentation.
496 <option type='bool' id='GENERATE_TESTLIST' docs='
497 The GENERATE_TESTLIST tag can be used to enable (YES) or
498 disable (NO) the test list. This list is created by putting \test
499 commands in the documentation.
501 <option type='bool' id='GENERATE_BUGLIST' docs='
502 The GENERATE_BUGLIST tag can be used to enable (YES) or
503 disable (NO) the bug list. This list is created by putting \bug
504 commands in the documentation.
506 <option type='bool' id='GENERATE_DEPRECATEDLIST' docs='
507 The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
508 disable (NO) the deprecated list. This list is created by putting
509 \deprecated commands in the documentation.
511 <option type='list' id='ENABLED_SECTIONS' format='string' docs='
512 The ENABLED_SECTIONS tag can be used to enable conditional
513 documentation sections, marked by \if sectionname ... \endif.
516 <option type='int' id='MAX_INITIALIZER_LINES' docs='
517 The MAX_INITIALIZER_LINES tag determines the maximum number of lines
518 the initial value of a variable or macro consists of for it to appear in
519 the documentation. If the initializer consists of more lines than specified
520 here it will be hidden. Use a value of 0 to hide initializers completely.
521 The appearance of the initializer of individual variables and macros in the
522 documentation can be controlled using \showinitializer or \hideinitializer
523 command in the documentation regardless of this setting.
524 ' minval='0' maxval='10000' defval='30'/>
525 <option type='bool' id='SHOW_USED_FILES' docs='
526 Set the SHOW_USED_FILES tag to NO to disable the list of files generated
527 at the bottom of the documentation of classes and structs. If set to YES the
528 list will mention the files that were used to generate the documentation.
530 <option type='bool' id='SHOW_FILES' docs='
531 Set the SHOW_FILES tag to NO to disable the generation of the Files page.
532 This will remove the Files entry from the Quick Index and from the
533 Folder Tree View (if specified). The default is YES.
535 <option type='bool' id='SHOW_NAMESPACES' docs='
536 Set the SHOW_NAMESPACES tag to NO to disable the generation of the
537 Namespaces page. This will remove the Namespaces entry from the Quick Index
538 and from the Folder Tree View (if specified). The default is YES.
540 <option type='string' id='FILE_VERSION_FILTER' format='file' docs='
541 The FILE_VERSION_FILTER tag can be used to specify a program or script that
542 doxygen should invoke to get the current version for each file (typically from
543 the version control system). Doxygen will invoke the program by executing (via
544 popen()) the command <command> <input-file>, where <command> is the value of
545 the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
546 provided by doxygen. Whatever the program writes to standard output
547 is used as the file version. See the manual for examples.
549 <option type='string' id='LAYOUT_FILE' format='file' docs='
550 The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
551 by doxygen. The layout file controls the global structure of the generated
552 output files in an output format independent way. To create the layout file
553 that represents doxygen's defaults, run doxygen with the -l option.
554 You can optionally specify a file name after the option, if omitted
555 DoxygenLayout.xml will be used as the name of the layout file.
557 <option type='list' id='CITE_BIB_FILES' format='file' docs='
558 The CITE_BIB_FILES tag can be used to specify one or more bib files
559 containing the references data. This must be a list of .bib files. The
560 .bib extension is automatically appended if omitted. Using this command
561 requires the bibtex tool to be installed. See also
562 http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
563 of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
564 feature you need bibtex and perl available in the search path.
567 <group name='Messages' docs='configuration options related to warning and progress messages'>
568 <option type='bool' id='QUIET' docs='
569 The QUIET tag can be used to turn on/off the messages that are generated
570 by doxygen. Possible values are YES and NO. If left blank NO is used.
572 <option type='bool' id='WARNINGS' docs='
573 The WARNINGS tag can be used to turn on/off the warning messages that are
574 generated by doxygen. Possible values are YES and NO. If left blank
577 <option type='bool' id='WARN_IF_UNDOCUMENTED' docs='
578 If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
579 for undocumented members. If EXTRACT_ALL is set to YES then this flag will
580 automatically be disabled.
582 <option type='bool' id='WARN_IF_DOC_ERROR' docs='
583 If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
584 potential errors in the documentation, such as not documenting some
585 parameters in a documented function, or documenting parameters that
586 don't exist or using markup commands wrongly.
588 <option type='bool' id='WARN_NO_PARAMDOC' docs='
589 The WARN_NO_PARAMDOC option can be enabled to get warnings for
590 functions that are documented, but have no documentation for their parameters
591 or return value. If set to NO (the default) doxygen will only warn about
592 wrong or incomplete parameter documentation, but not about the absence of
595 <option type='string' id='WARN_FORMAT' format='string' docs='
596 The WARN_FORMAT tag determines the format of the warning messages that
597 doxygen can produce. The string should contain the $file, $line, and $text
598 tags, which will be replaced by the file and line number from which the
599 warning originated and the warning text. Optionally the format may contain
600 $version, which will be replaced by the version of the file (if it could
601 be obtained via FILE_VERSION_FILTER)
602 ' defval='$file:$line: $text'/>
603 <option type='string' id='WARN_LOGFILE' format='file' docs='
604 The WARN_LOGFILE tag can be used to specify a file to which warning
605 and error messages should be written. If left blank the output is written
609 <group name='Input' docs='configuration options related to the input files'>
610 <option type='list' id='INPUT' format='filedir' docs='
611 The INPUT tag can be used to specify the files and/or directories that contain
612 documented source files. You may enter file names like "myfile.cpp" or
613 directories like "/usr/src/myproject". Separate the files or directories
618 <option type='string' id='INPUT_ENCODING' format='string' docs='
619 This tag can be used to specify the character encoding of the source files
620 that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
621 also the default input encoding. Doxygen uses libiconv (or the iconv built
622 into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
623 the list of possible encodings.
625 <option type='list' id='FILE_PATTERNS' format='string' docs='
626 If the value of the INPUT tag contains directories, you can use the
627 FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
628 and *.h) to filter out the source-files in the directories. If left
629 blank the following patterns are tested:
630 *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
631 *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
632 *.f90 *.f *.for *.vhd *.vhdl
636 <value name='*.cxx'/>
637 <value name='*.cpp'/>
638 <value name='*.c++'/>
640 <value name='*.java'/>
642 <value name='*.ixx'/>
643 <value name='*.ipp'/>
644 <value name='*.i++'/>
645 <value name='*.inl'/>
648 <value name='*.hxx'/>
649 <value name='*.hpp'/>
650 <value name='*.h++'/>
651 <value name='*.idl'/>
652 <value name='*.odl'/>
654 <value name='*.php'/>
655 <value name='*.php3'/>
656 <value name='*.inc'/>
658 <value name='*.markdown'/>
661 <value name='*.dox'/>
663 <value name='*.f90'/>
665 <value name='*.for'/>
666 <value name='*.vhd'/>
667 <value name='*.vhdl'/>
669 <option type='bool' id='RECURSIVE' docs='
670 The RECURSIVE tag can be used to turn specify whether or not subdirectories
671 should be searched for input files as well. Possible values are YES and NO.
672 If left blank NO is used.
674 <option type='list' id='EXCLUDE' format='filedir' docs='
675 The EXCLUDE tag can be used to specify files and/or directories that should be
676 excluded from the INPUT source files. This way you can easily exclude a
677 subdirectory from a directory tree whose root is specified with the INPUT tag.
678 Note that relative paths are relative to the directory from which doxygen is
682 <option type='bool' id='EXCLUDE_SYMLINKS' docs='
683 The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
684 directories that are symbolic links (a Unix file system feature) are excluded
687 <option type='list' id='EXCLUDE_PATTERNS' format='string' docs='
688 If the value of the INPUT tag contains directories, you can use the
689 EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
690 certain files from those directories. Note that the wildcards are matched
691 against the file with absolute path, so to exclude all test directories
692 for example use the pattern */test/*
695 <option type='list' id='EXCLUDE_SYMBOLS' format='string' docs='
696 The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
697 (namespaces, classes, functions, etc.) that should be excluded from the
698 output. The symbol name can be a fully qualified name, a word, or if the
699 wildcard * is used, a substring. Examples: ANamespace, AClass,
700 AClass::ANamespace, ANamespace::*Test
703 <option type='list' id='EXAMPLE_PATH' format='dir' docs='
704 The EXAMPLE_PATH tag can be used to specify one or more files or
705 directories that contain example code fragments that are included (see
706 the \include command).
709 <option type='list' id='EXAMPLE_PATTERNS' format='string' docs='
710 If the value of the EXAMPLE_PATH tag contains directories, you can use the
711 EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
712 and *.h) to filter out the source-files in the directories. If left
713 blank all files are included.
717 <option type='bool' id='EXAMPLE_RECURSIVE' docs='
718 If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
719 searched for input files to be used with the \include or \dontinclude
720 commands irrespective of the value of the RECURSIVE tag.
721 Possible values are YES and NO. If left blank NO is used.
723 <option type='list' id='IMAGE_PATH' format='dir' docs='
724 The IMAGE_PATH tag can be used to specify one or more files or
725 directories that contain image that are included in the documentation (see
729 <option type='string' id='INPUT_FILTER' format='file' docs='
730 The INPUT_FILTER tag can be used to specify a program that doxygen should
731 invoke to filter for each input file. Doxygen will invoke the filter program
732 by executing (via popen()) the command <filter> <input-file>, where <filter>
733 is the value of the INPUT_FILTER tag, and <input-file> is the name of an
734 input file. Doxygen will then use the output that the filter program writes
735 to standard output. If FILTER_PATTERNS is specified, this tag will be
738 <option type='list' id='FILTER_PATTERNS' format='string' docs='
739 The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
740 basis. Doxygen will compare the file name with each pattern and apply the
741 filter if there is a match. The filters are a list of the form:
742 pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
743 info on how filters are used. If FILTER_PATTERNS is empty or if
744 non of the patterns match the file name, INPUT_FILTER is applied.
747 <option type='bool' id='FILTER_SOURCE_FILES' docs='
748 If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
749 INPUT_FILTER) will be used to filter the input files when producing source
750 files to browse (i.e. when SOURCE_BROWSER is set to YES).
752 <option type='list' id='FILTER_SOURCE_PATTERNS' format='string' docs='
753 The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
754 pattern. A pattern will override the setting for FILTER_PATTERN (if any)
755 and it is also possible to disable source filtering for a specific pattern
756 using *.ext= (so without naming a filter). This option only has effect when
757 FILTER_SOURCE_FILES is enabled.
758 ' depends='FILTER_SOURCE_FILES'/>
760 <group name='Source Browser' docs='configuration options related to source browsing'>
761 <option type='bool' id='SOURCE_BROWSER' docs='
762 If the SOURCE_BROWSER tag is set to YES then a list of source files will
763 be generated. Documented entities will be cross-referenced with these sources.
764 Note: To get rid of all source code in the generated output, make sure also
765 VERBATIM_HEADERS is set to NO.
767 <option type='bool' id='INLINE_SOURCES' docs='
768 Setting the INLINE_SOURCES tag to YES will include the body
769 of functions and classes directly in the documentation.
771 <option type='bool' id='STRIP_CODE_COMMENTS' docs='
772 Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
773 doxygen to hide any special comment blocks from generated source code
774 fragments. Normal C, C++ and Fortran comments will always remain visible.
776 <option type='bool' id='REFERENCED_BY_RELATION' docs='
777 If the REFERENCED_BY_RELATION tag is set to YES
778 then for each documented function all documented
779 functions referencing it will be listed.
781 <option type='bool' id='REFERENCES_RELATION' docs='
782 If the REFERENCES_RELATION tag is set to YES
783 then for each documented function all documented entities
784 called/used by that function will be listed.
786 <option type='bool' id='REFERENCES_LINK_SOURCE' docs='
787 If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
788 and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
789 functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
790 link to the source code. Otherwise they will link to the documentation.
792 <option type='bool' id='USE_HTAGS' docs='
793 If the USE_HTAGS tag is set to YES then the references to source code
794 will point to the HTML generated by the htags(1) tool instead of doxygen
795 built-in source browser. The htags tool is part of GNU's global source
796 tagging system (see http://www.gnu.org/software/global/global.html). You
797 will need version 4.8.6 or higher.
798 ' defval='0' depends='SOURCE_BROWSER'/>
799 <option type='bool' id='VERBATIM_HEADERS' docs='
800 If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
801 will generate a verbatim copy of the header file for each class for
802 which an include is specified. Set to NO to disable this.
805 <group name='Index' docs='configuration options related to the alphabetical class index'>
806 <option type='bool' id='ALPHABETICAL_INDEX' docs='
807 If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
808 of all compounds will be generated. Enable this if the project
809 contains a lot of classes, structs, unions or interfaces.
811 <option type='int' id='COLS_IN_ALPHA_INDEX' docs='
812 If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
813 the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
814 in which this list will be split (can be a number in the range [1..20])
815 ' minval='1' maxval='20' defval='5'/>
816 <option type='list' id='IGNORE_PREFIX' format='string' docs='
817 In case all classes in a project start with a common prefix, all
818 classes will be put under the same header in the alphabetical index.
819 The IGNORE_PREFIX tag can be used to specify one or more prefixes that
820 should be ignored while generating the index headers.
824 <group name='HTML' docs='configuration options related to the HTML output'>
825 <option type='bool' id='GENERATE_HTML' docs='
826 If the GENERATE_HTML tag is set to YES (the default) Doxygen will
827 generate HTML output.
829 <option type='string' id='HTML_OUTPUT' format='dir' docs='
830 The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
831 If a relative path is entered the value of OUTPUT_DIRECTORY will be
832 put in front of it. If left blank `html' will be used as the default path.
833 ' defval='html' depends='GENERATE_HTML'/>
834 <option type='string' id='HTML_FILE_EXTENSION' format='string' docs='
835 The HTML_FILE_EXTENSION tag can be used to specify the file extension for
836 each generated HTML page (for example: .htm,.php,.asp). If it is left blank
837 doxygen will generate files with .html extension.
838 ' defval='.html' depends='GENERATE_HTML'/>
839 <option type='string' id='HTML_HEADER' format='file' docs='
840 The HTML_HEADER tag can be used to specify a personal HTML header for
841 each generated HTML page. If it is left blank doxygen will generate a
842 standard header. Note that when using a custom header you are responsible
843 for the proper inclusion of any scripts and style sheets that doxygen
844 needs, which is dependent on the configuration options used.
845 It is advised to generate a default header using "doxygen -w html
846 header.html footer.html stylesheet.css YourConfigFile" and then modify
847 that header. Note that the header is subject to change so you typically
848 have to redo this when upgrading to a newer version of doxygen or when
849 changing the value of configuration settings such as GENERATE_TREEVIEW!
850 ' defval='' depends='GENERATE_HTML'/>
851 <option type='string' id='HTML_FOOTER' format='file' docs='
852 The HTML_FOOTER tag can be used to specify a personal HTML footer for
853 each generated HTML page. If it is left blank doxygen will generate a
855 ' defval='' depends='GENERATE_HTML'/>
856 <option type='string' id='HTML_STYLESHEET' format='file' docs='
857 The HTML_STYLESHEET tag can be used to specify a user-defined cascading
858 style sheet that is used by each HTML page. It can be used to
859 fine-tune the look of the HTML output. If left blank doxygen will
860 generate a default style sheet. Note that it is recommended to use
861 HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
862 tag will in the future become obsolete.
863 ' defval='' depends='GENERATE_HTML'/>
864 <option type='string' id='HTML_EXTRA_STYLESHEET' format='file' docs='
865 The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
866 user-defined cascading style sheet that is included after the standard
867 style sheets created by doxygen. Using this option one can overrule
868 certain style aspects. This is preferred over using HTML_STYLESHEET
869 since it does not replace the standard style sheet and is therefor more
870 robust against future updates. Doxygen will copy the style sheet file to
871 the output directory.
872 ' defval='' depends='GENERATE_HTML'/>
873 <option type='list' id='HTML_EXTRA_FILES' format='file' docs='
874 The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
875 other source files which should be copied to the HTML output directory. Note
876 that these files will be copied to the base HTML output directory. Use the
877 $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
878 files. In the HTML_STYLESHEET file, use the file name only. Also note that
879 the files will be copied as-is; there are no commands or markers available.
880 ' depends='GENERATE_HTML'/>
881 <option type='int' id='HTML_COLORSTYLE_HUE' docs='
882 The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
883 Doxygen will adjust the colors in the style sheet and background images
884 according to this color. Hue is specified as an angle on a colorwheel,
885 see http://en.wikipedia.org/wiki/Hue for more information.
886 For instance the value 0 represents red, 60 is yellow, 120 is green,
887 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
888 The allowed range is 0 to 359.
889 ' minval='0' maxval='359' defval='220' depends='GENERATE_HTML'/>
890 <option type='int' id='HTML_COLORSTYLE_SAT' docs='
891 The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
892 the colors in the HTML output. For a value of 0 the output will use
893 grayscales only. A value of 255 will produce the most vivid colors.
894 ' minval='0' maxval='255' defval='100' depends='GENERATE_HTML'/>
895 <option type='int' id='HTML_COLORSTYLE_GAMMA' docs='
896 The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
897 the luminance component of the colors in the HTML output. Values below
898 100 gradually make the output lighter, whereas values above 100 make
899 the output darker. The value divided by 100 is the actual gamma applied,
900 so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
901 and 100 does not change the gamma.
902 ' minval='40' maxval='240' defval='80'/>
903 <option type='bool' id='HTML_TIMESTAMP' docs='
904 If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
905 page will contain the date and time when the page was generated. Setting
906 this to NO can help when comparing the output of multiple runs.
907 ' defval='1' depends='GENERATE_HTML'/>
908 <option type='bool' id='HTML_DYNAMIC_SECTIONS' docs='
909 If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
910 documentation will contain sections that can be hidden and shown after the
912 ' defval='0' depends='GENERATE_HTML'/>
913 <option type='int' id='HTML_INDEX_NUM_ENTRIES' docs='
914 With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
915 entries shown in the various tree structured indices initially; the user
916 can expand and collapse entries dynamically later on. Doxygen will expand
917 the tree to such a level that at most the specified number of entries are
918 visible (unless a fully collapsed tree already exceeds this amount).
919 So setting the number of entries 1 will produce a full collapsed tree by
920 default. 0 is a special value representing an infinite number of entries
921 and will result in a full expanded tree by default.
922 ' minval='0' maxval='9999' defval='100'/>
923 <option type='bool' id='GENERATE_DOCSET' docs='
924 If the GENERATE_DOCSET tag is set to YES, additional index files
925 will be generated that can be used as input for Apple's Xcode 3
926 integrated development environment, introduced with OSX 10.5 (Leopard).
927 To create a documentation set, doxygen will generate a Makefile in the
928 HTML output directory. Running make will produce the docset in that
929 directory and running "make install" will install the docset in
930 ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
932 See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
933 for more information.
934 ' defval='0' depends='GENERATE_HTML'/>
935 <option type='string' id='DOCSET_FEEDNAME' format='string' docs='
936 When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
937 feed. A documentation feed provides an umbrella under which multiple
938 documentation sets from a single provider (such as a company or product suite)
940 ' defval='Doxygen generated docs' depends='GENERATE_DOCSET'/>
941 <option type='string' id='DOCSET_BUNDLE_ID' format='string' docs='
942 When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
943 should uniquely identify the documentation set bundle. This should be a
944 reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
945 will append .docset to the name.
946 ' defval='org.doxygen.Project' depends='GENERATE_DOCSET'/>
947 <option type='string' id='DOCSET_PUBLISHER_ID' format='string' docs='
948 When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
949 identify the documentation publisher. This should be a reverse domain-name
950 style string, e.g. com.mycompany.MyDocSet.documentation.
951 ' defval='org.doxygen.Publisher' depends='GENERATE_DOCSET'/>
952 <option type='string' id='DOCSET_PUBLISHER_NAME' format='string' docs='
953 The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
954 ' defval='Publisher' depends='GENERATE_DOCSET'/>
955 <option type='bool' id='GENERATE_HTMLHELP' docs='
956 If the GENERATE_HTMLHELP tag is set to YES, additional index files
957 will be generated that can be used as input for tools like the
958 Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
959 of the generated HTML documentation.
960 ' defval='0' depends='GENERATE_HTML'/>
961 <option type='string' id='CHM_FILE' format='file' docs='
962 If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
963 be used to specify the file name of the resulting .chm file. You
964 can add a path in front of the file if the result should not be
965 written to the html output directory.
966 ' defval='' depends='GENERATE_HTMLHELP'/>
967 <option type='string' id='HHC_LOCATION' format='file' docs='
968 If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
969 be used to specify the location (absolute path including file name) of
970 the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
971 the HTML help compiler on the generated index.hhp.
972 ' defval='' depends='GENERATE_HTMLHELP' abspath='1'/>
973 <option type='bool' id='GENERATE_CHI' docs='
974 If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
975 controls if a separate .chi index file is generated (YES) or that
976 it should be included in the master .chm file (NO).
977 ' defval='0' depends='GENERATE_HTMLHELP'/>
978 <option type='string' id='CHM_INDEX_ENCODING' format='string' docs='
979 If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
980 is used to encode HtmlHelp index (hhk), content (hhc) and project file
982 ' defval='' depends='GENERATE_HTMLHELP'/>
983 <option type='bool' id='BINARY_TOC' docs='
984 If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
985 controls whether a binary table of contents is generated (YES) or a
986 normal table of contents (NO) in the .chm file.
987 ' defval='0' depends='GENERATE_HTMLHELP'/>
988 <option type='bool' id='TOC_EXPAND' docs='
989 The TOC_EXPAND flag can be set to YES to add extra items for group members
990 to the contents of the HTML help documentation and to the tree view.
991 ' defval='0' depends='GENERATE_HTMLHELP'/>
992 <option type='bool' id='GENERATE_QHP' docs='
993 If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
994 QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
995 that can be used as input for Qt's qhelpgenerator to generate a
996 Qt Compressed Help (.qch) of the generated HTML documentation.
997 ' defval='0' depends='GENERATE_HTML'/>
998 <option type='string' id='QCH_FILE' format='file' docs='
999 If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1000 be used to specify the file name of the resulting .qch file.
1001 The path specified is relative to the HTML output folder.
1002 ' defval='' depends='GENERATE_QHP'/>
1003 <option type='string' id='QHP_NAMESPACE' format='string' docs='
1004 The QHP_NAMESPACE tag specifies the namespace to use when generating
1005 Qt Help Project output. For more information please see
1006 http://doc.trolltech.com/qthelpproject.html#namespace
1007 ' defval='org.doxygen.Project' depends='GENERATE_QHP'/>
1008 <option type='string' id='QHP_VIRTUAL_FOLDER' format='string' docs='
1009 The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1010 Qt Help Project output. For more information please see
1011 http://doc.trolltech.com/qthelpproject.html#virtual-folders
1012 ' defval='doc' depends='GENERATE_QHP'/>
1013 <option type='string' id='QHP_CUST_FILTER_NAME' format='string' docs='
1014 If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1015 add. For more information please see
1016 http://doc.trolltech.com/qthelpproject.html#custom-filters
1017 ' defval='' depends='GENERATE_QHP'/>
1018 <option type='string' id='QHP_CUST_FILTER_ATTRS' format='string' docs='
1019 The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1020 custom filter to add. For more information please see
1021 <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1022 Qt Help Project / Custom Filters</a>.
1023 ' defval='' depends='GENERATE_QHP'/>
1024 <option type='string' id='QHP_SECT_FILTER_ATTRS' format='string' docs='
1025 The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1027 filter section matches.
1028 <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1029 Qt Help Project / Filter Attributes</a>.
1030 ' defval='' depends='GENERATE_QHP'/>
1031 <option type='string' id='QHG_LOCATION' format='file' docs='
1032 If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1033 be used to specify the location of Qt's qhelpgenerator.
1034 If non-empty doxygen will try to run qhelpgenerator on the generated
1036 ' defval='' depends='GENERATE_QHP'/>
1037 <option type='bool' id='GENERATE_ECLIPSEHELP' docs='
1038 If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1039 will be generated, which together with the HTML files, form an Eclipse help
1040 plugin. To install this plugin and make it available under the help contents
1041 menu in Eclipse, the contents of the directory containing the HTML and XML
1042 files needs to be copied into the plugins directory of eclipse. The name of
1043 the directory within the plugins directory should be the same as
1044 the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1046 ' defval='0' depends='GENERATE_HTML'/>
1047 <option type='string' id='ECLIPSE_DOC_ID' docs='
1048 A unique identifier for the eclipse help plugin. When installing the plugin
1049 the directory name containing the HTML and XML files should also have
1051 ' defval='org.doxygen.Project' depends='GENERATE_ECLIPSEHELP'/>
1052 <option type='bool' id='DISABLE_INDEX' docs='
1053 The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1054 at top of each HTML page. The value NO (the default) enables the index and
1055 the value YES disables it. Since the tabs have the same information as the
1056 navigation tree you can set this option to NO if you already set
1057 GENERATE_TREEVIEW to YES.
1058 ' defval='0' depends='GENERATE_HTML'/>
1059 <option type='bool' id='GENERATE_TREEVIEW' defval='0' docs='
1060 The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1061 structure should be generated to display hierarchical information.
1062 If the tag value is set to YES, a side panel will be generated
1063 containing a tree-like index structure (just like the one that
1064 is generated for HTML Help). For this to work a browser that supports
1065 JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1066 Windows users are probably better off using the HTML help feature.
1067 Since the tree basically has the same information as the tab index you
1068 could consider to set DISABLE_INDEX to NO when enabling this option.
1069 ' depends='GENERATE_HTML'/>
1070 <option type='int' id='ENUM_VALUES_PER_LINE' docs='
1071 The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1072 (range [0,1..20]) that doxygen will group on one line in the generated HTML
1073 documentation. Note that a value of 0 will completely suppress the enum
1074 values from appearing in the overview section.
1075 ' minval='0' maxval='20' defval='4' depends='GENERATE_HTML'/>
1076 <option type='int' id='TREEVIEW_WIDTH' docs='
1077 If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1078 used to set the initial width (in pixels) of the frame in which the tree
1080 ' minval='0' maxval='1500' defval='250' depends='GENERATE_HTML'/>
1081 <option type='bool' id='EXT_LINKS_IN_WINDOW' defval='0' docs='
1082 When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1083 links to external symbols imported via tag files in a separate window.
1084 ' depends='GENERATE_HTML'/>
1085 <option type='int' id='FORMULA_FONTSIZE' docs='
1086 Use this tag to change the font size of Latex formulas included
1087 as images in the HTML documentation. The default is 10. Note that
1088 when you change the font size after a successful doxygen run you need
1089 to manually remove any form_*.png images from the HTML output directory
1090 to force them to be regenerated.
1091 ' minval='8' maxval='50' defval='10' depends='GENERATE_HTML'/>
1092 <option type='bool' id='FORMULA_TRANSPARENT' docs='
1093 Use the FORMULA_TRANPARENT tag to determine whether or not the images
1094 generated for formulas are transparent PNGs. Transparent PNGs are
1095 not supported properly for IE 6.0, but are supported on all modern browsers.
1096 Note that when changing this option you need to delete any form_*.png files
1097 in the HTML output before the changes have effect.
1098 ' defval='1' depends='GENERATE_HTML'/>
1099 <option type='bool' id='USE_MATHJAX' docs='
1100 Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1101 (see http://www.mathjax.org) which uses client side Javascript for the
1102 rendering instead of using prerendered bitmaps. Use this if you do not
1103 have LaTeX installed or if you want to formulas look prettier in the HTML
1104 output. When enabled you may also need to install MathJax separately and
1105 configure the path to it using the MATHJAX_RELPATH option.
1107 <option type='string' id='MATHJAX_RELPATH' docs='
1108 When MathJax is enabled you need to specify the location relative to the
1109 HTML output directory using the MATHJAX_RELPATH option. The destination
1110 directory should contain the MathJax.js script. For instance, if the mathjax
1111 directory is located at the same level as the HTML output directory, then
1112 MATHJAX_RELPATH should be ../mathjax. The default value points to
1113 the MathJax Content Delivery Network so you can quickly see the result without
1114 installing MathJax. However, it is strongly recommended to install a local
1115 copy of MathJax from http://www.mathjax.org before deployment.
1116 ' defval='http://cdn.mathjax.org/mathjax/latest'/>
1117 <option type='list' id='MATHJAX_EXTENSIONS' format='string' docs='
1118 The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1119 names that should be enabled during MathJax rendering.
1120 ' depends='USE_MATHJAX'>
1122 <option type='bool' id='SEARCHENGINE' docs='
1123 When the SEARCHENGINE tag is enabled doxygen will generate a search box
1124 for the HTML output. The underlying search engine uses javascript
1125 and DHTML and should work on any modern browser. Note that when using
1126 HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1127 (GENERATE_DOCSET) there is already a search function so this one should
1128 typically be disabled. For large projects the javascript based search engine
1129 can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1130 ' defval='1' depends='GENERATE_HTML'/>
1131 <option type='bool' id='SERVER_BASED_SEARCH' docs='
1132 When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1133 implemented using a PHP enabled web server instead of at the web client
1134 using Javascript. Doxygen will generate the search PHP script and index
1135 file to put on the web server. The advantage of the server
1136 based approach is that it scales better to large projects and allows
1137 full text search. The disadvantages are that it is more difficult to setup
1138 and does not have live searching capabilities.
1139 ' defval='0' depends='SEARCHENGINE'/>
1141 <group name='LaTeX' docs='configuration options related to the LaTeX output'>
1142 <option type='bool' id='GENERATE_LATEX' docs='
1143 If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1144 generate Latex output.
1146 <option type='string' id='LATEX_OUTPUT' format='dir' docs='
1147 The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1148 If a relative path is entered the value of OUTPUT_DIRECTORY will be
1149 put in front of it. If left blank `latex' will be used as the default path.
1150 ' defval='latex' depends='GENERATE_LATEX'/>
1151 <option type='string' id='LATEX_CMD_NAME' format='file' docs='
1152 The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1153 invoked. If left blank `latex' will be used as the default command name.
1154 Note that when enabling USE_PDFLATEX this option is only used for
1155 generating bitmaps for formulas in the HTML output, but not in the
1156 Makefile that is written to the output directory.
1157 ' defval='latex' depends='GENERATE_LATEX'/>
1158 <option type='string' id='MAKEINDEX_CMD_NAME' format='file' docs='
1159 The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1160 generate index for LaTeX. If left blank `makeindex' will be used as the
1161 default command name.
1162 ' defval='makeindex' depends='GENERATE_LATEX'/>
1163 <option type='bool' id='COMPACT_LATEX' docs='
1164 If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1165 LaTeX documents. This may be useful for small projects and may help to
1166 save some trees in general.
1167 ' defval='0' depends='GENERATE_LATEX'/>
1168 <option type='enum' id='PAPER_TYPE' defval='a4' docs='
1169 The PAPER_TYPE tag can be used to set the paper type that is used
1170 by the printer. Possible values are: a4, letter, legal and
1171 executive. If left blank a4wide will be used.
1172 ' depends='GENERATE_LATEX'>
1174 <value name='a4wide'/>
1175 <value name='letter'/>
1176 <value name='legal'/>
1177 <value name='executive'/>
1179 <option type='list' id='EXTRA_PACKAGES' format='string' docs='
1180 The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1181 packages that should be included in the LaTeX output.
1182 ' depends='GENERATE_LATEX'>
1184 <option type='string' id='LATEX_HEADER' format='file' docs='
1185 The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1186 the generated latex document. The header should contain everything until
1187 the first chapter. If it is left blank doxygen will generate a
1188 standard header. Notice: only use this tag if you know what you are doing!
1189 ' defval='' depends='GENERATE_LATEX'/>
1190 <option type='string' id='LATEX_FOOTER' format='file' docs='
1191 The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1192 the generated latex document. The footer should contain everything after
1193 the last chapter. If it is left blank doxygen will generate a
1194 standard footer. Notice: only use this tag if you know what you are doing!
1195 ' defval='' depends='GENERATE_LATEX'/>
1196 <option type='bool' id='PDF_HYPERLINKS' docs='
1197 If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1198 is prepared for conversion to pdf (using ps2pdf). The pdf file will
1199 contain links (just like the HTML output) instead of page references
1200 This makes the output suitable for online browsing using a pdf viewer.
1201 ' defval='1' depends='GENERATE_LATEX'/>
1202 <option type='bool' id='USE_PDFLATEX' docs='
1203 If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1204 plain latex in the generated Makefile. Set this option to YES to get a
1205 higher quality PDF documentation.
1206 ' defval='1' depends='GENERATE_LATEX'/>
1207 <option type='bool' id='LATEX_BATCHMODE' docs='
1208 If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1209 command to the generated LaTeX files. This will instruct LaTeX to keep
1210 running if errors occur, instead of asking the user for help.
1211 This option is also used when generating formulas in HTML.
1212 ' defval='0' depends='GENERATE_LATEX'/>
1213 <option type='bool' id='LATEX_HIDE_INDICES' docs='
1214 If LATEX_HIDE_INDICES is set to YES then doxygen will not
1215 include the index chapters (such as File Index, Compound Index, etc.)
1217 ' defval='0' depends='GENERATE_LATEX'/>
1218 <option type='bool' id='LATEX_SOURCE_CODE' docs='
1219 If LATEX_SOURCE_CODE is set to YES then doxygen will include
1220 source code with syntax highlighting in the LaTeX output.
1221 Note that which sources are shown also depends on other settings
1222 such as SOURCE_BROWSER.
1223 ' defval='0' depends='GENERATE_LATEX'/>
1224 <option type='string' id='LATEX_BIB_STYLE' format='string' docs='
1225 The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1226 bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1227 http://en.wikipedia.org/wiki/BibTeX for more info.
1230 <group name='RTF' docs='configuration options related to the RTF output'>
1231 <option type='bool' id='GENERATE_RTF' docs='
1232 If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1233 The RTF output is optimized for Word 97 and may not look very pretty with
1234 other RTF readers or editors.
1236 <option type='string' id='RTF_OUTPUT' format='dir' docs='
1237 The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1238 If a relative path is entered the value of OUTPUT_DIRECTORY will be
1239 put in front of it. If left blank `rtf' will be used as the default path.
1240 ' defval='rtf' depends='GENERATE_RTF'/>
1241 <option type='bool' id='COMPACT_RTF' docs='
1242 If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1243 RTF documents. This may be useful for small projects and may help to
1244 save some trees in general.
1245 ' defval='0' depends='GENERATE_RTF'/>
1246 <option type='bool' id='RTF_HYPERLINKS' docs='
1247 If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1248 will contain hyperlink fields. The RTF file will
1249 contain links (just like the HTML output) instead of page references.
1250 This makes the output suitable for online browsing using WORD or other
1251 programs which support those fields.
1252 Note: wordpad (write) and others do not support links.
1253 ' defval='0' depends='GENERATE_RTF'/>
1254 <option type='string' id='RTF_STYLESHEET_FILE' format='file' docs='
1255 Load style sheet definitions from file. Syntax is similar to doxygen's
1256 config file, i.e. a series of assignments. You only have to provide
1257 replacements, missing definitions are set to their default value.
1258 ' defval='' depends='GENERATE_RTF'/>
1259 <option type='string' id='RTF_EXTENSIONS_FILE' format='file' docs='
1260 Set optional variables used in the generation of an rtf document.
1261 Syntax is similar to doxygen's config file.
1262 ' defval='' depends='GENERATE_RTF'/>
1264 <group name='Man' docs='configuration options related to the man page output'>
1265 <option type='bool' id='GENERATE_MAN' docs='
1266 If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1269 <option type='string' id='MAN_OUTPUT' format='dir' docs='
1270 The MAN_OUTPUT tag is used to specify where the man pages will be put.
1271 If a relative path is entered the value of OUTPUT_DIRECTORY will be
1272 put in front of it. If left blank `man' will be used as the default path.
1273 ' defval='man' depends='GENERATE_MAN'/>
1274 <option type='string' id='MAN_EXTENSION' format='string' docs='
1275 The MAN_EXTENSION tag determines the extension that is added to
1276 the generated man pages (default is the subroutine's section .3)
1277 ' defval='.3' depends='GENERATE_MAN'/>
1278 <option type='bool' id='MAN_LINKS' docs='
1279 If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1280 then it will generate one additional man file for each entity
1281 documented in the real man page(s). These additional files
1282 only source the real man page, but without them the man command
1283 would be unable to find the correct page. The default is NO.
1284 ' defval='0' depends='GENERATE_MAN'/>
1286 <group name='XML' docs='configuration options related to the XML output'>
1287 <option type='bool' id='GENERATE_XML' docs='
1288 If the GENERATE_XML tag is set to YES Doxygen will
1289 generate an XML file that captures the structure of
1290 the code including all documentation.
1292 <option type='string' id='XML_OUTPUT' format='dir' docs='
1293 The XML_OUTPUT tag is used to specify where the XML pages will be put.
1294 If a relative path is entered the value of OUTPUT_DIRECTORY will be
1295 put in front of it. If left blank `xml' will be used as the default path.
1296 ' defval='xml' depends='GENERATE_XML'/>
1297 <option type='string' id='XML_SCHEMA' format='string' docs='
1298 The XML_SCHEMA tag can be used to specify an XML schema,
1299 which can be used by a validating XML parser to check the
1300 syntax of the XML files.
1301 ' defval='' depends='GENERATE_XML'/>
1302 <option type='string' id='XML_DTD' format='string' docs='
1303 The XML_DTD tag can be used to specify an XML DTD,
1304 which can be used by a validating XML parser to check the
1305 syntax of the XML files.
1306 ' defval='' depends='GENERATE_XML'/>
1307 <option type='bool' id='XML_PROGRAMLISTING' docs='
1308 If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1309 dump the program listings (including syntax highlighting
1310 and cross-referencing information) to the XML output. Note that
1311 enabling this will significantly increase the size of the XML output.
1312 ' defval='1' depends='GENERATE_XML'/>
1314 <group name='DEF' docs='configuration options for the AutoGen Definitions output'>
1315 <option type='bool' id='GENERATE_AUTOGEN_DEF' docs='
1316 If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1317 generate an AutoGen Definitions (see autogen.sf.net) file
1318 that captures the structure of the code including all
1319 documentation. Note that this feature is still experimental
1320 and incomplete at the moment.
1323 <group name='PerlMod' docs='configuration options related to the Perl module output'>
1324 <option type='bool' id='GENERATE_PERLMOD' docs='
1325 If the GENERATE_PERLMOD tag is set to YES Doxygen will
1326 generate a Perl module file that captures the structure of
1327 the code including all documentation. Note that this
1328 feature is still experimental and incomplete at the
1331 <option type='bool' id='PERLMOD_LATEX' docs='
1332 If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1333 the necessary Makefile rules, Perl scripts and LaTeX code to be able
1334 to generate PDF and DVI output from the Perl module output.
1335 ' defval='0' depends='GENERATE_PERLMOD'/>
1336 <option type='bool' id='PERLMOD_PRETTY' docs='
1337 If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1338 nicely formatted so it can be parsed by a human reader. This is useful
1339 if you want to understand what is going on. On the other hand, if this
1340 tag is set to NO the size of the Perl module output will be much smaller
1341 and Perl will parse it just the same.
1342 ' defval='1' depends='GENERATE_PERLMOD'/>
1343 <option type='string' id='PERLMOD_MAKEVAR_PREFIX' format='string' docs='
1344 The names of the make variables in the generated doxyrules.make file
1345 are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1346 This is useful so different doxyrules.make files included by the same
1347 Makefile don't overwrite each other's variables.' defval='' depends='GENERATE_PERLMOD'/>
1349 <group name='Preprocessor' docs='Configuration options related to the preprocessor'>
1350 <option type='bool' id='ENABLE_PREPROCESSING' docs='
1351 If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1352 evaluate all C-preprocessor directives found in the sources and include
1355 <option type='bool' id='MACRO_EXPANSION' docs='
1356 If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1357 names in the source code. If set to NO (the default) only conditional
1358 compilation will be performed. Macro expansion can be done in a controlled
1359 way by setting EXPAND_ONLY_PREDEF to YES.
1360 ' defval='0' depends='ENABLE_PREPROCESSING'/>
1361 <option type='bool' id='EXPAND_ONLY_PREDEF' docs='
1362 If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1363 then the macro expansion is limited to the macros specified with the
1364 PREDEFINED and EXPAND_AS_DEFINED tags.
1365 ' defval='0' depends='ENABLE_PREPROCESSING'/>
1366 <option type='bool' id='SEARCH_INCLUDES' docs='
1367 If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1368 pointed to by INCLUDE_PATH will be searched when a #include is found.
1369 ' defval='1' depends='ENABLE_PREPROCESSING'/>
1370 <option type='list' id='INCLUDE_PATH' format='dir' docs='
1371 The INCLUDE_PATH tag can be used to specify one or more directories that
1372 contain include files that are not input files but should be processed by
1374 ' depends='ENABLE_PREPROCESSING'>
1376 <option type='list' id='INCLUDE_FILE_PATTERNS' format='string' docs='
1377 You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1378 patterns (like *.h and *.hpp) to filter out the header-files in the
1379 directories. If left blank, the patterns specified with FILE_PATTERNS will
1381 ' depends='ENABLE_PREPROCESSING'>
1383 <option type='list' id='PREDEFINED' format='string' docs='
1384 The PREDEFINED tag can be used to specify one or more macro names that
1385 are defined before the preprocessor is started (similar to the -D option of
1386 gcc). The argument of the tag is a list of macros of the form: name
1387 or name=definition (no spaces). If the definition and the = are
1388 omitted =1 is assumed. To prevent a macro definition from being
1389 undefined via #undef or recursively expanded use the := operator
1390 instead of the = operator.
1391 ' depends='ENABLE_PREPROCESSING'>
1393 <option type='list' id='EXPAND_AS_DEFINED' format='string' docs='
1394 If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1395 this tag can be used to specify a list of macro names that should be expanded.
1396 The macro definition that is found in the sources will be used.
1397 Use the PREDEFINED tag if you want to use a different macro definition that
1398 overrules the definition found in the source code.
1399 ' depends='ENABLE_PREPROCESSING'>
1401 <option type='bool' id='SKIP_FUNCTION_MACROS' docs='
1402 If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1403 doxygen's preprocessor will remove all references to function-like macros
1404 that are alone on a line, have an all uppercase name, and do not end with a
1405 semicolon, because these will confuse the parser if not removed.
1406 ' defval='1' depends='ENABLE_PREPROCESSING'/>
1408 <group name='External' docs='Configuration::additions related to external references'>
1409 <option type='list' id='TAGFILES' format='file' docs='
1410 The TAGFILES option can be used to specify one or more tagfiles. For each
1411 tag file the location of the external documentation should be added. The
1412 format of a tag file without this location is as follows:
1413 TAGFILES = file1 file2 ...
1414 Adding location for the tag files is done as follows:
1415 TAGFILES = file1=loc1 "file2 = loc2" ...
1416 where "loc1" and "loc2" can be relative or absolute paths
1417 or URLs. Note that each tag file must have a unique name (where the name does
1418 NOT include the path). If a tag file is not located in the directory in which
1419 doxygen is run, you must also specify the path to the tagfile here.
1422 <option type='string' id='GENERATE_TAGFILE' format='file' docs='
1423 When a file name is specified after GENERATE_TAGFILE, doxygen will create
1424 a tag file that is based on the input files it reads.
1426 <option type='bool' id='ALLEXTERNALS' docs='
1427 If the ALLEXTERNALS tag is set to YES all external classes will be listed
1428 in the class index. If set to NO only the inherited external classes
1431 <option type='bool' id='EXTERNAL_GROUPS' docs='
1432 If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1433 in the modules index. If set to NO, only the current project's groups will
1436 <option type='string' id='PERL_PATH' format='dir' docs='
1437 The PERL_PATH should be the absolute path and name of the perl script
1438 interpreter (i.e. the result of `which perl').
1439 ' defval='/usr/bin/perl'/>
1441 <group name='Dot' docs='Configuration options related to the dot tool'>
1442 <option type='bool' id='CLASS_DIAGRAMS' docs='
1443 If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1444 generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1445 or super classes. Setting the tag to NO turns the diagrams off. Note that
1446 this option also works with HAVE_DOT disabled, but it is recommended to
1447 install and use dot, since it yields more powerful graphs.
1449 <option type='string' id='MSCGEN_PATH' format='string' docs='
1450 You can define message sequence charts within doxygen comments using the \msc
1451 command. Doxygen will then run the mscgen tool (see
1452 http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1453 documentation. The MSCGEN_PATH tag allows you to specify the directory where
1454 the mscgen tool resides. If left empty the tool is assumed to be found in the
1455 default search path.
1457 <option type='bool' id='HIDE_UNDOC_RELATIONS' docs='
1458 If set to YES, the inheritance and collaboration graphs will hide
1459 inheritance and usage relations if the target is undocumented
1462 <option type='bool' id='HAVE_DOT' docs='
1463 If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1464 available from the path. This tool is part of Graphviz, a graph visualization
1465 toolkit from AT&T and Lucent Bell Labs. The other options in this section
1466 have no effect if this option is set to NO (the default)
1468 <option type='int' id='DOT_NUM_THREADS' docs='
1469 The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1470 allowed to run in parallel. When set to 0 (the default) doxygen will
1471 base this on the number of processors available in the system. You can set it
1472 explicitly to a value larger than 0 to get control over the balance
1473 between CPU load and processing speed.
1474 ' defval='0' minval='0' maxval='32'/>
1475 <option type='string' id='DOT_FONTNAME' format='string' docs='
1476 By default doxygen will use the Helvetica font for all dot files that
1477 doxygen generates. When you want a differently looking font you can specify
1478 the font name using DOT_FONTNAME. You need to make sure dot is able to find
1479 the font, which can be done by putting it in a standard location or by setting
1480 the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1481 directory containing the font.
1482 ' defval='Helvetica' depends='HAVE_DOT'/>
1483 <option type='int' id='DOT_FONTSIZE' docs='
1484 The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1485 The default size is 10pt.
1486 ' minval='4' maxval='24' defval='10' depends='HAVE_DOT'/>
1487 <option type='string' id='DOT_FONTPATH' format='string' docs='
1488 By default doxygen will tell dot to use the Helvetica font.
1489 If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1490 set the path where dot can find it.
1491 ' defval='' depends='HAVE_DOT'/>
1492 <option type='bool' id='CLASS_GRAPH' docs='
1493 If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1494 will generate a graph for each documented class showing the direct and
1495 indirect inheritance relations. Setting this tag to YES will force the
1496 CLASS_DIAGRAMS tag to NO.
1497 ' defval='1' depends='HAVE_DOT'/>
1498 <option type='bool' id='COLLABORATION_GRAPH' docs='
1499 If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1500 will generate a graph for each documented class showing the direct and
1501 indirect implementation dependencies (inheritance, containment, and
1502 class references variables) of the class with other documented classes.
1503 ' defval='1' depends='HAVE_DOT'/>
1504 <option type='bool' id='GROUP_GRAPHS' docs='
1505 If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1506 will generate a graph for groups, showing the direct groups dependencies
1507 ' defval='1' depends='HAVE_DOT'/>
1508 <option type='bool' id='UML_LOOK' docs='
1509 If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1510 collaboration diagrams in a style similar to the OMG's Unified Modeling
1512 ' defval='0' depends='HAVE_DOT'/>
1513 <option type='int' id='UML_LIMIT_NUM_FIELDS' docs='
1514 If the UML_LOOK tag is enabled, the fields and methods are shown inside
1515 the class node. If there are many fields or methods and many nodes the
1516 graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1517 threshold limits the number of items for each type to make the size more
1518 managable. Set this to 0 for no limit. Note that the threshold may be
1519 exceeded by 50% before the limit is enforced.
1520 ' defval='10' minval='0' maxval='100' depends='HAVE_DOT'/>
1521 <option type='bool' id='TEMPLATE_RELATIONS' docs='
1522 If set to YES, the inheritance and collaboration graphs will show the
1523 relations between templates and their instances.
1524 ' defval='0' depends='HAVE_DOT'/>
1525 <option type='bool' id='INCLUDE_GRAPH' docs='
1526 If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1527 tags are set to YES then doxygen will generate a graph for each documented
1528 file showing the direct and indirect include dependencies of the file with
1529 other documented files.
1530 ' defval='1' depends='HAVE_DOT'/>
1531 <option type='bool' id='INCLUDED_BY_GRAPH' docs='
1532 If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1533 HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1534 documented header file showing the documented files that directly or
1535 indirectly include this file.
1536 ' defval='1' depends='HAVE_DOT'/>
1537 <option type='bool' id='CALL_GRAPH' docs='
1538 If the CALL_GRAPH and HAVE_DOT options are set to YES then
1539 doxygen will generate a call dependency graph for every global function
1540 or class method. Note that enabling this option will significantly increase
1541 the time of a run. So in most cases it will be better to enable call graphs
1542 for selected functions only using the \callgraph command.
1543 ' defval='0' depends='HAVE_DOT'/>
1544 <option type='bool' id='CALLER_GRAPH' docs='
1545 If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1546 doxygen will generate a caller dependency graph for every global function
1547 or class method. Note that enabling this option will significantly increase
1548 the time of a run. So in most cases it will be better to enable caller
1549 graphs for selected functions only using the \callergraph command.
1550 ' defval='0' depends='HAVE_DOT'/>
1551 <option type='bool' id='GRAPHICAL_HIERARCHY' docs='
1552 If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1553 will generate a graphical hierarchy of all classes instead of a textual one.
1554 ' defval='1' depends='HAVE_DOT'/>
1555 <option type='bool' id='DIRECTORY_GRAPH' docs='
1556 If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1557 then doxygen will show the dependencies a directory has on other directories
1558 in a graphical way. The dependency relations are determined by the #include
1559 relations between the files in the directories.
1560 ' defval='1' depends='HAVE_DOT'/>
1561 <option type='enum' id='DOT_IMAGE_FORMAT' defval='png' docs='
1562 The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1563 generated by dot. Possible values are svg, png, jpg, or gif.
1564 If left blank png will be used. If you choose svg you need to set
1565 HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1566 visible in IE 9+ (other browsers do not have this requirement).
1567 ' depends='HAVE_DOT'>
1573 <option type='bool' id='INTERACTIVE_SVG' docs='
1574 If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1575 enable generation of interactive SVG images that allow zooming and panning.
1576 Note that this requires a modern browser other than Internet Explorer.
1577 Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1578 need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1579 visible. Older versions of IE do not have SVG support.
1580 ' defval='0' depends='HAVE_DOT'/>
1581 <option type='string' id='DOT_PATH' format='dir' docs='
1582 The tag DOT_PATH can be used to specify the path where the dot tool can be
1583 found. If left blank, it is assumed the dot tool can be found in the path.
1584 ' defval='' depends='HAVE_DOT'/>
1585 <option type='list' id='DOTFILE_DIRS' format='dir' docs='
1586 The DOTFILE_DIRS tag can be used to specify one or more directories that
1587 contain dot files that are included in the documentation (see the
1589 ' depends='HAVE_DOT'>
1591 <option type='list' id='MSCFILE_DIRS' format='dir' docs='
1592 The MSCFILE_DIRS tag can be used to specify one or more directories that
1593 contain msc files that are included in the documentation (see the
1597 <option type='int' id='DOT_GRAPH_MAX_NODES' docs='
1598 The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1599 nodes that will be shown in the graph. If the number of nodes in a graph
1600 becomes larger than this value, doxygen will truncate the graph, which is
1601 visualized by representing a node as a red box. Note that doxygen if the
1602 number of direct children of the root node in a graph is already larger than
1603 DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1604 that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1605 ' minval='0' maxval='10000' defval='50' depends='HAVE_DOT'/>
1606 <option type='int' id='MAX_DOT_GRAPH_DEPTH' docs='
1607 The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1608 graphs generated by dot. A depth value of 3 means that only nodes reachable
1609 from the root by following a path via at most 3 edges will be shown. Nodes
1610 that lay further from the root node will be omitted. Note that setting this
1611 option to 1 or 2 may greatly reduce the computation time needed for large
1612 code bases. Also note that the size of a graph can be further restricted by
1613 DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1614 ' minval='0' maxval='1000' defval='0' depends='HAVE_DOT'/>
1615 <option type='bool' id='DOT_TRANSPARENT' docs='
1616 Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1617 background. This is disabled by default, because dot on Windows does not
1618 seem to support this out of the box. Warning: Depending on the platform used,
1619 enabling this option may lead to badly anti-aliased labels on the edges of
1620 a graph (i.e. they become hard to read).
1621 ' defval='0' depends='HAVE_DOT'/>
1622 <option type='bool' id='DOT_MULTI_TARGETS' docs='
1623 Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1624 files in one run (i.e. multiple -o and -T options on the command line). This
1625 makes dot run faster, but since only newer versions of dot (>1.8.10)
1626 support this, this feature is disabled by default.
1627 ' defval='0' depends='HAVE_DOT'/>
1628 <option type='bool' id='GENERATE_LEGEND' docs='
1629 If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1630 generate a legend page explaining the meaning of the various boxes and
1631 arrows in the dot generated graphs.
1632 ' defval='1' depends='HAVE_DOT'/>
1633 <option type='bool' id='DOT_CLEANUP' docs='
1634 If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1635 remove the intermediate dot files that are used to generate
1637 ' defval='1' depends='HAVE_DOT'/>
1638 <option type='obsolete' id='USE_WINDOWS_ENCODING'/>
1639 <option type='obsolete' id='DETAILS_AT_TOP'/>
1640 <option type='obsolete' id='QTHELP_FILE'/>
1641 <option type='obsolete' id='QTHELP_CONFIG'/>
1642 <option type='obsolete' id='DOXYGEN2QTHELP_LOC'/>
1643 <option type='obsolete' id='MAX_DOT_GRAPH_WIDTH'/>
1644 <option type='obsolete' id='MAX_DOT_GRAPH_HEIGHT'/>
1645 <option type='obsolete' id='CGI_NAME'/>
1646 <option type='obsolete' id='CGI_URL'/>
1647 <option type='obsolete' id='DOC_URL'/>
1648 <option type='obsolete' id='DOC_ABSPATH'/>
1649 <option type='obsolete' id='BIN_ABSPATH'/>
1650 <option type='obsolete' id='EXT_DOC_PATHS'/>
1651 <option type='obsolete' id='USE_INLINE_TREES'/>
1652 <option type='obsolete' id='SHOW_DIRECTORIES'/>
1653 <option type='obsolete' id='HTML_ALIGN_MEMBERS'/>