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