0.9.6: man.doxy Source File

| 0.9.6

- Main Page
- Modules
- Files

- File List

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