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