Debian Codegraph @

api/docs/Doxyfile-gmxapi0.cmakein

raw
1 # Doxyfile 1.8.5
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 double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
8 #
9 # All text after a single hash (#) is considered a comment and will be ignored.
10 # The format is:
11 # TAG = value [value, ...]
12 # For lists, items can also be appended using:
13 # TAG += value [value, ...]
14 # Values that contain spaces should be placed between quotes (\" \").
15
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
19
20 # This tag specifies the encoding used for all characters in the config file
21 # that follow. The default is UTF-8 which is also the encoding used for all text
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24 # for the list of possible encodings.
25 # The default value is: UTF-8.
26
27 DOXYFILE_ENCODING = UTF-8
28
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
32 # title of most generated pages and in a few other places.
33 # The default value is: My Project.
34
35 PROJECT_NAME = "GROMACS external C++ API"
36
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
39 # control system is used.
40
41 PROJECT_NUMBER = @GMXAPI_RELEASE@
42
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 # for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description short.
46
47 PROJECT_BRIEF =
48
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 # in the documentation. The maximum height of the logo should not exceed 55
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 # the logo to the output directory.
53
54 PROJECT_LOGO =
55
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
60
61 OUTPUT_DIRECTORY = @GMXAPI_USERDOC_OUTPUT@
62
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
66 # option can be useful when feeding doxygen a huge amount of source files, where
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
70
71 CREATE_SUBDIRS = NO
72
73 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
74 # documentation generated by doxygen is written. Doxygen will use this
75 # information to generate all constant output in the proper language.
76 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
77 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
78 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
79 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
80 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
81 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
82 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
83 # Ukrainian and Vietnamese.
84 # The default value is: English.
85
86 OUTPUT_LANGUAGE = English
87
88 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
89 # descriptions after the members that are listed in the file and class
90 # documentation (similar to Javadoc). Set to NO to disable this.
91 # The default value is: YES.
92
93 BRIEF_MEMBER_DESC = YES
94
95 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
96 # description of a member or function before the detailed description
97 #
98 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
99 # brief descriptions will be completely suppressed.
100 # The default value is: YES.
101
102 REPEAT_BRIEF = YES
103
104 # This tag implements a quasi-intelligent brief description abbreviator that is
105 # used to form the text in various listings. Each string in this list, if found
106 # as the leading text of the brief description, will be stripped from the text
107 # and the result, after processing the whole list, is used as the annotated
108 # text. Otherwise, the brief description is used as-is. If left blank, the
109 # following values are used ($name is automatically replaced with the name of
110 # the entity):The $name class, The $name widget, The $name file, is, provides,
111 # specifies, contains, represents, a, an and the.
112
113 ABBREVIATE_BRIEF = "The $name class" \
114 "The $name widget" \
115 "The $name file" \
116 is \
117 provides \
118 specifies \
119 contains \
120 represents \
121 a \
122 an \
123 the
124
125 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
126 # doxygen will generate a detailed section even if there is only a brief
127 # description.
128 # The default value is: NO.
129
130 # It looks weird to have detailed description for only some entities.
131 ALWAYS_DETAILED_SEC = YES
132
133 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
134 # inherited members of a class in the documentation of that class as if those
135 # members were ordinary class members. Constructors, destructors and assignment
136 # operators of the base classes will not be shown.
137 # The default value is: NO.
138
139 INLINE_INHERITED_MEMB = YES
140
141 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
142 # before files name in the file list and in the header files. If set to NO the
143 # shortest path that makes the file name unique will be used
144 # The default value is: YES.
145
146 FULL_PATH_NAMES = YES
147
148 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
149 # Stripping is only done if one of the specified strings matches the left-hand
150 # part of the path. The tag can be used to show relative paths in the file list.
151 # If left blank the directory from which doxygen is run is used as the path to
152 # strip.
153 #
154 # Note that you can specify absolute paths here, but also relative paths, which
155 # will be relative from the directory where doxygen is started.
156 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
157
158 STRIP_FROM_PATH = @GMXAPI_SOURCE_DIR@/include @GMXAPI_BINARY_DIR@/include @GMXAPI_SOURCE_DIR@ @GMXAPI_BINARY_DIR@
159
160 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
161 # path mentioned in the documentation of a class, which tells the reader which
162 # header file to include in order to use a class. If left blank only the name of
163 # the header file containing the class definition is used. Otherwise one should
164 # specify the list of include paths that are normally passed to the compiler
165 # using the -I flag.
166
167 STRIP_FROM_INC_PATH = @GMXAPI_SOURCE_DIR@/include @GMXAPI_BINARY_DIR@/include
168
169 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
170 # less readable) file names. This can be useful is your file systems doesn't
171 # support long names like on DOS, Mac, or CD-ROM.
172 # The default value is: NO.
173
174 SHORT_NAMES = NO
175
176 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
177 # first line (until the first dot) of a Javadoc-style comment as the brief
178 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
179 # style comments (thus requiring an explicit @brief command for a brief
180 # description.)
181 # The default value is: NO.
182
183 JAVADOC_AUTOBRIEF = YES
184
185 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
186 # line (until the first dot) of a Qt-style comment as the brief description. If
187 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
188 # requiring an explicit \brief command for a brief description.)
189 # The default value is: NO.
190
191 QT_AUTOBRIEF = NO
192
193 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
194 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
195 # a brief description. This used to be the default behavior. The new default is
196 # to treat a multi-line C++ comment block as a detailed description. Set this
197 # tag to YES if you prefer the old behavior instead.
198 #
199 # Note that setting this tag to YES also means that rational rose comments are
200 # not recognized any more.
201 # The default value is: NO.
202
203 MULTILINE_CPP_IS_BRIEF = NO
204
205 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
206 # documentation from any documented member that it re-implements.
207 # The default value is: YES.
208
209 INHERIT_DOCS = YES
210
211 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
212 # page for each member. If set to NO, the documentation of a member will be part
213 # of the file/class/namespace that contains it.
214 # The default value is: NO.
215
216 SEPARATE_MEMBER_PAGES = NO
217
218 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
219 # uses this value to replace tabs by spaces in code fragments.
220 # Minimum value: 1, maximum value: 16, default value: 4.
221
222 TAB_SIZE = 4
223
224 # This tag can be used to specify a number of aliases that act as commands in
225 # the documentation. An alias has the form:
226 # name=value
227 # For example adding
228 # "sideeffect=@par Side Effects:\n"
229 # will allow you to put the command \sideeffect (or @sideeffect) in the
230 # documentation, which will result in a user-defined paragraph with heading
231 # "Side Effects:". You can put \n's in the value part of an alias to insert
232 # newlines.
233
234 ALIASES =
235
236 # This tag can be used to specify a number of word-keyword mappings (TCL only).
237 # A mapping has the form "name=value". For example adding "class=itcl::class"
238 # will allow you to use the command class in the itcl::class meaning.
239
240 TCL_SUBST =
241
242 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
243 # only. Doxygen will then generate output that is more tailored for C. For
244 # instance, some of the names that are used will be different. The list of all
245 # members will be omitted, etc.
246 # The default value is: NO.
247
248 OPTIMIZE_OUTPUT_FOR_C = NO
249
250 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
251 # Python sources only. Doxygen will then generate output that is more tailored
252 # for that language. For instance, namespaces will be presented as packages,
253 # qualified scopes will look different, etc.
254 # The default value is: NO.
255
256 OPTIMIZE_OUTPUT_JAVA = NO
257
258 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
259 # sources. Doxygen will then generate output that is tailored for Fortran.
260 # The default value is: NO.
261
262 OPTIMIZE_FOR_FORTRAN = NO
263
264 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
265 # sources. Doxygen will then generate output that is tailored for VHDL.
266 # The default value is: NO.
267
268 OPTIMIZE_OUTPUT_VHDL = NO
269
270 # Doxygen selects the parser to use depending on the extension of the files it
271 # parses. With this tag you can assign which parser to use for a given
272 # extension. Doxygen has a built-in mapping, but you can override or extend it
273 # using this tag. The format is ext=language, where ext is a file extension, and
274 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
275 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
276 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
277 # Fortran. In the later case the parser tries to guess whether the code is fixed
278 # or free formatted code, this is the default for Fortran type files), VHDL. For
279 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
280 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
281 #
282 # Note: For files without extension you can use no_extension as a placeholder.
283 #
284 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
285 # the files are not read by doxygen.
286
287 EXTENSION_MAPPING =
288
289 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
290 # according to the Markdown format, which allows for more readable
291 # documentation. See http://daringfireball.net/projects/markdown/ for details.
292 # The output of markdown processing is further processed by doxygen, so you can
293 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
294 # case of backward compatibilities issues.
295 # The default value is: YES.
296
297 MARKDOWN_SUPPORT = YES
298
299 # When enabled doxygen tries to link words that correspond to documented
300 # classes, or namespaces to their corresponding documentation. Such a link can
301 # be prevented in individual cases by putting a % sign in front of the word or
302 # globally by setting AUTOLINK_SUPPORT to NO.
303 # The default value is: YES.
304
305 AUTOLINK_SUPPORT = YES
306
307 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
308 # to include (a tag file for) the STL sources as input, then you should set this
309 # tag to YES in order to let doxygen match functions declarations and
310 # definitions whose arguments contain STL classes (e.g. func(std::string);
311 # versus func(std::string) {}). This also make the inheritance and collaboration
312 # diagrams that involve STL classes more complete and accurate.
313 # The default value is: NO.
314
315 BUILTIN_STL_SUPPORT = YES
316
317 # If you use Microsoft's C++/CLI language, you should set this option to YES to
318 # enable parsing support.
319 # The default value is: NO.
320
321 CPP_CLI_SUPPORT = NO
322
323 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
324 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
325 # will parse them like normal C++ but will assume all classes use public instead
326 # of private inheritance when no explicit protection keyword is present.
327 # The default value is: NO.
328
329 SIP_SUPPORT = NO
330
331 # For Microsoft's IDL there are propget and propput attributes to indicate
332 # getter and setter methods for a property. Setting this option to YES will make
333 # doxygen to replace the get and set methods by a property in the documentation.
334 # This will only work if the methods are indeed getting or setting a simple
335 # type. If this is not the case, or you want to show the methods anyway, you
336 # should set this option to NO.
337 # The default value is: YES.
338
339 IDL_PROPERTY_SUPPORT = YES
340
341 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
342 # tag is set to YES then doxygen will reuse the documentation of the first
343 # member in the group (if any) for the other members of the group. By default
344 # all members of a group must be documented explicitly.
345 # The default value is: NO.
346
347 DISTRIBUTE_GROUP_DOC = NO
348
349 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
350 # (for instance a group of public functions) to be put as a subgroup of that
351 # type (e.g. under the Public Functions section). Set it to NO to prevent
352 # subgrouping. Alternatively, this can be done per class using the
353 # \nosubgrouping command.
354 # The default value is: YES.
355
356 SUBGROUPING = YES
357
358 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
359 # are shown inside the group in which they are included (e.g. using \ingroup)
360 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
361 # and RTF).
362 #
363 # Note that this feature does not work in combination with
364 # SEPARATE_MEMBER_PAGES.
365 # The default value is: NO.
366
367 INLINE_GROUPED_CLASSES = NO
368
369 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
370 # with only public data fields or simple typedef fields will be shown inline in
371 # the documentation of the scope in which they are defined (i.e. file,
372 # namespace, or group documentation), provided this scope is documented. If set
373 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
374 # Man pages) or section (for LaTeX and RTF).
375 # The default value is: NO.
376
377 INLINE_SIMPLE_STRUCTS = NO
378
379 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
380 # enum is documented as struct, union, or enum with the name of the typedef. So
381 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
382 # with name TypeT. When disabled the typedef will appear as a member of a file,
383 # namespace, or class. And the struct will be named TypeS. This can typically be
384 # useful for C code in case the coding convention dictates that all compound
385 # types are typedef'ed and only the typedef is referenced, never the tag name.
386 # The default value is: NO.
387
388 TYPEDEF_HIDES_STRUCT = NO
389
390 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
391 # cache is used to resolve symbols given their name and scope. Since this can be
392 # an expensive process and often the same symbol appears multiple times in the
393 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
394 # doxygen will become slower. If the cache is too large, memory is wasted. The
395 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
396 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
397 # symbols. At the end of a run doxygen will report the cache usage and suggest
398 # the optimal cache size from a speed point of view.
399 # Minimum value: 0, maximum value: 9, default value: 0.
400
401 LOOKUP_CACHE_SIZE = 0
402
403 #---------------------------------------------------------------------------
404 # Build related configuration options
405 #---------------------------------------------------------------------------
406
407 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
408 # documentation are documented, even if no documentation was available. Private
409 # class members and static file members will be hidden unless the
410 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
411 # Note: This will also disable the warnings about undocumented members that are
412 # normally produced when WARNINGS is set to YES.
413 # The default value is: NO.
414
415 EXTRACT_ALL = NO
416
417 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
418 # be included in the documentation.
419 # The default value is: NO.
420
421 EXTRACT_PRIVATE = NO
422
423 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
424 # scope will be included in the documentation.
425 # The default value is: NO.
426
427 EXTRACT_PACKAGE = NO
428
429 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
430 # included in the documentation.
431 # The default value is: NO.
432
433 EXTRACT_STATIC = NO
434
435 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
436 # locally in source files will be included in the documentation. If set to NO,
437 # only classes defined in header files are included. Does not have any effect
438 # for Java sources.
439 # The default value is: YES.
440
441 EXTRACT_LOCAL_CLASSES = YES
442
443 # This flag is only useful for Objective-C code. If set to YES, local methods,
444 # which are defined in the implementation section but not in the interface are
445 # included in the documentation. If set to NO, only methods in the interface are
446 # included.
447 # The default value is: NO.
448
449 EXTRACT_LOCAL_METHODS = NO
450
451 # If this flag is set to YES, the members of anonymous namespaces will be
452 # extracted and appear in the documentation as a namespace called
453 # 'anonymous_namespace{file}', where file will be replaced with the base name of
454 # the file that contains the anonymous namespace. By default anonymous namespace
455 # are hidden.
456 # The default value is: NO.
457
458 EXTRACT_ANON_NSPACES = NO
459
460 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
461 # undocumented members inside documented classes or files. If set to NO these
462 # members will be included in the various overviews, but no documentation
463 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
464 # The default value is: NO.
465
466 HIDE_UNDOC_MEMBERS = NO
467
468 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
469 # undocumented classes that are normally visible in the class hierarchy. If set
470 # to NO, these classes will be included in the various overviews. This option
471 # has no effect if EXTRACT_ALL is enabled.
472 # The default value is: NO.
473
474 HIDE_UNDOC_CLASSES = NO
475
476 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
477 # (class|struct|union) declarations. If set to NO, these declarations will be
478 # included in the documentation.
479 # The default value is: NO.
480
481 HIDE_FRIEND_COMPOUNDS = NO
482
483 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
484 # documentation blocks found inside the body of a function. If set to NO, these
485 # blocks will be appended to the function's detailed documentation block.
486 # The default value is: NO.
487
488 HIDE_IN_BODY_DOCS = NO
489
490 # The INTERNAL_DOCS tag determines if documentation that is typed after a
491 # \internal command is included. If the tag is set to NO then the documentation
492 # will be excluded. Set it to YES to include the internal documentation.
493 # The default value is: NO.
494
495 INTERNAL_DOCS = NO
496
497 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
498 # names in lower-case letters. If set to YES, upper-case letters are also
499 # allowed. This is useful if you have classes or files whose names only differ
500 # in case and if your file system supports case sensitive file names. Windows
501 # and Mac users are advised to set this option to NO.
502 # The default value is: system dependent.
503
504 CASE_SENSE_NAMES = NO
505
506 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
507 # their full class and namespace scopes in the documentation. If set to YES, the
508 # scope will be hidden.
509 # The default value is: NO.
510
511 HIDE_SCOPE_NAMES = NO
512
513 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
514 # the files that are included by a file in the documentation of that file.
515 # The default value is: YES.
516
517 SHOW_INCLUDE_FILES = YES
518
519 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
520 # files with double quotes in the documentation rather than with sharp brackets.
521 # The default value is: NO.
522
523 FORCE_LOCAL_INCLUDES = YES
524
525 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
526 # documentation for inline members.
527 # The default value is: YES.
528
529 INLINE_INFO = YES
530
531 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
532 # (detailed) documentation of file and class members alphabetically by member
533 # name. If set to NO, the members will appear in declaration order.
534 # The default value is: YES.
535
536 SORT_MEMBER_DOCS = YES
537
538 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
539 # descriptions of file, namespace and class members alphabetically by member
540 # name. If set to NO, the members will appear in declaration order. Note that
541 # this will also influence the order of the classes in the class list.
542 # The default value is: NO.
543
544 SORT_BRIEF_DOCS = NO
545
546 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
547 # (brief and detailed) documentation of class members so that constructors and
548 # destructors are listed first. If set to NO the constructors will appear in the
549 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
550 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
551 # member documentation.
552 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
553 # detailed member documentation.
554 # The default value is: NO.
555
556 SORT_MEMBERS_CTORS_1ST = YES
557
558 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
559 # of group names into alphabetical order. If set to NO the group names will
560 # appear in their defined order.
561 # The default value is: NO.
562
563 SORT_GROUP_NAMES = NO
564
565 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
566 # fully-qualified names, including namespaces. If set to NO, the class list will
567 # be sorted only by class name, not including the namespace part.
568 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
569 # Note: This option applies only to the class list, not to the alphabetical
570 # list.
571 # The default value is: NO.
572
573 SORT_BY_SCOPE_NAME = NO
574
575 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
576 # type resolution of all parameters of a function it will reject a match between
577 # the prototype and the implementation of a member function even if there is
578 # only one candidate or it is obvious which candidate to choose by doing a
579 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
580 # accept a match between prototype and implementation in such cases.
581 # The default value is: NO.
582
583 STRICT_PROTO_MATCHING = NO
584
585 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
586 # list. This list is created by putting \todo commands in the documentation.
587 # The default value is: YES.
588
589 GENERATE_TODOLIST = YES
590
591 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
592 # list. This list is created by putting \test commands in the documentation.
593 # The default value is: YES.
594
595 GENERATE_TESTLIST = YES
596
597 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
598 # list. This list is created by putting \bug commands in the documentation.
599 # The default value is: YES.
600
601 GENERATE_BUGLIST = YES
602
603 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
604 # the deprecated list. This list is created by putting \deprecated commands in
605 # the documentation.
606 # The default value is: YES.
607
608 GENERATE_DEPRECATEDLIST= YES
609
610 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
611 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
612 # ... \endcond blocks.
613
614 ENABLED_SECTIONS =
615
616 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
617 # initial value of a variable or macro / define can have for it to appear in the
618 # documentation. If the initializer consists of more lines than specified here
619 # it will be hidden. Use a value of 0 to hide initializers completely. The
620 # appearance of the value of individual variables and macros / defines can be
621 # controlled using \showinitializer or \hideinitializer command in the
622 # documentation regardless of this setting.
623 # Minimum value: 0, maximum value: 10000, default value: 30.
624
625 MAX_INITIALIZER_LINES = 30
626
627 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
628 # the bottom of the documentation of classes and structs. If set to YES, the
629 # list will mention the files that were used to generate the documentation.
630 # The default value is: YES.
631
632 SHOW_USED_FILES = YES
633
634 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
635 # will remove the Files entry from the Quick Index and from the Folder Tree View
636 # (if specified).
637 # The default value is: YES.
638
639 SHOW_FILES = YES
640
641 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
642 # page. This will remove the Namespaces entry from the Quick Index and from the
643 # Folder Tree View (if specified).
644 # The default value is: YES.
645
646 SHOW_NAMESPACES = YES
647
648 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
649 # doxygen should invoke to get the current version for each file (typically from
650 # the version control system). Doxygen will invoke the program by executing (via
651 # popen()) the command command input-file, where command is the value of the
652 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
653 # by doxygen. Whatever the program writes to standard output is used as the file
654 # version. For an example see the documentation.
655
656 FILE_VERSION_FILTER =
657
658 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
659 # by doxygen. The layout file controls the global structure of the generated
660 # output files in an output format independent way. To create the layout file
661 # that represents doxygen's defaults, run doxygen with the -l option. You can
662 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
663 # will be used as the name of the layout file.
664 #
665 # Note that if you run doxygen from a directory containing a file called
666 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
667 # tag is left empty.
668
669 LAYOUT_FILE =
670
671 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
672 # the reference definitions. This must be a list of .bib files. The .bib
673 # extension is automatically appended if omitted. This requires the bibtex tool
674 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
675 # For LaTeX the style of the bibliography can be controlled using
676 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
677 # search path. See also \cite for info how to create references.
678
679 CITE_BIB_FILES =
680
681 #---------------------------------------------------------------------------
682 # Configuration options related to warning and progress messages
683 #---------------------------------------------------------------------------
684
685 # The QUIET tag can be used to turn on/off the messages that are generated to
686 # standard output by doxygen. If QUIET is set to YES this implies that the
687 # messages are off.
688 # The default value is: NO.
689
690 QUIET = NO
691
692 # The WARNINGS tag can be used to turn on/off the warning messages that are
693 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
694 # this implies that the warnings are on.
695 #
696 # Tip: Turn warnings on while writing the documentation.
697 # The default value is: YES.
698
699 WARNINGS = YES
700
701 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
702 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
703 # will automatically be disabled.
704 # The default value is: YES.
705
706 WARN_IF_UNDOCUMENTED = YES
707
708 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
709 # potential errors in the documentation, such as not documenting some parameters
710 # in a documented function, or documenting parameters that don't exist or using
711 # markup commands wrongly.
712 # The default value is: YES.
713
714 WARN_IF_DOC_ERROR = YES
715
716 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
717 # are documented, but have no documentation for their parameters or return
718 # value. If set to NO, doxygen will only warn about wrong or incomplete
719 # parameter documentation, but not about the absence of documentation.
720 # The default value is: NO.
721
722 WARN_NO_PARAMDOC = YES
723
724 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
725 # can produce. The string should contain the $file, $line, and $text tags, which
726 # will be replaced by the file and line number from which the warning originated
727 # and the warning text. Optionally the format may contain $version, which will
728 # be replaced by the version of the file (if it could be obtained via
729 # FILE_VERSION_FILTER)
730 # The default value is: $file:$line: $text.
731
732 WARN_FORMAT = "$file:$line: $text"
733
734 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
735 # messages should be written. If left blank the output is written to standard
736 # error (stderr).
737
738 WARN_LOGFILE =
739
740 #---------------------------------------------------------------------------
741 # Configuration options related to the input files
742 #---------------------------------------------------------------------------
743
744 # The INPUT tag is used to specify the files and/or directories that contain
745 # documented source files. You may enter file names like myfile.cpp or
746 # directories like /usr/src/myproject. Separate the files or directories with
747 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
748 # Note: If this tag is empty the current directory is searched.
749
750 INPUT = @GMXAPI_PUBLIC_HEADERS@
751
752 # This tag can be used to specify the character encoding of the source files
753 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
754 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
755 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
756 # possible encodings.
757 # The default value is: UTF-8.
758
759 INPUT_ENCODING = UTF-8
760
761 # If the value of the INPUT tag contains directories, you can use the
762 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
763 # *.h) to filter out the source-files in the directories.
764 #
765 # Note that for custom extensions or not directly supported extensions you also
766 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
767 # read by doxygen.
768 #
769 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
770 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
771 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
772 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
773 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
774
775 FILE_PATTERNS = *.c \
776 *.cc \
777 *.cxx \
778 *.cpp \
779 *.c++ \
780 *.java \
781 *.ii \
782 *.ixx \
783 *.ipp \
784 *.i++ \
785 *.inl \
786 *.idl \
787 *.ddl \
788 *.odl \
789 *.h \
790 *.hh \
791 *.hxx \
792 *.hpp \
793 *.h++ \
794 *.cs \
795 *.d \
796 *.php \
797 *.php4 \
798 *.php5 \
799 *.phtml \
800 *.inc \
801 *.m \
802 *.markdown \
803 *.md \
804 *.mm \
805 *.dox \
806 *.py \
807 *.pyw \
808 *.f90 \
809 *.f95 \
810 *.f03 \
811 *.f08 \
812 *.f \
813 *.for \
814 *.tcl \
815 *.vhd \
816 *.vhdl \
817 *.ucf \
818 *.qsf
819
820 # The RECURSIVE tag can be used to specify whether or not subdirectories should
821 # be searched for input files as well.
822 # The default value is: NO.
823
824 RECURSIVE = YES
825
826 # The EXCLUDE tag can be used to specify files and/or directories that should be
827 # excluded from the INPUT source files. This way you can easily exclude a
828 # subdirectory from a directory tree whose root is specified with the INPUT tag.
829 #
830 # Note that relative paths are relative to the directory from which doxygen is
831 # run.
832
833 EXCLUDE =
834
835 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
836 # directories that are symbolic links (a Unix file system feature) are excluded
837 # from the input.
838 # The default value is: NO.
839
840 EXCLUDE_SYMLINKS = NO
841
842 # If the value of the INPUT tag contains directories, you can use the
843 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
844 # certain files from those directories.
845 #
846 # Note that the wildcards are matched against the file with absolute path, so to
847 # exclude all test directories for example use the pattern */test/*
848
849 EXCLUDE_PATTERNS = *cmakein*
850
851 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
852 # (namespaces, classes, functions, etc.) that should be excluded from the
853 # output. The symbol name can be a fully qualified name, a word, or if the
854 # wildcard * is used, a substring. Examples: ANamespace, AClass,
855 # AClass::ANamespace, ANamespace::*Test
856 #
857 # Note that the wildcards are matched against the file with absolute path, so to
858 # exclude all test directories use the pattern */test/*
859
860 EXCLUDE_SYMBOLS =
861
862 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
863 # that contain example code fragments that are included (see the \include
864 # command).
865
866 EXAMPLE_PATH =
867
868 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
869 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
870 # *.h) to filter out the source-files in the directories. If left blank all
871 # files are included.
872
873 EXAMPLE_PATTERNS = *
874
875 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
876 # searched for input files to be used with the \include or \dontinclude commands
877 # irrespective of the value of the RECURSIVE tag.
878 # The default value is: NO.
879
880 EXAMPLE_RECURSIVE = NO
881
882 # The IMAGE_PATH tag can be used to specify one or more files or directories
883 # that contain images that are to be included in the documentation (see the
884 # \image command).
885
886 IMAGE_PATH =
887
888 # The INPUT_FILTER tag can be used to specify a program that doxygen should
889 # invoke to filter for each input file. Doxygen will invoke the filter program
890 # by executing (via popen()) the command:
891 #
892 # <filter> <input-file>
893 #
894 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
895 # name of an input file. Doxygen will then use the output that the filter
896 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
897 # will be ignored.
898 #
899 # Note that the filter must not add or remove lines; it is applied before the
900 # code is scanned, but not when the output code is generated. If lines are added
901 # or removed, the anchors will not be placed correctly.
902 #
903 # Note that for custom extensions or not directly supported extensions you also
904 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
905 # properly processed by doxygen.
906
907 INPUT_FILTER =
908
909 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
910 # basis. Doxygen will compare the file name with each pattern and apply the
911 # filter if there is a match. The filters are a list of the form: pattern=filter
912 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
913 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
914 # patterns match the file name, INPUT_FILTER is applied.
915 #
916 # Note that for custom extensions or not directly supported extensions you also
917 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
918 # properly processed by doxygen.
919
920 FILTER_PATTERNS =
921
922 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
923 # INPUT_FILTER) will also be used to filter the input files that are used for
924 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
925 # The default value is: NO.
926
927 FILTER_SOURCE_FILES = NO
928
929 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
930 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
931 # it is also possible to disable source filtering for a specific pattern using
932 # *.ext= (so without naming a filter).
933 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
934
935 FILTER_SOURCE_PATTERNS =
936
937 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
938 # is part of the input, its contents will be placed on the main page
939 # (index.html). This can be useful if you have a project on for instance GitHub
940 # and want to reuse the introduction page also for the doxygen output.
941
942 USE_MDFILE_AS_MAINPAGE =
943
944 #---------------------------------------------------------------------------
945 # Configuration options related to source browsing
946 #---------------------------------------------------------------------------
947
948 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
949 # generated. Documented entities will be cross-referenced with these sources.
950 #
951 # Note: To get rid of all source code in the generated output, make sure that
952 # also VERBATIM_HEADERS is set to NO.
953 # The default value is: NO.
954
955 SOURCE_BROWSER = NO
956
957 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
958 # classes and enums directly into the documentation.
959 # The default value is: NO.
960
961 INLINE_SOURCES = NO
962
963 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
964 # special comment blocks from generated source code fragments. Normal C, C++ and
965 # Fortran comments will always remain visible.
966 # The default value is: YES.
967
968 STRIP_CODE_COMMENTS = YES
969
970 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
971 # function all documented functions referencing it will be listed.
972 # The default value is: NO.
973
974 REFERENCED_BY_RELATION = NO
975
976 # If the REFERENCES_RELATION tag is set to YES then for each documented function
977 # all documented entities called/used by that function will be listed.
978 # The default value is: NO.
979
980 REFERENCES_RELATION = NO
981
982 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
983 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
984 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
985 # link to the documentation.
986 # The default value is: YES.
987
988 REFERENCES_LINK_SOURCE = YES
989
990 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
991 # source code will show a tooltip with additional information such as prototype,
992 # brief description and links to the definition and documentation. Since this
993 # will make the HTML file larger and loading of large files a bit slower, you
994 # can opt to disable this feature.
995 # The default value is: YES.
996 # This tag requires that the tag SOURCE_BROWSER is set to YES.
997
998 SOURCE_TOOLTIPS = YES
999
1000 # If the USE_HTAGS tag is set to YES then the references to source code will
1001 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1002 # source browser. The htags tool is part of GNU's global source tagging system
1003 # (see http://www.gnu.org/software/global/global.html). You will need version
1004 # 4.8.6 or higher.
1005 #
1006 # To use it do the following:
1007 # - Install the latest version of global
1008 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1009 # - Make sure the INPUT points to the root of the source tree
1010 # - Run doxygen as normal
1011 #
1012 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1013 # tools must be available from the command line (i.e. in the search path).
1014 #
1015 # The result: instead of the source browser generated by doxygen, the links to
1016 # source code will now point to the output of htags.
1017 # The default value is: NO.
1018 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1019
1020 USE_HTAGS = NO
1021
1022 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1023 # verbatim copy of the header file for each class for which an include is
1024 # specified. Set to NO to disable this.
1025 # See also: Section \class.
1026 # The default value is: YES.
1027
1028 VERBATIM_HEADERS = YES
1029
1030 #---------------------------------------------------------------------------
1031 # Configuration options related to the alphabetical class index
1032 #---------------------------------------------------------------------------
1033
1034 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1035 # compounds will be generated. Enable this if the project contains a lot of
1036 # classes, structs, unions or interfaces.
1037 # The default value is: YES.
1038
1039 ALPHABETICAL_INDEX = YES
1040
1041 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1042 # which the alphabetical index list will be split.
1043 # Minimum value: 1, maximum value: 20, default value: 5.
1044 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1045
1046 COLS_IN_ALPHA_INDEX = 5
1047
1048 # In case all classes in a project start with a common prefix, all classes will
1049 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1050 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1051 # while generating the index headers.
1052 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1053
1054 IGNORE_PREFIX =
1055
1056 #---------------------------------------------------------------------------
1057 # Configuration options related to the HTML output
1058 #---------------------------------------------------------------------------
1059
1060 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1061 # The default value is: YES.
1062
1063 GENERATE_HTML = YES
1064
1065 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1066 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1067 # it.
1068 # The default directory is: html.
1069 # This tag requires that the tag GENERATE_HTML is set to YES.
1070
1071 HTML_OUTPUT = html
1072
1073 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1074 # generated HTML page (for example: .htm, .php, .asp).
1075 # The default value is: .html.
1076 # This tag requires that the tag GENERATE_HTML is set to YES.
1077
1078 HTML_FILE_EXTENSION = .html
1079
1080 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1081 # each generated HTML page. If the tag is left blank doxygen will generate a
1082 # standard header.
1083 #
1084 # To get valid HTML the header file that includes any scripts and style sheets
1085 # that doxygen needs, which is dependent on the configuration options used (e.g.
1086 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1087 # default header using
1088 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1089 # YourConfigFile
1090 # and then modify the file new_header.html. See also section "Doxygen usage"
1091 # for information on how to generate the default header that doxygen normally
1092 # uses.
1093 # Note: The header is subject to change so you typically have to regenerate the
1094 # default header when upgrading to a newer version of doxygen. For a description
1095 # of the possible markers and block names see the documentation.
1096 # This tag requires that the tag GENERATE_HTML is set to YES.
1097
1098 HTML_HEADER =
1099
1100 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1101 # generated HTML page. If the tag is left blank doxygen will generate a standard
1102 # footer. See HTML_HEADER for more information on how to generate a default
1103 # footer and what special commands can be used inside the footer. See also
1104 # section "Doxygen usage" for information on how to generate the default footer
1105 # that doxygen normally uses.
1106 # This tag requires that the tag GENERATE_HTML is set to YES.
1107
1108 HTML_FOOTER =
1109
1110 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1111 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1112 # the HTML output. If left blank doxygen will generate a default style sheet.
1113 # See also section "Doxygen usage" for information on how to generate the style
1114 # sheet that doxygen normally uses.
1115 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1116 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1117 # obsolete.
1118 # This tag requires that the tag GENERATE_HTML is set to YES.
1119
1120 HTML_STYLESHEET =
1121
1122 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1123 # cascading style sheets that are included after the standard style sheets
1124 # created by doxygen. Using this option one can overrule certain style aspects.
1125 # This is preferred over using HTML_STYLESHEET since it does not replace the
1126 # standard style sheet and is therefore more robust against future updates.
1127 # Doxygen will copy the style sheet files to the output directory.
1128 # Note: The order of the extra style sheet files is of importance (e.g. the last
1129 # style sheet in the list overrules the setting of the previous ones in the
1130 # list). For an example see the documentation.
1131 # This tag requires that the tag GENERATE_HTML is set to YES.
1132
1133 HTML_EXTRA_STYLESHEET =
1134
1135 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1136 # other source files which should be copied to the HTML output directory. Note
1137 # that these files will be copied to the base HTML output directory. Use the
1138 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1139 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1140 # files will be copied as-is; there are no commands or markers available.
1141 # This tag requires that the tag GENERATE_HTML is set to YES.
1142
1143 HTML_EXTRA_FILES =
1144
1145 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1146 # will adjust the colors in the style sheet and background images according to
1147 # this color. Hue is specified as an angle on a colorwheel, see
1148 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1149 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1150 # purple, and 360 is red again.
1151 # Minimum value: 0, maximum value: 359, default value: 220.
1152 # This tag requires that the tag GENERATE_HTML is set to YES.
1153
1154 HTML_COLORSTYLE_HUE = 220
1155
1156 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1157 # in the HTML output. For a value of 0 the output will use grayscales only. A
1158 # value of 255 will produce the most vivid colors.
1159 # Minimum value: 0, maximum value: 255, default value: 100.
1160 # This tag requires that the tag GENERATE_HTML is set to YES.
1161
1162 HTML_COLORSTYLE_SAT = 100
1163
1164 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1165 # luminance component of the colors in the HTML output. Values below 100
1166 # gradually make the output lighter, whereas values above 100 make the output
1167 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1168 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1169 # change the gamma.
1170 # Minimum value: 40, maximum value: 240, default value: 80.
1171 # This tag requires that the tag GENERATE_HTML is set to YES.
1172
1173 HTML_COLORSTYLE_GAMMA = 80
1174
1175 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1176 # page will contain the date and time when the page was generated. Setting this
1177 # to YES can help to show when doxygen was last run and thus if the
1178 # documentation is up to date.
1179 # The default value is: NO.
1180 # This tag requires that the tag GENERATE_HTML is set to YES.
1181
1182 HTML_TIMESTAMP = NO
1183
1184 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1185 # documentation will contain sections that can be hidden and shown after the
1186 # page has loaded.
1187 # The default value is: NO.
1188 # This tag requires that the tag GENERATE_HTML is set to YES.
1189
1190 HTML_DYNAMIC_SECTIONS = NO
1191
1192 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1193 # shown in the various tree structured indices initially; the user can expand
1194 # and collapse entries dynamically later on. Doxygen will expand the tree to
1195 # such a level that at most the specified number of entries are visible (unless
1196 # a fully collapsed tree already exceeds this amount). So setting the number of
1197 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1198 # representing an infinite number of entries and will result in a full expanded
1199 # tree by default.
1200 # Minimum value: 0, maximum value: 9999, default value: 100.
1201 # This tag requires that the tag GENERATE_HTML is set to YES.
1202
1203 HTML_INDEX_NUM_ENTRIES = 100
1204
1205 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1206 # generated that can be used as input for Apple's Xcode 3 integrated development
1207 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1208 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1209 # Makefile in the HTML output directory. Running make will produce the docset in
1210 # that directory and running make install will install the docset in
1211 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1212 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1213 # for more information.
1214 # The default value is: NO.
1215 # This tag requires that the tag GENERATE_HTML is set to YES.
1216
1217 GENERATE_DOCSET = NO
1218
1219 # This tag determines the name of the docset feed. A documentation feed provides
1220 # an umbrella under which multiple documentation sets from a single provider
1221 # (such as a company or product suite) can be grouped.
1222 # The default value is: Doxygen generated docs.
1223 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1224
1225 DOCSET_FEEDNAME = "Doxygen generated docs"
1226
1227 # This tag specifies a string that should uniquely identify the documentation
1228 # set bundle. This should be a reverse domain-name style string, e.g.
1229 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1230 # The default value is: org.doxygen.Project.
1231 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1232
1233 DOCSET_BUNDLE_ID = org.doxygen.Project
1234
1235 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1236 # the documentation publisher. This should be a reverse domain-name style
1237 # string, e.g. com.mycompany.MyDocSet.documentation.
1238 # The default value is: org.doxygen.Publisher.
1239 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1240
1241 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1242
1243 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1244 # The default value is: Publisher.
1245 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1246
1247 DOCSET_PUBLISHER_NAME = Publisher
1248
1249 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1250 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1251 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1252 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1253 # Windows.
1254 #
1255 # The HTML Help Workshop contains a compiler that can convert all HTML output
1256 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1257 # files are now used as the Windows 98 help format, and will replace the old
1258 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1259 # HTML files also contain an index, a table of contents, and you can search for
1260 # words in the documentation. The HTML workshop also contains a viewer for
1261 # compressed HTML files.
1262 # The default value is: NO.
1263 # This tag requires that the tag GENERATE_HTML is set to YES.
1264
1265 GENERATE_HTMLHELP = NO
1266
1267 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1268 # file. You can add a path in front of the file if the result should not be
1269 # written to the html output directory.
1270 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1271
1272 CHM_FILE =
1273
1274 # The HHC_LOCATION tag can be used to specify the location (absolute path
1275 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1276 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1277 # The file has to be specified with full path.
1278 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1279
1280 HHC_LOCATION =
1281
1282 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1283 # (YES) or that it should be included in the master .chm file (NO).
1284 # The default value is: NO.
1285 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1286
1287 GENERATE_CHI = NO
1288
1289 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1290 # and project file content.
1291 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1292
1293 CHM_INDEX_ENCODING =
1294
1295 # The BINARY_TOC flag controls whether a binary table of contents is generated
1296 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1297 # enables the Previous and Next buttons.
1298 # The default value is: NO.
1299 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1300
1301 BINARY_TOC = NO
1302
1303 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1304 # the table of contents of the HTML help documentation and to the tree view.
1305 # The default value is: NO.
1306 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1307
1308 TOC_EXPAND = NO
1309
1310 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1311 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1312 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1313 # (.qch) of the generated HTML documentation.
1314 # The default value is: NO.
1315 # This tag requires that the tag GENERATE_HTML is set to YES.
1316
1317 GENERATE_QHP = NO
1318
1319 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1320 # the file name of the resulting .qch file. The path specified is relative to
1321 # the HTML output folder.
1322 # This tag requires that the tag GENERATE_QHP is set to YES.
1323
1324 QCH_FILE =
1325
1326 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1327 # Project output. For more information please see Qt Help Project / Namespace
1328 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1329 # The default value is: org.doxygen.Project.
1330 # This tag requires that the tag GENERATE_QHP is set to YES.
1331
1332 QHP_NAMESPACE = org.doxygen.Project
1333
1334 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1335 # Help Project output. For more information please see Qt Help Project / Virtual
1336 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1337 # folders).
1338 # The default value is: doc.
1339 # This tag requires that the tag GENERATE_QHP is set to YES.
1340
1341 QHP_VIRTUAL_FOLDER = doc
1342
1343 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1344 # filter to add. For more information please see Qt Help Project / Custom
1345 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1346 # filters).
1347 # This tag requires that the tag GENERATE_QHP is set to YES.
1348
1349 QHP_CUST_FILTER_NAME =
1350
1351 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1352 # custom filter to add. For more information please see Qt Help Project / Custom
1353 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1354 # filters).
1355 # This tag requires that the tag GENERATE_QHP is set to YES.
1356
1357 QHP_CUST_FILTER_ATTRS =
1358
1359 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1360 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1361 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1362 # This tag requires that the tag GENERATE_QHP is set to YES.
1363
1364 QHP_SECT_FILTER_ATTRS =
1365
1366 # The QHG_LOCATION tag can be used to specify the location of Qt's
1367 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1368 # generated .qhp file.
1369 # This tag requires that the tag GENERATE_QHP is set to YES.
1370
1371 QHG_LOCATION =
1372
1373 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1374 # generated, together with the HTML files, they form an Eclipse help plugin. To
1375 # install this plugin and make it available under the help contents menu in
1376 # Eclipse, the contents of the directory containing the HTML and XML files needs
1377 # to be copied into the plugins directory of eclipse. The name of the directory
1378 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1379 # After copying Eclipse needs to be restarted before the help appears.
1380 # The default value is: NO.
1381 # This tag requires that the tag GENERATE_HTML is set to YES.
1382
1383 GENERATE_ECLIPSEHELP = NO
1384
1385 # A unique identifier for the Eclipse help plugin. When installing the plugin
1386 # the directory name containing the HTML and XML files should also have this
1387 # name. Each documentation set should have its own identifier.
1388 # The default value is: org.doxygen.Project.
1389 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1390
1391 ECLIPSE_DOC_ID = org.doxygen.Project
1392
1393 # If you want full control over the layout of the generated HTML pages it might
1394 # be necessary to disable the index and replace it with your own. The
1395 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1396 # of each HTML page. A value of NO enables the index and the value YES disables
1397 # it. Since the tabs in the index contain the same information as the navigation
1398 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1399 # The default value is: NO.
1400 # This tag requires that the tag GENERATE_HTML is set to YES.
1401
1402 DISABLE_INDEX = NO
1403
1404 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1405 # structure should be generated to display hierarchical information. If the tag
1406 # value is set to YES, a side panel will be generated containing a tree-like
1407 # index structure (just like the one that is generated for HTML Help). For this
1408 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1409 # (i.e. any modern browser). Windows users are probably better off using the
1410 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1411 # further fine-tune the look of the index. As an example, the default style
1412 # sheet generated by doxygen has an example that shows how to put an image at
1413 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1414 # the same information as the tab index, you could consider setting
1415 # DISABLE_INDEX to YES when enabling this option.
1416 # The default value is: NO.
1417 # This tag requires that the tag GENERATE_HTML is set to YES.
1418
1419 GENERATE_TREEVIEW = NO
1420
1421 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1422 # doxygen will group on one line in the generated HTML documentation.
1423 #
1424 # Note that a value of 0 will completely suppress the enum values from appearing
1425 # in the overview section.
1426 # Minimum value: 0, maximum value: 20, default value: 4.
1427 # This tag requires that the tag GENERATE_HTML is set to YES.
1428
1429 ENUM_VALUES_PER_LINE = 4
1430
1431 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1432 # to set the initial width (in pixels) of the frame in which the tree is shown.
1433 # Minimum value: 0, maximum value: 1500, default value: 250.
1434 # This tag requires that the tag GENERATE_HTML is set to YES.
1435
1436 TREEVIEW_WIDTH = 250
1437
1438 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1439 # external symbols imported via tag files in a separate window.
1440 # The default value is: NO.
1441 # This tag requires that the tag GENERATE_HTML is set to YES.
1442
1443 EXT_LINKS_IN_WINDOW = NO
1444
1445 # Use this tag to change the font size of LaTeX formulas included as images in
1446 # the HTML documentation. When you change the font size after a successful
1447 # doxygen run you need to manually remove any form_*.png images from the HTML
1448 # output directory to force them to be regenerated.
1449 # Minimum value: 8, maximum value: 50, default value: 10.
1450 # This tag requires that the tag GENERATE_HTML is set to YES.
1451
1452 FORMULA_FONTSIZE = 10
1453
1454 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1455 # generated for formulas are transparent PNGs. Transparent PNGs are not
1456 # supported properly for IE 6.0, but are supported on all modern browsers.
1457 #
1458 # Note that when changing this option you need to delete any form_*.png files in
1459 # the HTML output directory before the changes have effect.
1460 # The default value is: YES.
1461 # This tag requires that the tag GENERATE_HTML is set to YES.
1462
1463 FORMULA_TRANSPARENT = YES
1464
1465 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1466 # http://www.mathjax.org) which uses client side Javascript for the rendering
1467 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1468 # installed or if you want to formulas look prettier in the HTML output. When
1469 # enabled you may also need to install MathJax separately and configure the path
1470 # to it using the MATHJAX_RELPATH option.
1471 # The default value is: NO.
1472 # This tag requires that the tag GENERATE_HTML is set to YES.
1473
1474 USE_MATHJAX = NO
1475
1476 # When MathJax is enabled you can set the default output format to be used for
1477 # the MathJax output. See the MathJax site (see:
1478 # http://docs.mathjax.org/en/latest/output.html) for more details.
1479 # Possible values are: HTML-CSS (which is slower, but has the best
1480 # compatibility), NativeMML (i.e. MathML) and SVG.
1481 # The default value is: HTML-CSS.
1482 # This tag requires that the tag USE_MATHJAX is set to YES.
1483
1484 MATHJAX_FORMAT = HTML-CSS
1485
1486 # When MathJax is enabled you need to specify the location relative to the HTML
1487 # output directory using the MATHJAX_RELPATH option. The destination directory
1488 # should contain the MathJax.js script. For instance, if the mathjax directory
1489 # is located at the same level as the HTML output directory, then
1490 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1491 # Content Delivery Network so you can quickly see the result without installing
1492 # MathJax. However, it is strongly recommended to install a local copy of
1493 # MathJax from http://www.mathjax.org before deployment.
1494 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1495 # This tag requires that the tag USE_MATHJAX is set to YES.
1496
1497 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1498
1499 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1500 # extension names that should be enabled during MathJax rendering. For example
1501 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1502 # This tag requires that the tag USE_MATHJAX is set to YES.
1503
1504 MATHJAX_EXTENSIONS =
1505
1506 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1507 # of code that will be used on startup of the MathJax code. See the MathJax site
1508 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1509 # example see the documentation.
1510 # This tag requires that the tag USE_MATHJAX is set to YES.
1511
1512 MATHJAX_CODEFILE =
1513
1514 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1515 # the HTML output. The underlying search engine uses javascript and DHTML and
1516 # should work on any modern browser. Note that when using HTML help
1517 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1518 # there is already a search function so this one should typically be disabled.
1519 # For large projects the javascript based search engine can be slow, then
1520 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1521 # search using the keyboard; to jump to the search box use <access key> + S
1522 # (what the <access key> is depends on the OS and browser, but it is typically
1523 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1524 # key> to jump into the search results window, the results can be navigated
1525 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1526 # the search. The filter options can be selected when the cursor is inside the
1527 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1528 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1529 # option.
1530 # The default value is: YES.
1531 # This tag requires that the tag GENERATE_HTML is set to YES.
1532
1533 SEARCHENGINE = YES
1534
1535 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1536 # implemented using a web server instead of a web client using Javascript. There
1537 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1538 # setting. When disabled, doxygen will generate a PHP script for searching and
1539 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1540 # and searching needs to be provided by external tools. See the section
1541 # "External Indexing and Searching" for details.
1542 # The default value is: NO.
1543 # This tag requires that the tag SEARCHENGINE is set to YES.
1544
1545 SERVER_BASED_SEARCH = NO
1546
1547 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1548 # script for searching. Instead the search results are written to an XML file
1549 # which needs to be processed by an external indexer. Doxygen will invoke an
1550 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1551 # search results.
1552 #
1553 # Doxygen ships with an example indexer (doxyindexer) and search engine
1554 # (doxysearch.cgi) which are based on the open source search engine library
1555 # Xapian (see: http://xapian.org/).
1556 #
1557 # See the section "External Indexing and Searching" for details.
1558 # The default value is: NO.
1559 # This tag requires that the tag SEARCHENGINE is set to YES.
1560
1561 EXTERNAL_SEARCH = NO
1562
1563 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1564 # which will return the search results when EXTERNAL_SEARCH is enabled.
1565 #
1566 # Doxygen ships with an example indexer (doxyindexer) and search engine
1567 # (doxysearch.cgi) which are based on the open source search engine library
1568 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1569 # Searching" for details.
1570 # This tag requires that the tag SEARCHENGINE is set to YES.
1571
1572 SEARCHENGINE_URL =
1573
1574 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1575 # search data is written to a file for indexing by an external tool. With the
1576 # SEARCHDATA_FILE tag the name of this file can be specified.
1577 # The default file is: searchdata.xml.
1578 # This tag requires that the tag SEARCHENGINE is set to YES.
1579
1580 SEARCHDATA_FILE = searchdata.xml
1581
1582 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1583 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1584 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1585 # projects and redirect the results back to the right project.
1586 # This tag requires that the tag SEARCHENGINE is set to YES.
1587
1588 EXTERNAL_SEARCH_ID =
1589
1590 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1591 # projects other than the one defined by this configuration file, but that are
1592 # all added to the same external search index. Each project needs to have a
1593 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1594 # to a relative location where the documentation can be found. The format is:
1595 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1596 # This tag requires that the tag SEARCHENGINE is set to YES.
1597
1598 EXTRA_SEARCH_MAPPINGS =
1599
1600 #---------------------------------------------------------------------------
1601 # Configuration options related to the LaTeX output
1602 #---------------------------------------------------------------------------
1603
1604 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1605 # The default value is: YES.
1606
1607 GENERATE_LATEX = NO
1608
1609 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1610 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1611 # it.
1612 # The default directory is: latex.
1613 # This tag requires that the tag GENERATE_LATEX is set to YES.
1614
1615 LATEX_OUTPUT = latex
1616
1617 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1618 # invoked.
1619 #
1620 # Note that when enabling USE_PDFLATEX this option is only used for generating
1621 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1622 # written to the output directory.
1623 # The default file is: latex.
1624 # This tag requires that the tag GENERATE_LATEX is set to YES.
1625
1626 LATEX_CMD_NAME = latex
1627
1628 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1629 # index for LaTeX.
1630 # The default file is: makeindex.
1631 # This tag requires that the tag GENERATE_LATEX is set to YES.
1632
1633 MAKEINDEX_CMD_NAME = makeindex
1634
1635 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1636 # documents. This may be useful for small projects and may help to save some
1637 # trees in general.
1638 # The default value is: NO.
1639 # This tag requires that the tag GENERATE_LATEX is set to YES.
1640
1641 COMPACT_LATEX = NO
1642
1643 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1644 # printer.
1645 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1646 # 14 inches) and executive (7.25 x 10.5 inches).
1647 # The default value is: a4.
1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
1649
1650 PAPER_TYPE = a4
1651
1652 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1653 # that should be included in the LaTeX output. The package can be specified just
1654 # by its name or with the correct syntax as to be used with the LaTeX
1655 # \usepackage command. To get the times font for instance you can specify :
1656 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1657 # To use the option intlimits with the amsmath package you can specify:
1658 # EXTRA_PACKAGES=[intlimits]{amsmath}
1659 # If left blank no extra packages will be included.
1660 # This tag requires that the tag GENERATE_LATEX is set to YES.
1661
1662 EXTRA_PACKAGES =
1663
1664 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1665 # generated LaTeX document. The header should contain everything until the first
1666 # chapter. If it is left blank doxygen will generate a standard header. See
1667 # section "Doxygen usage" for information on how to let doxygen write the
1668 # default header to a separate file.
1669 #
1670 # Note: Only use a user-defined header if you know what you are doing! The
1671 # following commands have a special meaning inside the header: $title,
1672 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1673 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1674 # string, for the replacement values of the other commands the user is referred
1675 # to HTML_HEADER.
1676 # This tag requires that the tag GENERATE_LATEX is set to YES.
1677
1678 LATEX_HEADER =
1679
1680 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1681 # generated LaTeX document. The footer should contain everything after the last
1682 # chapter. If it is left blank doxygen will generate a standard footer. See
1683 # LATEX_HEADER for more information on how to generate a default footer and what
1684 # special commands can be used inside the footer.
1685 #
1686 # Note: Only use a user-defined footer if you know what you are doing!
1687 # This tag requires that the tag GENERATE_LATEX is set to YES.
1688
1689 LATEX_FOOTER =
1690
1691 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1692 # other source files which should be copied to the LATEX_OUTPUT output
1693 # directory. Note that the files will be copied as-is; there are no commands or
1694 # markers available.
1695 # This tag requires that the tag GENERATE_LATEX is set to YES.
1696
1697 LATEX_EXTRA_FILES =
1698
1699 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1700 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1701 # contain links (just like the HTML output) instead of page references. This
1702 # makes the output suitable for online browsing using a PDF viewer.
1703 # The default value is: YES.
1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
1705
1706 PDF_HYPERLINKS = YES
1707
1708 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1709 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1710 # higher quality PDF documentation.
1711 # The default value is: YES.
1712 # This tag requires that the tag GENERATE_LATEX is set to YES.
1713
1714 USE_PDFLATEX = YES
1715
1716 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1717 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1718 # if errors occur, instead of asking the user for help. This option is also used
1719 # when generating formulas in HTML.
1720 # The default value is: NO.
1721 # This tag requires that the tag GENERATE_LATEX is set to YES.
1722
1723 LATEX_BATCHMODE = NO
1724
1725 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1726 # index chapters (such as File Index, Compound Index, etc.) in the output.
1727 # The default value is: NO.
1728 # This tag requires that the tag GENERATE_LATEX is set to YES.
1729
1730 LATEX_HIDE_INDICES = NO
1731
1732 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1733 # code with syntax highlighting in the LaTeX output.
1734 #
1735 # Note that which sources are shown also depends on other settings such as
1736 # SOURCE_BROWSER.
1737 # The default value is: NO.
1738 # This tag requires that the tag GENERATE_LATEX is set to YES.
1739
1740 LATEX_SOURCE_CODE = NO
1741
1742 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1743 # bibliography, e.g. plainnat, or ieeetr. See
1744 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1745 # The default value is: plain.
1746 # This tag requires that the tag GENERATE_LATEX is set to YES.
1747
1748 LATEX_BIB_STYLE = plain
1749
1750 #---------------------------------------------------------------------------
1751 # Configuration options related to the RTF output
1752 #---------------------------------------------------------------------------
1753
1754 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1755 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1756 # readers/editors.
1757 # The default value is: NO.
1758
1759 GENERATE_RTF = NO
1760
1761 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1762 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1763 # it.
1764 # The default directory is: rtf.
1765 # This tag requires that the tag GENERATE_RTF is set to YES.
1766
1767 RTF_OUTPUT = rtf
1768
1769 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1770 # documents. This may be useful for small projects and may help to save some
1771 # trees in general.
1772 # The default value is: NO.
1773 # This tag requires that the tag GENERATE_RTF is set to YES.
1774
1775 COMPACT_RTF = NO
1776
1777 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1778 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1779 # output) instead of page references. This makes the output suitable for online
1780 # browsing using Word or some other Word compatible readers that support those
1781 # fields.
1782 #
1783 # Note: WordPad (write) and others do not support links.
1784 # The default value is: NO.
1785 # This tag requires that the tag GENERATE_RTF is set to YES.
1786
1787 RTF_HYPERLINKS = NO
1788
1789 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1790 # file, i.e. a series of assignments. You only have to provide replacements,
1791 # missing definitions are set to their default value.
1792 #
1793 # See also section "Doxygen usage" for information on how to generate the
1794 # default style sheet that doxygen normally uses.
1795 # This tag requires that the tag GENERATE_RTF is set to YES.
1796
1797 RTF_STYLESHEET_FILE =
1798
1799 # Set optional variables used in the generation of an RTF document. Syntax is
1800 # similar to doxygen's config file. A template extensions file can be generated
1801 # using doxygen -e rtf extensionFile.
1802 # This tag requires that the tag GENERATE_RTF is set to YES.
1803
1804 RTF_EXTENSIONS_FILE =
1805
1806 #---------------------------------------------------------------------------
1807 # Configuration options related to the man page output
1808 #---------------------------------------------------------------------------
1809
1810 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1811 # classes and files.
1812 # The default value is: NO.
1813
1814 GENERATE_MAN = NO
1815
1816 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1817 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1818 # it. A directory man3 will be created inside the directory specified by
1819 # MAN_OUTPUT.
1820 # The default directory is: man.
1821 # This tag requires that the tag GENERATE_MAN is set to YES.
1822
1823 MAN_OUTPUT = man
1824
1825 # The MAN_EXTENSION tag determines the extension that is added to the generated
1826 # man pages. In case the manual section does not start with a number, the number
1827 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1828 # optional.
1829 # The default value is: .3.
1830 # This tag requires that the tag GENERATE_MAN is set to YES.
1831
1832 MAN_EXTENSION = .3
1833
1834 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1835 # will generate one additional man file for each entity documented in the real
1836 # man page(s). These additional files only source the real man page, but without
1837 # them the man command would be unable to find the correct page.
1838 # The default value is: NO.
1839 # This tag requires that the tag GENERATE_MAN is set to YES.
1840
1841 MAN_LINKS = NO
1842
1843 #---------------------------------------------------------------------------
1844 # Configuration options related to the XML output
1845 #---------------------------------------------------------------------------
1846
1847 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1848 # captures the structure of the code including all documentation.
1849 # The default value is: NO.
1850
1851 GENERATE_XML = YES
1852
1853 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1854 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1855 # it.
1856 # The default directory is: xml.
1857 # This tag requires that the tag GENERATE_XML is set to YES.
1858
1859 XML_OUTPUT = ./xml
1860
1861 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1862 # listings (including syntax highlighting and cross-referencing information) to
1863 # the XML output. Note that enabling this will significantly increase the size
1864 # of the XML output.
1865 # The default value is: YES.
1866 # This tag requires that the tag GENERATE_XML is set to YES.
1867
1868 XML_PROGRAMLISTING = YES
1869
1870 #---------------------------------------------------------------------------
1871 # Configuration options related to the DOCBOOK output
1872 #---------------------------------------------------------------------------
1873
1874 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1875 # that can be used to generate PDF.
1876 # The default value is: NO.
1877
1878 GENERATE_DOCBOOK = NO
1879
1880 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1881 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1882 # front of it.
1883 # The default directory is: docbook.
1884 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1885
1886 DOCBOOK_OUTPUT = docbook
1887
1888 #---------------------------------------------------------------------------
1889 # Configuration options for the AutoGen Definitions output
1890 #---------------------------------------------------------------------------
1891
1892 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1893 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1894 # structure of the code including all documentation. Note that this feature is
1895 # still experimental and incomplete at the moment.
1896 # The default value is: NO.
1897
1898 GENERATE_AUTOGEN_DEF = NO
1899
1900 #---------------------------------------------------------------------------
1901 # Configuration options related to the Perl module output
1902 #---------------------------------------------------------------------------
1903
1904 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1905 # file that captures the structure of the code including all documentation.
1906 #
1907 # Note that this feature is still experimental and incomplete at the moment.
1908 # The default value is: NO.
1909
1910 GENERATE_PERLMOD = NO
1911
1912 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1913 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1914 # output from the Perl module output.
1915 # The default value is: NO.
1916 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1917
1918 PERLMOD_LATEX = NO
1919
1920 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1921 # formatted so it can be parsed by a human reader. This is useful if you want to
1922 # understand what is going on. On the other hand, if this tag is set to NO, the
1923 # size of the Perl module output will be much smaller and Perl will parse it
1924 # just the same.
1925 # The default value is: YES.
1926 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1927
1928 PERLMOD_PRETTY = YES
1929
1930 # The names of the make variables in the generated doxyrules.make file are
1931 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1932 # so different doxyrules.make files included by the same Makefile don't
1933 # overwrite each other's variables.
1934 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1935
1936 PERLMOD_MAKEVAR_PREFIX =
1937
1938 #---------------------------------------------------------------------------
1939 # Configuration options related to the preprocessor
1940 #---------------------------------------------------------------------------
1941
1942 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1943 # C-preprocessor directives found in the sources and include files.
1944 # The default value is: YES.
1945
1946 ENABLE_PREPROCESSING = YES
1947
1948 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1949 # in the source code. If set to NO, only conditional compilation will be
1950 # performed. Macro expansion can be done in a controlled way by setting
1951 # EXPAND_ONLY_PREDEF to YES.
1952 # The default value is: NO.
1953 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1954
1955 MACRO_EXPANSION = NO
1956
1957 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1958 # the macro expansion is limited to the macros specified with the PREDEFINED and
1959 # EXPAND_AS_DEFINED tags.
1960 # The default value is: NO.
1961 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1962
1963 EXPAND_ONLY_PREDEF = NO
1964
1965 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
1966 # INCLUDE_PATH will be searched if a #include is found.
1967 # The default value is: YES.
1968 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1969
1970 SEARCH_INCLUDES = YES
1971
1972 # The INCLUDE_PATH tag can be used to specify one or more directories that
1973 # contain include files that are not input files but should be processed by the
1974 # preprocessor.
1975 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1976
1977 INCLUDE_PATH =
1978
1979 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1980 # patterns (like *.h and *.hpp) to filter out the header-files in the
1981 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1982 # used.
1983 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1984
1985 INCLUDE_FILE_PATTERNS =
1986
1987 # The PREDEFINED tag can be used to specify one or more macro names that are
1988 # defined before the preprocessor is started (similar to the -D option of e.g.
1989 # gcc). The argument of the tag is a list of macros of the form: name or
1990 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1991 # is assumed. To prevent a macro definition from being undefined via #undef or
1992 # recursively expanded use the := operator instead of the = operator.
1993 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1994
1995 PREDEFINED =
1996
1997 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1998 # tag can be used to specify a list of macro names that should be expanded. The
1999 # macro definition that is found in the sources will be used. Use the PREDEFINED
2000 # tag if you want to use a different macro definition that overrules the
2001 # definition found in the source code.
2002 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2003
2004 EXPAND_AS_DEFINED =
2005
2006 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2007 # remove all references to function-like macros that are alone on a line, have
2008 # an all uppercase name, and do not end with a semicolon. Such function macros
2009 # are typically used for boiler-plate code, and will confuse the parser if not
2010 # removed.
2011 # The default value is: YES.
2012 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2013
2014 SKIP_FUNCTION_MACROS = YES
2015
2016 #---------------------------------------------------------------------------
2017 # Configuration options related to external references
2018 #---------------------------------------------------------------------------
2019
2020 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2021 # file the location of the external documentation should be added. The format of
2022 # a tag file without this location is as follows:
2023 # TAGFILES = file1 file2 ...
2024 # Adding location for the tag files is done as follows:
2025 # TAGFILES = file1=loc1 "file2 = loc2" ...
2026 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2027 # section "Linking to external documentation" for more information about the use
2028 # of tag files.
2029 # Note: Each tag file must have a unique name (where the name does NOT include
2030 # the path). If a tag file is not located in the directory in which doxygen is
2031 # run, you must also specify the path to the tagfile here.
2032
2033 TAGFILES =
2034 # This is not the way to cross-reference the main GROMACS developer docs. To
2035 # generate and include a tagfile from GROMACS would cause the inclusion of all
2036 # of the GROMACS docs. However, we may want to produce a tagfile for easier
2037 # inclusion with the GROMACS docs using GENERATE_TAGFILE.
2038
2039 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2040 # tag file that is based on the input files it reads. See section "Linking to
2041 # external documentation" for more information about the usage of tag files.
2042
2043 GENERATE_TAGFILE =
2044
2045 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2046 # the class index. If set to NO, only the inherited external classes will be
2047 # listed.
2048 # The default value is: NO.
2049
2050 ALLEXTERNALS = NO
2051
2052 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2053 # in the modules index. If set to NO, only the current project's groups will be
2054 # listed.
2055 # The default value is: YES.
2056
2057 EXTERNAL_GROUPS = YES
2058
2059 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2060 # the related pages index. If set to NO, only the current project's pages will
2061 # be listed.
2062 # The default value is: YES.
2063
2064 EXTERNAL_PAGES = YES
2065
2066 # The PERL_PATH should be the absolute path and name of the perl script
2067 # interpreter (i.e. the result of 'which perl').
2068 # The default file (with absolute path) is: /usr/bin/perl.
2069
2070 PERL_PATH = /usr/bin/perl
2071
2072 #---------------------------------------------------------------------------
2073 # Configuration options related to the dot tool
2074 #---------------------------------------------------------------------------
2075
2076 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2077 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2078 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2079 # disabled, but it is recommended to install and use dot, since it yields more
2080 # powerful graphs.
2081 # The default value is: YES.
2082
2083 CLASS_DIAGRAMS = YES
2084
2085 # You can define message sequence charts within doxygen comments using the \msc
2086 # command. Doxygen will then run the mscgen tool (see:
2087 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2088 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2089 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2090 # default search path.
2091
2092 MSCGEN_PATH =
2093
2094 # If set to YES the inheritance and collaboration graphs will hide inheritance
2095 # and usage relations if the target is undocumented or is not a class.
2096 # The default value is: YES.
2097
2098 HIDE_UNDOC_RELATIONS = YES
2099
2100 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2101 # available from the path. This tool is part of Graphviz (see:
2102 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2103 # Bell Labs. The other options in this section have no effect if this option is
2104 # set to NO
2105 # The default value is: NO.
2106
2107 HAVE_DOT = NO
2108
2109 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2110 # to run in parallel. When set to 0 doxygen will base this on the number of
2111 # processors available in the system. You can set it explicitly to a value
2112 # larger than 0 to get control over the balance between CPU load and processing
2113 # speed.
2114 # Minimum value: 0, maximum value: 32, default value: 0.
2115 # This tag requires that the tag HAVE_DOT is set to YES.
2116
2117 DOT_NUM_THREADS = 0
2118
2119 # When you want a differently looking font in the dot files that doxygen
2120 # generates you can specify the font name using DOT_FONTNAME. You need to make
2121 # sure dot is able to find the font, which can be done by putting it in a
2122 # standard location or by setting the DOTFONTPATH environment variable or by
2123 # setting DOT_FONTPATH to the directory containing the font.
2124 # The default value is: Helvetica.
2125 # This tag requires that the tag HAVE_DOT is set to YES.
2126
2127 DOT_FONTNAME = Helvetica
2128
2129 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2130 # dot graphs.
2131 # Minimum value: 4, maximum value: 24, default value: 10.
2132 # This tag requires that the tag HAVE_DOT is set to YES.
2133
2134 DOT_FONTSIZE = 10
2135
2136 # By default doxygen will tell dot to use the default font as specified with
2137 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2138 # the path where dot can find it using this tag.
2139 # This tag requires that the tag HAVE_DOT is set to YES.
2140
2141 DOT_FONTPATH =
2142
2143 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2144 # each documented class showing the direct and indirect inheritance relations.
2145 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2146 # The default value is: YES.
2147 # This tag requires that the tag HAVE_DOT is set to YES.
2148
2149 CLASS_GRAPH = YES
2150
2151 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2152 # graph for each documented class showing the direct and indirect implementation
2153 # dependencies (inheritance, containment, and class references variables) of the
2154 # class with other documented classes.
2155 # The default value is: YES.
2156 # This tag requires that the tag HAVE_DOT is set to YES.
2157
2158 COLLABORATION_GRAPH = YES
2159
2160 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2161 # groups, showing the direct groups dependencies.
2162 # The default value is: YES.
2163 # This tag requires that the tag HAVE_DOT is set to YES.
2164
2165 GROUP_GRAPHS = YES
2166
2167 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2168 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2169 # Language.
2170 # The default value is: NO.
2171 # This tag requires that the tag HAVE_DOT is set to YES.
2172
2173 UML_LOOK = NO
2174
2175 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2176 # class node. If there are many fields or methods and many nodes the graph may
2177 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2178 # number of items for each type to make the size more manageable. Set this to 0
2179 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2180 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2181 # but if the number exceeds 15, the total amount of fields shown is limited to
2182 # 10.
2183 # Minimum value: 0, maximum value: 100, default value: 10.
2184 # This tag requires that the tag HAVE_DOT is set to YES.
2185
2186 UML_LIMIT_NUM_FIELDS = 10
2187
2188 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2189 # collaboration graphs will show the relations between templates and their
2190 # instances.
2191 # The default value is: NO.
2192 # This tag requires that the tag HAVE_DOT is set to YES.
2193
2194 TEMPLATE_RELATIONS = YES
2195
2196 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2197 # YES then doxygen will generate a graph for each documented file showing the
2198 # direct and indirect include dependencies of the file with other documented
2199 # files.
2200 # The default value is: YES.
2201 # This tag requires that the tag HAVE_DOT is set to YES.
2202
2203 INCLUDE_GRAPH = YES
2204
2205 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2206 # set to YES then doxygen will generate a graph for each documented file showing
2207 # the direct and indirect include dependencies of the file with other documented
2208 # files.
2209 # The default value is: YES.
2210 # This tag requires that the tag HAVE_DOT is set to YES.
2211
2212 INCLUDED_BY_GRAPH = YES
2213
2214 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2215 # dependency graph for every global function or class method.
2216 #
2217 # Note that enabling this option will significantly increase the time of a run.
2218 # So in most cases it will be better to enable call graphs for selected
2219 # functions only using the \callgraph command. Disabling a call graph can be
2220 # accomplished by means of the command \hidecallgraph.
2221 # The default value is: NO.
2222 # This tag requires that the tag HAVE_DOT is set to YES.
2223
2224 CALL_GRAPH = NO
2225
2226 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2227 # dependency graph for every global function or class method.
2228 #
2229 # Note that enabling this option will significantly increase the time of a run.
2230 # So in most cases it will be better to enable caller graphs for selected
2231 # functions only using the \callergraph command. Disabling a caller graph can be
2232 # accomplished by means of the command \hidecallergraph.
2233 # The default value is: NO.
2234 # This tag requires that the tag HAVE_DOT is set to YES.
2235
2236 CALLER_GRAPH = NO
2237
2238 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2239 # hierarchy of all classes instead of a textual one.
2240 # The default value is: YES.
2241 # This tag requires that the tag HAVE_DOT is set to YES.
2242
2243 GRAPHICAL_HIERARCHY = YES
2244
2245 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2246 # dependencies a directory has on other directories in a graphical way. The
2247 # dependency relations are determined by the #include relations between the
2248 # files in the directories.
2249 # The default value is: YES.
2250 # This tag requires that the tag HAVE_DOT is set to YES.
2251
2252 DIRECTORY_GRAPH = YES
2253
2254 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2255 # generated by dot. For an explanation of the image formats see the section
2256 # output formats in the documentation of the dot tool (Graphviz (see:
2257 # http://www.graphviz.org/)).
2258 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2259 # to make the SVG files visible in IE 9+ (other browsers do not have this
2260 # requirement).
2261 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2262 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2263 # png:gdiplus:gdiplus.
2264 # The default value is: png.
2265 # This tag requires that the tag HAVE_DOT is set to YES.
2266
2267 DOT_IMAGE_FORMAT = png
2268
2269 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2270 # enable generation of interactive SVG images that allow zooming and panning.
2271 #
2272 # Note that this requires a modern browser other than Internet Explorer. Tested
2273 # and working are Firefox, Chrome, Safari, and Opera.
2274 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2275 # the SVG files visible. Older versions of IE do not have SVG support.
2276 # The default value is: NO.
2277 # This tag requires that the tag HAVE_DOT is set to YES.
2278
2279 INTERACTIVE_SVG = NO
2280
2281 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2282 # found. If left blank, it is assumed the dot tool can be found in the path.
2283 # This tag requires that the tag HAVE_DOT is set to YES.
2284
2285 DOT_PATH =
2286
2287 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2288 # contain dot files that are included in the documentation (see the \dotfile
2289 # command).
2290 # This tag requires that the tag HAVE_DOT is set to YES.
2291
2292 DOTFILE_DIRS =
2293
2294 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2295 # contain msc files that are included in the documentation (see the \mscfile
2296 # command).
2297
2298 MSCFILE_DIRS =
2299
2300 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2301 # that will be shown in the graph. If the number of nodes in a graph becomes
2302 # larger than this value, doxygen will truncate the graph, which is visualized
2303 # by representing a node as a red box. Note that doxygen if the number of direct
2304 # children of the root node in a graph is already larger than
2305 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2306 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2307 # Minimum value: 0, maximum value: 10000, default value: 50.
2308 # This tag requires that the tag HAVE_DOT is set to YES.
2309
2310 DOT_GRAPH_MAX_NODES = 50
2311
2312 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2313 # generated by dot. A depth value of 3 means that only nodes reachable from the
2314 # root by following a path via at most 3 edges will be shown. Nodes that lay
2315 # further from the root node will be omitted. Note that setting this option to 1
2316 # or 2 may greatly reduce the computation time needed for large code bases. Also
2317 # note that the size of a graph can be further restricted by
2318 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2319 # Minimum value: 0, maximum value: 1000, default value: 0.
2320 # This tag requires that the tag HAVE_DOT is set to YES.
2321
2322 MAX_DOT_GRAPH_DEPTH = 0
2323
2324 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2325 # background. This is disabled by default, because dot on Windows does not seem
2326 # to support this out of the box.
2327 #
2328 # Warning: Depending on the platform used, enabling this option may lead to
2329 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2330 # read).
2331 # The default value is: NO.
2332 # This tag requires that the tag HAVE_DOT is set to YES.
2333
2334 DOT_TRANSPARENT = NO
2335
2336 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2337 # files in one run (i.e. multiple -o and -T options on the command line). This
2338 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2339 # this, this feature is disabled by default.
2340 # The default value is: NO.
2341 # This tag requires that the tag HAVE_DOT is set to YES.
2342
2343 DOT_MULTI_TARGETS = NO
2344
2345 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2346 # explaining the meaning of the various boxes and arrows in the dot generated
2347 # graphs.
2348 # The default value is: YES.
2349 # This tag requires that the tag HAVE_DOT is set to YES.
2350
2351 GENERATE_LEGEND = YES
2352
2353 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2354 # files that are used to generate the various graphs.
2355 # The default value is: YES.
2356 # This tag requires that the tag HAVE_DOT is set to YES.
2357
2358 DOT_CLEANUP = YES