Chameleon Svn Source Tree


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

Archive Download this file

Revision: 1322