3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
6 # All text after a double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
9 # All text after a single hash (#) is considered a comment and will be ignored.
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 (\" \").
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
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.
27 DOXYFILE_ENCODING = UTF-8
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.
35 PROJECT_NAME = "ParaViS Module v.@SALOMEPARAVIS_VERSION@"
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.
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.
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.
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.
61 OUTPUT_DIRECTORY = doc_api
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.
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
77 # The default value is: NO.
79 ALLOW_UNICODE_NAMES = NO
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.
94 OUTPUT_LANGUAGE = English
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.
101 BRIEF_MEMBER_DESC = YES
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
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.
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.
123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124 # doxygen will generate a detailed section even if there is only a brief
126 # The default value is: NO.
128 ALWAYS_DETAILED_SEC = YES
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131 # inherited members of a class in the documentation of that class as if those
132 # members were ordinary class members. Constructors, destructors and assignment
133 # operators of the base classes will not be shown.
134 # The default value is: NO.
136 INLINE_INHERITED_MEMB = YES
138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139 # before files name in the file list and in the header files. If set to NO the
140 # shortest path that makes the file name unique will be used
141 # The default value is: YES.
143 FULL_PATH_NAMES = YES
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146 # Stripping is only done if one of the specified strings matches the left-hand
147 # part of the path. The tag can be used to show relative paths in the file list.
148 # If left blank the directory from which doxygen is run is used as the path to
151 # Note that you can specify absolute paths here, but also relative paths, which
152 # will be relative from the directory where doxygen is started.
153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
155 STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ \
158 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
159 # path mentioned in the documentation of a class, which tells the reader which
160 # header file to include in order to use a class. If left blank only the name of
161 # the header file containing the class definition is used. Otherwise one should
162 # specify the list of include paths that are normally passed to the compiler
165 STRIP_FROM_INC_PATH =
167 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
168 # less readable) file names. This can be useful is your file systems doesn't
169 # support long names like on DOS, Mac, or CD-ROM.
170 # The default value is: NO.
174 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
175 # first line (until the first dot) of a Javadoc-style comment as the brief
176 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
177 # style comments (thus requiring an explicit @brief command for a brief
179 # The default value is: NO.
181 JAVADOC_AUTOBRIEF = YES
183 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
184 # line (until the first dot) of a Qt-style comment as the brief description. If
185 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
186 # requiring an explicit \brief command for a brief description.)
187 # The default value is: NO.
191 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
192 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
193 # a brief description. This used to be the default behavior. The new default is
194 # to treat a multi-line C++ comment block as a detailed description. Set this
195 # tag to YES if you prefer the old behavior instead.
197 # Note that setting this tag to YES also means that rational rose comments are
198 # not recognized any more.
199 # The default value is: NO.
201 MULTILINE_CPP_IS_BRIEF = NO
203 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
204 # documentation from any documented member that it re-implements.
205 # The default value is: YES.
209 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
210 # new page for each member. If set to NO, the documentation of a member will be
211 # part of the file/class/namespace that contains it.
212 # The default value is: NO.
214 SEPARATE_MEMBER_PAGES = NO
216 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
217 # uses this value to replace tabs by spaces in code fragments.
218 # Minimum value: 1, maximum value: 16, default value: 4.
222 # This tag can be used to specify a number of aliases that act as commands in
223 # the documentation. An alias has the form:
226 # "sideeffect=@par Side Effects:\n"
227 # will allow you to put the command \sideeffect (or @sideeffect) in the
228 # documentation, which will result in a user-defined paragraph with heading
229 # "Side Effects:". You can put \n's in the value part of an alias to insert
234 # This tag can be used to specify a number of word-keyword mappings (TCL only).
235 # A mapping has the form "name=value". For example adding "class=itcl::class"
236 # will allow you to use the command class in the itcl::class meaning.
240 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
241 # only. Doxygen will then generate output that is more tailored for C. For
242 # instance, some of the names that are used will be different. The list of all
243 # members will be omitted, etc.
244 # The default value is: NO.
246 OPTIMIZE_OUTPUT_FOR_C = YES
248 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
249 # Python sources only. Doxygen will then generate output that is more tailored
250 # for that language. For instance, namespaces will be presented as packages,
251 # qualified scopes will look different, etc.
252 # The default value is: NO.
254 OPTIMIZE_OUTPUT_JAVA = YES
256 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
257 # sources. Doxygen will then generate output that is tailored for Fortran.
258 # The default value is: NO.
260 OPTIMIZE_FOR_FORTRAN = NO
262 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
263 # sources. Doxygen will then generate output that is tailored for VHDL.
264 # The default value is: NO.
266 OPTIMIZE_OUTPUT_VHDL = NO
268 # Doxygen selects the parser to use depending on the extension of the files it
269 # parses. With this tag you can assign which parser to use for a given
270 # extension. Doxygen has a built-in mapping, but you can override or extend it
271 # using this tag. The format is ext=language, where ext is a file extension, and
272 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
273 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
274 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
275 # Fortran. In the later case the parser tries to guess whether the code is fixed
276 # or free formatted code, this is the default for Fortran type files), VHDL. For
277 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
278 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
280 # Note For files without extension you can use no_extension as a placeholder.
282 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
283 # the files are not read by doxygen.
287 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
288 # according to the Markdown format, which allows for more readable
289 # documentation. See http://daringfireball.net/projects/markdown/ for details.
290 # The output of markdown processing is further processed by doxygen, so you can
291 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
292 # case of backward compatibilities issues.
293 # The default value is: YES.
295 MARKDOWN_SUPPORT = YES
297 # When enabled doxygen tries to link words that correspond to documented
298 # classes, or namespaces to their corresponding documentation. Such a link can
299 # be prevented in individual cases by by putting a % sign in front of the word
300 # or globally by setting AUTOLINK_SUPPORT to NO.
301 # The default value is: YES.
303 AUTOLINK_SUPPORT = YES
305 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
306 # to include (a tag file for) the STL sources as input, then you should set this
307 # tag to YES in order to let doxygen match functions declarations and
308 # definitions whose arguments contain STL classes (e.g. func(std::string);
309 # versus func(std::string) {}). This also make the inheritance and collaboration
310 # diagrams that involve STL classes more complete and accurate.
311 # The default value is: NO.
313 BUILTIN_STL_SUPPORT = @DOXYGEN_SUPPORT_STL@
315 # If you use Microsoft's C++/CLI language, you should set this option to YES to
316 # enable parsing support.
317 # The default value is: NO.
321 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
322 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
323 # will parse them like normal C++ but will assume all classes use public instead
324 # of private inheritance when no explicit protection keyword is present.
325 # The default value is: NO.
329 # For Microsoft's IDL there are propget and propput attributes to indicate
330 # getter and setter methods for a property. Setting this option to YES will make
331 # doxygen to replace the get and set methods by a property in the documentation.
332 # This will only work if the methods are indeed getting or setting a simple
333 # type. If this is not the case, or you want to show the methods anyway, you
334 # should set this option to NO.
335 # The default value is: YES.
337 IDL_PROPERTY_SUPPORT = YES
339 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
340 # tag is set to YES, then doxygen will reuse the documentation of the first
341 # member in the group (if any) for the other members of the group. By default
342 # all members of a group must be documented explicitly.
343 # The default value is: NO.
345 DISTRIBUTE_GROUP_DOC = NO
347 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
348 # (for instance a group of public functions) to be put as a subgroup of that
349 # type (e.g. under the Public Functions section). Set it to NO to prevent
350 # subgrouping. Alternatively, this can be done per class using the
351 # \nosubgrouping command.
352 # The default value is: YES.
356 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
357 # are shown inside the group in which they are included (e.g. using \ingroup)
358 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
361 # Note that this feature does not work in combination with
362 # SEPARATE_MEMBER_PAGES.
363 # The default value is: NO.
365 INLINE_GROUPED_CLASSES = NO
367 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
368 # with only public data fields or simple typedef fields will be shown inline in
369 # the documentation of the scope in which they are defined (i.e. file,
370 # namespace, or group documentation), provided this scope is documented. If set
371 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
372 # Man pages) or section (for LaTeX and RTF).
373 # The default value is: NO.
375 INLINE_SIMPLE_STRUCTS = NO
377 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
378 # enum is documented as struct, union, or enum with the name of the typedef. So
379 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
380 # with name TypeT. When disabled the typedef will appear as a member of a file,
381 # namespace, or class. And the struct will be named TypeS. This can typically be
382 # useful for C code in case the coding convention dictates that all compound
383 # types are typedef'ed and only the typedef is referenced, never the tag name.
384 # The default value is: NO.
386 TYPEDEF_HIDES_STRUCT = NO
388 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
389 # cache is used to resolve symbols given their name and scope. Since this can be
390 # an expensive process and often the same symbol appears multiple times in the
391 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
392 # doxygen will become slower. If the cache is too large, memory is wasted. The
393 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
394 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
395 # symbols. At the end of a run doxygen will report the cache usage and suggest
396 # the optimal cache size from a speed point of view.
397 # Minimum value: 0, maximum value: 9, default value: 0.
399 LOOKUP_CACHE_SIZE = 0
401 #---------------------------------------------------------------------------
402 # Build related configuration options
403 #---------------------------------------------------------------------------
405 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
406 # documentation are documented, even if no documentation was available. Private
407 # class members and static file members will be hidden unless the
408 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
409 # Note: This will also disable the warnings about undocumented members that are
410 # normally produced when WARNINGS is set to YES.
411 # The default value is: NO.
415 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
416 # be included in the documentation.
417 # The default value is: NO.
419 EXTRACT_PRIVATE = YES
421 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
422 # scope will be included in the documentation.
423 # The default value is: NO.
427 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
428 # included in the documentation.
429 # The default value is: NO.
433 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
434 # locally in source files will be included in the documentation. If set to NO
435 # only classes defined in header files are included. Does not have any effect
437 # The default value is: YES.
439 EXTRACT_LOCAL_CLASSES = YES
441 # This flag is only useful for Objective-C code. When set to YES local methods,
442 # which are defined in the implementation section but not in the interface are
443 # included in the documentation. If set to NO only methods in the interface are
445 # The default value is: NO.
447 EXTRACT_LOCAL_METHODS = NO
449 # If this flag is set to YES, the members of anonymous namespaces will be
450 # extracted and appear in the documentation as a namespace called
451 # 'anonymous_namespace{file}', where file will be replaced with the base name of
452 # the file that contains the anonymous namespace. By default anonymous namespace
454 # The default value is: NO.
456 EXTRACT_ANON_NSPACES = NO
458 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
459 # undocumented members inside documented classes or files. If set to NO these
460 # members will be included in the various overviews, but no documentation
461 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
462 # The default value is: NO.
464 HIDE_UNDOC_MEMBERS = NO
466 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
467 # undocumented classes that are normally visible in the class hierarchy. If set
468 # to NO these classes will be included in the various overviews. This option has
469 # no effect if EXTRACT_ALL is enabled.
470 # The default value is: NO.
472 HIDE_UNDOC_CLASSES = NO
474 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
475 # (class|struct|union) declarations. If set to NO these declarations will be
476 # included in the documentation.
477 # The default value is: NO.
479 HIDE_FRIEND_COMPOUNDS = NO
481 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
482 # documentation blocks found inside the body of a function. If set to NO these
483 # blocks will be appended to the function's detailed documentation block.
484 # The default value is: NO.
486 HIDE_IN_BODY_DOCS = NO
488 # The INTERNAL_DOCS tag determines if documentation that is typed after a
489 # \internal command is included. If the tag is set to NO then the documentation
490 # will be excluded. Set it to YES to include the internal documentation.
491 # The default value is: NO.
495 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
496 # names in lower-case letters. If set to YES upper-case letters are also
497 # allowed. This is useful if you have classes or files whose names only differ
498 # in case and if your file system supports case sensitive file names. Windows
499 # and Mac users are advised to set this option to NO.
500 # The default value is: system dependent.
502 CASE_SENSE_NAMES = YES
504 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
505 # their full class and namespace scopes in the documentation. If set to YES the
506 # scope will be hidden.
507 # The default value is: NO.
509 HIDE_SCOPE_NAMES = NO
511 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
512 # the files that are included by a file in the documentation of that file.
513 # The default value is: YES.
515 SHOW_INCLUDE_FILES = YES
517 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
518 # grouped member an include statement to the documentation, telling the reader
519 # which file to include in order to use the member.
520 # The default value is: NO.
522 SHOW_GROUPED_MEMB_INC = NO
524 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
525 # files with double quotes in the documentation rather than with sharp brackets.
526 # The default value is: NO.
528 FORCE_LOCAL_INCLUDES = NO
530 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
531 # documentation for inline members.
532 # The default value is: YES.
536 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
537 # (detailed) documentation of file and class members alphabetically by member
538 # name. If set to NO the members will appear in declaration order.
539 # The default value is: YES.
541 SORT_MEMBER_DOCS = NO
543 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
544 # descriptions of file, namespace and class members alphabetically by member
545 # name. If set to NO the members will appear in declaration order. Note that
546 # this will also influence the order of the classes in the class list.
547 # The default value is: NO.
551 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
552 # (brief and detailed) documentation of class members so that constructors and
553 # destructors are listed first. If set to NO the constructors will appear in the
554 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
555 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
556 # member documentation.
557 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
558 # detailed member documentation.
559 # The default value is: NO.
561 SORT_MEMBERS_CTORS_1ST = NO
563 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
564 # of group names into alphabetical order. If set to NO the group names will
565 # appear in their defined order.
566 # The default value is: NO.
568 SORT_GROUP_NAMES = NO
570 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
571 # fully-qualified names, including namespaces. If set to NO, the class list will
572 # be sorted only by class name, not including the namespace part.
573 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
574 # Note: This option applies only to the class list, not to the alphabetical
576 # The default value is: NO.
578 SORT_BY_SCOPE_NAME = NO
580 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
581 # type resolution of all parameters of a function it will reject a match between
582 # the prototype and the implementation of a member function even if there is
583 # only one candidate or it is obvious which candidate to choose by doing a
584 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
585 # accept a match between prototype and implementation in such cases.
586 # The default value is: NO.
588 STRICT_PROTO_MATCHING = NO
590 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
591 # todo list. This list is created by putting \todo commands in the
593 # The default value is: YES.
595 GENERATE_TODOLIST = YES
597 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
598 # test list. This list is created by putting \test commands in the
600 # The default value is: YES.
602 GENERATE_TESTLIST = YES
604 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
605 # list. This list is created by putting \bug commands in the documentation.
606 # The default value is: YES.
608 GENERATE_BUGLIST = YES
610 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
611 # the deprecated list. This list is created by putting \deprecated commands in
613 # The default value is: YES.
615 GENERATE_DEPRECATEDLIST= YES
617 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
618 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
619 # ... \endcond blocks.
623 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
624 # initial value of a variable or macro / define can have for it to appear in the
625 # documentation. If the initializer consists of more lines than specified here
626 # it will be hidden. Use a value of 0 to hide initializers completely. The
627 # appearance of the value of individual variables and macros / defines can be
628 # controlled using \showinitializer or \hideinitializer command in the
629 # documentation regardless of this setting.
630 # Minimum value: 0, maximum value: 10000, default value: 30.
632 MAX_INITIALIZER_LINES = 25
634 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
635 # the bottom of the documentation of classes and structs. If set to YES the list
636 # will mention the files that were used to generate the documentation.
637 # The default value is: YES.
641 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
642 # will remove the Files entry from the Quick Index and from the Folder Tree View
644 # The default value is: YES.
648 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
649 # page. This will remove the Namespaces entry from the Quick Index and from the
650 # Folder Tree View (if specified).
651 # The default value is: YES.
653 SHOW_NAMESPACES = YES
655 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
656 # doxygen should invoke to get the current version for each file (typically from
657 # the version control system). Doxygen will invoke the program by executing (via
658 # popen()) the command command input-file, where command is the value of the
659 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
660 # by doxygen. Whatever the program writes to standard output is used as the file
661 # version. For an example see the documentation.
663 FILE_VERSION_FILTER =
665 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
666 # by doxygen. The layout file controls the global structure of the generated
667 # output files in an output format independent way. To create the layout file
668 # that represents doxygen's defaults, run doxygen with the -l option. You can
669 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
670 # will be used as the name of the layout file.
672 # Note that if you run doxygen from a directory containing a file called
673 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
678 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
679 # the reference definitions. This must be a list of .bib files. The .bib
680 # extension is automatically appended if omitted. This requires the bibtex tool
681 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
682 # For LaTeX the style of the bibliography can be controlled using
683 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
684 # search path. See also \cite for info how to create references.
688 #---------------------------------------------------------------------------
689 # Configuration options related to warning and progress messages
690 #---------------------------------------------------------------------------
692 # The QUIET tag can be used to turn on/off the messages that are generated to
693 # standard output by doxygen. If QUIET is set to YES this implies that the
695 # The default value is: NO.
699 # The WARNINGS tag can be used to turn on/off the warning messages that are
700 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
701 # this implies that the warnings are on.
703 # Tip: Turn warnings on while writing the documentation.
704 # The default value is: YES.
708 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
709 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
710 # will automatically be disabled.
711 # The default value is: YES.
713 WARN_IF_UNDOCUMENTED = YES
715 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
716 # potential errors in the documentation, such as not documenting some parameters
717 # in a documented function, or documenting parameters that don't exist or using
718 # markup commands wrongly.
719 # The default value is: YES.
721 WARN_IF_DOC_ERROR = YES
723 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
724 # are documented, but have no documentation for their parameters or return
725 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
726 # documentation, but not about the absence of documentation.
727 # The default value is: NO.
729 WARN_NO_PARAMDOC = NO
731 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
732 # can produce. The string should contain the $file, $line, and $text tags, which
733 # will be replaced by the file and line number from which the warning originated
734 # and the warning text. Optionally the format may contain $version, which will
735 # be replaced by the version of the file (if it could be obtained via
736 # FILE_VERSION_FILTER)
737 # The default value is: $file:$line: $text.
739 WARN_FORMAT = "$file:$line: $text"
741 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
742 # messages should be written. If left blank the output is written to standard
747 #---------------------------------------------------------------------------
748 # Configuration options related to the input files
749 #---------------------------------------------------------------------------
751 # The INPUT tag is used to specify the files and/or directories that contain
752 # documented source files. You may enter file names like myfile.cpp or
753 # directories like /usr/src/myproject. Separate the files or directories with
755 # Note: If this tag is empty the current directory is searched.
757 INPUT = @CMAKE_SOURCE_DIR@/src \
758 @CMAKE_SOURCE_DIR@/bin \
759 @CMAKE_BINARY_DIR@/bin
761 # This tag can be used to specify the character encoding of the source files
762 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
763 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
764 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
765 # possible encodings.
766 # The default value is: UTF-8.
768 INPUT_ENCODING = UTF-8
770 # If the value of the INPUT tag contains directories, you can use the
771 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
772 # *.h) to filter out the source-files in the directories. If left blank the
773 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
774 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
775 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
776 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
777 # *.qsf, *.as and *.js.
779 FILE_PATTERNS = *.hxx \
785 @DOXYGEN_PYTHON_EXTENSION@
787 # The RECURSIVE tag can be used to specify whether or not subdirectories should
788 # be searched for input files as well.
789 # The default value is: NO.
793 # The EXCLUDE tag can be used to specify files and/or directories that should be
794 # excluded from the INPUT source files. This way you can easily exclude a
795 # subdirectory from a directory tree whose root is specified with the INPUT tag.
797 # Note that relative paths are relative to the directory from which doxygen is
802 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
803 # directories that are symbolic links (a Unix file system feature) are excluded
805 # The default value is: NO.
807 EXCLUDE_SYMLINKS = NO
809 # If the value of the INPUT tag contains directories, you can use the
810 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
811 # certain files from those directories.
813 # Note that the wildcards are matched against the file with absolute path, so to
814 # exclude all test directories for example use the pattern */test/*
818 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
819 # (namespaces, classes, functions, etc.) that should be excluded from the
820 # output. The symbol name can be a fully qualified name, a word, or if the
821 # wildcard * is used, a substring. Examples: ANamespace, AClass,
822 # AClass::ANamespace, ANamespace::*Test
824 # Note that the wildcards are matched against the file with absolute path, so to
825 # exclude all test directories use the pattern */test/*
829 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
830 # that contain example code fragments that are included (see the \include
835 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
836 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
837 # *.h) to filter out the source-files in the directories. If left blank all
838 # files are included.
842 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
843 # searched for input files to be used with the \include or \dontinclude commands
844 # irrespective of the value of the RECURSIVE tag.
845 # The default value is: NO.
847 EXAMPLE_RECURSIVE = NO
849 # The IMAGE_PATH tag can be used to specify one or more files or directories
850 # that contain images that are to be included in the documentation (see the
853 IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/images
855 # The INPUT_FILTER tag can be used to specify a program that doxygen should
856 # invoke to filter for each input file. Doxygen will invoke the filter program
857 # by executing (via popen()) the command:
859 # <filter> <input-file>
861 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
862 # name of an input file. Doxygen will then use the output that the filter
863 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
866 # Note that the filter must not add or remove lines; it is applied before the
867 # code is scanned, but not when the output code is generated. If lines are added
868 # or removed, the anchors will not be placed correctly.
872 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
873 # basis. Doxygen will compare the file name with each pattern and apply the
874 # filter if there is a match. The filters are a list of the form: pattern=filter
875 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
876 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
877 # patterns match the file name, INPUT_FILTER is applied.
881 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
882 # INPUT_FILTER ) will also be used to filter the input files that are used for
883 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
884 # The default value is: NO.
886 FILTER_SOURCE_FILES = YES
888 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
889 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
890 # it is also possible to disable source filtering for a specific pattern using
891 # *.ext= (so without naming a filter).
892 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
894 FILTER_SOURCE_PATTERNS =
896 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
897 # is part of the input, its contents will be placed on the main page
898 # (index.html). This can be useful if you have a project on for instance GitHub
899 # and want to reuse the introduction page also for the doxygen output.
901 USE_MDFILE_AS_MAINPAGE =
903 #---------------------------------------------------------------------------
904 # Configuration options related to source browsing
905 #---------------------------------------------------------------------------
907 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
908 # generated. Documented entities will be cross-referenced with these sources.
910 # Note: To get rid of all source code in the generated output, make sure that
911 # also VERBATIM_HEADERS is set to NO.
912 # The default value is: NO.
916 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
917 # classes and enums directly into the documentation.
918 # The default value is: NO.
922 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
923 # special comment blocks from generated source code fragments. Normal C, C++ and
924 # Fortran comments will always remain visible.
925 # The default value is: YES.
927 STRIP_CODE_COMMENTS = YES
929 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
930 # function all documented functions referencing it will be listed.
931 # The default value is: NO.
933 REFERENCED_BY_RELATION = NO
935 # If the REFERENCES_RELATION tag is set to YES then for each documented function
936 # all documented entities called/used by that function will be listed.
937 # The default value is: NO.
939 REFERENCES_RELATION = YES
941 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
942 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
943 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
944 # link to the documentation.
945 # The default value is: YES.
947 REFERENCES_LINK_SOURCE = YES
949 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
950 # source code will show a tooltip with additional information such as prototype,
951 # brief description and links to the definition and documentation. Since this
952 # will make the HTML file larger and loading of large files a bit slower, you
953 # can opt to disable this feature.
954 # The default value is: YES.
955 # This tag requires that the tag SOURCE_BROWSER is set to YES.
957 SOURCE_TOOLTIPS = YES
959 # If the USE_HTAGS tag is set to YES then the references to source code will
960 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
961 # source browser. The htags tool is part of GNU's global source tagging system
962 # (see http://www.gnu.org/software/global/global.html). You will need version
965 # To use it do the following:
966 # - Install the latest version of global
967 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
968 # - Make sure the INPUT points to the root of the source tree
969 # - Run doxygen as normal
971 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
972 # tools must be available from the command line (i.e. in the search path).
974 # The result: instead of the source browser generated by doxygen, the links to
975 # source code will now point to the output of htags.
976 # The default value is: NO.
977 # This tag requires that the tag SOURCE_BROWSER is set to YES.
981 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
982 # verbatim copy of the header file for each class for which an include is
983 # specified. Set to NO to disable this.
984 # See also: Section \class.
985 # The default value is: YES.
987 VERBATIM_HEADERS = YES
989 # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
990 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
991 # cost of reduced performance. This can be particularly helpful with template
992 # rich C++ code for which doxygen's built-in parser lacks the necessary type
994 # Note: The availability of this option depends on whether or not doxygen was
995 # compiled with the --with-libclang option.
996 # The default value is: NO.
998 CLANG_ASSISTED_PARSING = NO
1000 # If clang assisted parsing is enabled you can provide the compiler with command
1001 # line options that you would normally use when invoking the compiler. Note that
1002 # the include paths will already be set by doxygen for the files and directories
1003 # specified with INPUT and INCLUDE_PATH.
1004 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1008 #---------------------------------------------------------------------------
1009 # Configuration options related to the alphabetical class index
1010 #---------------------------------------------------------------------------
1012 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1013 # compounds will be generated. Enable this if the project contains a lot of
1014 # classes, structs, unions or interfaces.
1015 # The default value is: YES.
1017 ALPHABETICAL_INDEX = YES
1019 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1020 # which the alphabetical index list will be split.
1021 # Minimum value: 1, maximum value: 20, default value: 5.
1022 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1024 COLS_IN_ALPHA_INDEX = 3
1026 # In case all classes in a project start with a common prefix, all classes will
1027 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1028 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1029 # while generating the index headers.
1030 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1034 #---------------------------------------------------------------------------
1035 # Configuration options related to the HTML output
1036 #---------------------------------------------------------------------------
1038 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1039 # The default value is: YES.
1043 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1044 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1046 # The default directory is: html.
1047 # This tag requires that the tag GENERATE_HTML is set to YES.
1051 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1052 # generated HTML page (for example: .htm, .php, .asp).
1053 # The default value is: .html.
1054 # This tag requires that the tag GENERATE_HTML is set to YES.
1056 HTML_FILE_EXTENSION = .html
1058 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1059 # each generated HTML page. If the tag is left blank doxygen will generate a
1062 # To get valid HTML the header file that includes any scripts and style sheets
1063 # that doxygen needs, which is dependent on the configuration options used (e.g.
1064 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1065 # default header using
1066 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1068 # and then modify the file new_header.html. See also section "Doxygen usage"
1069 # for information on how to generate the default header that doxygen normally
1071 # Note: The header is subject to change so you typically have to regenerate the
1072 # default header when upgrading to a newer version of doxygen. For a description
1073 # of the possible markers and block names see the documentation.
1074 # This tag requires that the tag GENERATE_HTML is set to YES.
1076 HTML_HEADER = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
1078 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1079 # generated HTML page. If the tag is left blank doxygen will generate a standard
1080 # footer. See HTML_HEADER for more information on how to generate a default
1081 # footer and what special commands can be used inside the footer. See also
1082 # section "Doxygen usage" for information on how to generate the default footer
1083 # that doxygen normally uses.
1084 # This tag requires that the tag GENERATE_HTML is set to YES.
1086 HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
1088 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1089 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1090 # the HTML output. If left blank doxygen will generate a default style sheet.
1091 # See also section "Doxygen usage" for information on how to generate the style
1092 # sheet that doxygen normally uses.
1093 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1094 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1096 # This tag requires that the tag GENERATE_HTML is set to YES.
1100 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1101 # cascading style sheets that are included after the standard style sheets
1102 # created by doxygen. Using this option one can overrule certain style aspects.
1103 # This is preferred over using HTML_STYLESHEET since it does not replace the
1104 # standard style sheet and is therefor more robust against future updates.
1105 # Doxygen will copy the style sheet files to the output directory.
1106 # Note: The order of the extra stylesheet files is of importance (e.g. the last
1107 # stylesheet in the list overrules the setting of the previous ones in the
1108 # list). For an example see the documentation.
1109 # This tag requires that the tag GENERATE_HTML is set to YES.
1111 HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
1113 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1114 # other source files which should be copied to the HTML output directory. Note
1115 # that these files will be copied to the base HTML output directory. Use the
1116 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1117 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1118 # files will be copied as-is; there are no commands or markers available.
1119 # This tag requires that the tag GENERATE_HTML is set to YES.
1123 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1124 # will adjust the colors in the stylesheet and background images according to
1125 # this color. Hue is specified as an angle on a colorwheel, see
1126 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1127 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1128 # purple, and 360 is red again.
1129 # Minimum value: 0, maximum value: 359, default value: 220.
1130 # This tag requires that the tag GENERATE_HTML is set to YES.
1132 HTML_COLORSTYLE_HUE = 220
1134 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1135 # in the HTML output. For a value of 0 the output will use grayscales only. A
1136 # value of 255 will produce the most vivid colors.
1137 # Minimum value: 0, maximum value: 255, default value: 100.
1138 # This tag requires that the tag GENERATE_HTML is set to YES.
1140 HTML_COLORSTYLE_SAT = 100
1142 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1143 # luminance component of the colors in the HTML output. Values below 100
1144 # gradually make the output lighter, whereas values above 100 make the output
1145 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1146 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1148 # Minimum value: 40, maximum value: 240, default value: 80.
1149 # This tag requires that the tag GENERATE_HTML is set to YES.
1151 HTML_COLORSTYLE_GAMMA = 80
1153 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1154 # page will contain the date and time when the page was generated. Setting this
1155 # to NO can help when comparing the output of multiple runs.
1156 # The default value is: YES.
1157 # This tag requires that the tag GENERATE_HTML is set to YES.
1161 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1162 # documentation will contain sections that can be hidden and shown after the
1164 # The default value is: NO.
1165 # This tag requires that the tag GENERATE_HTML is set to YES.
1167 HTML_DYNAMIC_SECTIONS = NO
1169 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1170 # shown in the various tree structured indices initially; the user can expand
1171 # and collapse entries dynamically later on. Doxygen will expand the tree to
1172 # such a level that at most the specified number of entries are visible (unless
1173 # a fully collapsed tree already exceeds this amount). So setting the number of
1174 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1175 # representing an infinite number of entries and will result in a full expanded
1177 # Minimum value: 0, maximum value: 9999, default value: 100.
1178 # This tag requires that the tag GENERATE_HTML is set to YES.
1180 HTML_INDEX_NUM_ENTRIES = 100
1182 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1183 # generated that can be used as input for Apple's Xcode 3 integrated development
1184 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1185 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1186 # Makefile in the HTML output directory. Running make will produce the docset in
1187 # that directory and running make install will install the docset in
1188 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1189 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1190 # for more information.
1191 # The default value is: NO.
1192 # This tag requires that the tag GENERATE_HTML is set to YES.
1194 GENERATE_DOCSET = NO
1196 # This tag determines the name of the docset feed. A documentation feed provides
1197 # an umbrella under which multiple documentation sets from a single provider
1198 # (such as a company or product suite) can be grouped.
1199 # The default value is: Doxygen generated docs.
1200 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1202 DOCSET_FEEDNAME = "Doxygen generated docs"
1204 # This tag specifies a string that should uniquely identify the documentation
1205 # set bundle. This should be a reverse domain-name style string, e.g.
1206 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1207 # The default value is: org.doxygen.Project.
1208 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1210 DOCSET_BUNDLE_ID = org.doxygen.Project
1212 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1213 # the documentation publisher. This should be a reverse domain-name style
1214 # string, e.g. com.mycompany.MyDocSet.documentation.
1215 # The default value is: org.doxygen.Publisher.
1216 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1218 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1220 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1221 # The default value is: Publisher.
1222 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1224 DOCSET_PUBLISHER_NAME = Publisher
1226 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1227 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1228 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1229 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1232 # The HTML Help Workshop contains a compiler that can convert all HTML output
1233 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1234 # files are now used as the Windows 98 help format, and will replace the old
1235 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1236 # HTML files also contain an index, a table of contents, and you can search for
1237 # words in the documentation. The HTML workshop also contains a viewer for
1238 # compressed HTML files.
1239 # The default value is: NO.
1240 # This tag requires that the tag GENERATE_HTML is set to YES.
1242 GENERATE_HTMLHELP = NO
1244 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1245 # file. You can add a path in front of the file if the result should not be
1246 # written to the html output directory.
1247 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1251 # The HHC_LOCATION tag can be used to specify the location (absolute path
1252 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1253 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1254 # The file has to be specified with full path.
1255 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1259 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1260 # YES) or that it should be included in the master .chm file ( NO).
1261 # The default value is: NO.
1262 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1266 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1267 # and project file content.
1268 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1270 CHM_INDEX_ENCODING =
1272 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1273 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1274 # enables the Previous and Next buttons.
1275 # The default value is: NO.
1276 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1280 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1281 # the table of contents of the HTML help documentation and to the tree view.
1282 # The default value is: NO.
1283 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1287 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1288 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1289 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1290 # (.qch) of the generated HTML documentation.
1291 # The default value is: NO.
1292 # This tag requires that the tag GENERATE_HTML is set to YES.
1296 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1297 # the file name of the resulting .qch file. The path specified is relative to
1298 # the HTML output folder.
1299 # This tag requires that the tag GENERATE_QHP is set to YES.
1303 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1304 # Project output. For more information please see Qt Help Project / Namespace
1305 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1306 # The default value is: org.doxygen.Project.
1307 # This tag requires that the tag GENERATE_QHP is set to YES.
1309 QHP_NAMESPACE = org.doxygen.Project
1311 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1312 # Help Project output. For more information please see Qt Help Project / Virtual
1313 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1315 # The default value is: doc.
1316 # This tag requires that the tag GENERATE_QHP is set to YES.
1318 QHP_VIRTUAL_FOLDER = doc
1320 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1321 # filter to add. For more information please see Qt Help Project / Custom
1322 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1324 # This tag requires that the tag GENERATE_QHP is set to YES.
1326 QHP_CUST_FILTER_NAME =
1328 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1329 # custom filter to add. For more information please see Qt Help Project / Custom
1330 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1332 # This tag requires that the tag GENERATE_QHP is set to YES.
1334 QHP_CUST_FILTER_ATTRS =
1336 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1337 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1338 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1339 # This tag requires that the tag GENERATE_QHP is set to YES.
1341 QHP_SECT_FILTER_ATTRS =
1343 # The QHG_LOCATION tag can be used to specify the location of Qt's
1344 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1345 # generated .qhp file.
1346 # This tag requires that the tag GENERATE_QHP is set to YES.
1350 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1351 # generated, together with the HTML files, they form an Eclipse help plugin. To
1352 # install this plugin and make it available under the help contents menu in
1353 # Eclipse, the contents of the directory containing the HTML and XML files needs
1354 # to be copied into the plugins directory of eclipse. The name of the directory
1355 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1356 # After copying Eclipse needs to be restarted before the help appears.
1357 # The default value is: NO.
1358 # This tag requires that the tag GENERATE_HTML is set to YES.
1360 GENERATE_ECLIPSEHELP = NO
1362 # A unique identifier for the Eclipse help plugin. When installing the plugin
1363 # the directory name containing the HTML and XML files should also have this
1364 # name. Each documentation set should have its own identifier.
1365 # The default value is: org.doxygen.Project.
1366 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1368 ECLIPSE_DOC_ID = org.doxygen.Project
1370 # If you want full control over the layout of the generated HTML pages it might
1371 # be necessary to disable the index and replace it with your own. The
1372 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1373 # of each HTML page. A value of NO enables the index and the value YES disables
1374 # it. Since the tabs in the index contain the same information as the navigation
1375 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1376 # The default value is: NO.
1377 # This tag requires that the tag GENERATE_HTML is set to YES.
1381 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1382 # structure should be generated to display hierarchical information. If the tag
1383 # value is set to YES, a side panel will be generated containing a tree-like
1384 # index structure (just like the one that is generated for HTML Help). For this
1385 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1386 # (i.e. any modern browser). Windows users are probably better off using the
1387 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1388 # further fine-tune the look of the index. As an example, the default style
1389 # sheet generated by doxygen has an example that shows how to put an image at
1390 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1391 # the same information as the tab index, you could consider setting
1392 # DISABLE_INDEX to YES when enabling this option.
1393 # The default value is: NO.
1394 # This tag requires that the tag GENERATE_HTML is set to YES.
1396 GENERATE_TREEVIEW = YES
1398 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1399 # doxygen will group on one line in the generated HTML documentation.
1401 # Note that a value of 0 will completely suppress the enum values from appearing
1402 # in the overview section.
1403 # Minimum value: 0, maximum value: 20, default value: 4.
1404 # This tag requires that the tag GENERATE_HTML is set to YES.
1406 ENUM_VALUES_PER_LINE = 4
1408 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1409 # to set the initial width (in pixels) of the frame in which the tree is shown.
1410 # Minimum value: 0, maximum value: 1500, default value: 250.
1411 # This tag requires that the tag GENERATE_HTML is set to YES.
1413 TREEVIEW_WIDTH = 250
1415 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1416 # external symbols imported via tag files in a separate window.
1417 # The default value is: NO.
1418 # This tag requires that the tag GENERATE_HTML is set to YES.
1420 EXT_LINKS_IN_WINDOW = NO
1422 # Use this tag to change the font size of LaTeX formulas included as images in
1423 # the HTML documentation. When you change the font size after a successful
1424 # doxygen run you need to manually remove any form_*.png images from the HTML
1425 # output directory to force them to be regenerated.
1426 # Minimum value: 8, maximum value: 50, default value: 10.
1427 # This tag requires that the tag GENERATE_HTML is set to YES.
1429 FORMULA_FONTSIZE = 10
1431 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1432 # generated for formulas are transparent PNGs. Transparent PNGs are not
1433 # supported properly for IE 6.0, but are supported on all modern browsers.
1435 # Note that when changing this option you need to delete any form_*.png files in
1436 # the HTML output directory before the changes have effect.
1437 # The default value is: YES.
1438 # This tag requires that the tag GENERATE_HTML is set to YES.
1440 FORMULA_TRANSPARENT = YES
1442 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1443 # http://www.mathjax.org) which uses client side Javascript for the rendering
1444 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1445 # installed or if you want to formulas look prettier in the HTML output. When
1446 # enabled you may also need to install MathJax separately and configure the path
1447 # to it using the MATHJAX_RELPATH option.
1448 # The default value is: NO.
1449 # This tag requires that the tag GENERATE_HTML is set to YES.
1453 # When MathJax is enabled you can set the default output format to be used for
1454 # the MathJax output. See the MathJax site (see:
1455 # http://docs.mathjax.org/en/latest/output.html) for more details.
1456 # Possible values are: HTML-CSS (which is slower, but has the best
1457 # compatibility), NativeMML (i.e. MathML) and SVG.
1458 # The default value is: HTML-CSS.
1459 # This tag requires that the tag USE_MATHJAX is set to YES.
1461 MATHJAX_FORMAT = HTML-CSS
1463 # When MathJax is enabled you need to specify the location relative to the HTML
1464 # output directory using the MATHJAX_RELPATH option. The destination directory
1465 # should contain the MathJax.js script. For instance, if the mathjax directory
1466 # is located at the same level as the HTML output directory, then
1467 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1468 # Content Delivery Network so you can quickly see the result without installing
1469 # MathJax. However, it is strongly recommended to install a local copy of
1470 # MathJax from http://www.mathjax.org before deployment.
1471 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1472 # This tag requires that the tag USE_MATHJAX is set to YES.
1474 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1476 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1477 # extension names that should be enabled during MathJax rendering. For example
1478 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1479 # This tag requires that the tag USE_MATHJAX is set to YES.
1481 MATHJAX_EXTENSIONS =
1483 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1484 # of code that will be used on startup of the MathJax code. See the MathJax site
1485 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1486 # example see the documentation.
1487 # This tag requires that the tag USE_MATHJAX is set to YES.
1491 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1492 # the HTML output. The underlying search engine uses javascript and DHTML and
1493 # should work on any modern browser. Note that when using HTML help
1494 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1495 # there is already a search function so this one should typically be disabled.
1496 # For large projects the javascript based search engine can be slow, then
1497 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1498 # search using the keyboard; to jump to the search box use <access key> + S
1499 # (what the <access key> is depends on the OS and browser, but it is typically
1500 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1501 # key> to jump into the search results window, the results can be navigated
1502 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1503 # the search. The filter options can be selected when the cursor is inside the
1504 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1505 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1507 # The default value is: YES.
1508 # This tag requires that the tag GENERATE_HTML is set to YES.
1512 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1513 # implemented using a web server instead of a web client using Javascript. There
1514 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1515 # setting. When disabled, doxygen will generate a PHP script for searching and
1516 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1517 # and searching needs to be provided by external tools. See the section
1518 # "External Indexing and Searching" for details.
1519 # The default value is: NO.
1520 # This tag requires that the tag SEARCHENGINE is set to YES.
1522 SERVER_BASED_SEARCH = NO
1524 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1525 # script for searching. Instead the search results are written to an XML file
1526 # which needs to be processed by an external indexer. Doxygen will invoke an
1527 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1530 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1531 # (doxysearch.cgi) which are based on the open source search engine library
1532 # Xapian (see: http://xapian.org/).
1534 # See the section "External Indexing and Searching" for details.
1535 # The default value is: NO.
1536 # This tag requires that the tag SEARCHENGINE is set to YES.
1538 EXTERNAL_SEARCH = NO
1540 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1541 # which will return the search results when EXTERNAL_SEARCH is enabled.
1543 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1544 # (doxysearch.cgi) which are based on the open source search engine library
1545 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1546 # Searching" for details.
1547 # This tag requires that the tag SEARCHENGINE is set to YES.
1551 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1552 # search data is written to a file for indexing by an external tool. With the
1553 # SEARCHDATA_FILE tag the name of this file can be specified.
1554 # The default file is: searchdata.xml.
1555 # This tag requires that the tag SEARCHENGINE is set to YES.
1557 SEARCHDATA_FILE = searchdata.xml
1559 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1560 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1561 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1562 # projects and redirect the results back to the right project.
1563 # This tag requires that the tag SEARCHENGINE is set to YES.
1565 EXTERNAL_SEARCH_ID =
1567 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1568 # projects other than the one defined by this configuration file, but that are
1569 # all added to the same external search index. Each project needs to have a
1570 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1571 # to a relative location where the documentation can be found. The format is:
1572 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1573 # This tag requires that the tag SEARCHENGINE is set to YES.
1575 EXTRA_SEARCH_MAPPINGS =
1577 #---------------------------------------------------------------------------
1578 # Configuration options related to the LaTeX output
1579 #---------------------------------------------------------------------------
1581 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1582 # The default value is: YES.
1586 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1587 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1589 # The default directory is: latex.
1590 # This tag requires that the tag GENERATE_LATEX is set to YES.
1592 LATEX_OUTPUT = latex
1594 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1597 # Note that when enabling USE_PDFLATEX this option is only used for generating
1598 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1599 # written to the output directory.
1600 # The default file is: latex.
1601 # This tag requires that the tag GENERATE_LATEX is set to YES.
1603 LATEX_CMD_NAME = latex
1605 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1607 # The default file is: makeindex.
1608 # This tag requires that the tag GENERATE_LATEX is set to YES.
1610 MAKEINDEX_CMD_NAME = makeindex
1612 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1613 # documents. This may be useful for small projects and may help to save some
1615 # The default value is: NO.
1616 # This tag requires that the tag GENERATE_LATEX is set to YES.
1620 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1622 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1623 # 14 inches) and executive (7.25 x 10.5 inches).
1624 # The default value is: a4.
1625 # This tag requires that the tag GENERATE_LATEX is set to YES.
1629 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1630 # that should be included in the LaTeX output. To get the times font for
1631 # instance you can specify
1632 # EXTRA_PACKAGES=times
1633 # If left blank no extra packages will be included.
1634 # This tag requires that the tag GENERATE_LATEX is set to YES.
1638 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1639 # generated LaTeX document. The header should contain everything until the first
1640 # chapter. If it is left blank doxygen will generate a standard header. See
1641 # section "Doxygen usage" for information on how to let doxygen write the
1642 # default header to a separate file.
1644 # Note: Only use a user-defined header if you know what you are doing! The
1645 # following commands have a special meaning inside the header: $title,
1646 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1647 # $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
1648 # for the replacement values of the other commands the user is refered to
1650 # This tag requires that the tag GENERATE_LATEX is set to YES.
1654 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1655 # generated LaTeX document. The footer should contain everything after the last
1656 # chapter. If it is left blank doxygen will generate a standard footer. See
1657 # LATEX_HEADER for more information on how to generate a default footer and what
1658 # special commands can be used inside the footer.
1660 # Note: Only use a user-defined footer if you know what you are doing!
1661 # This tag requires that the tag GENERATE_LATEX is set to YES.
1665 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1666 # other source files which should be copied to the LATEX_OUTPUT output
1667 # directory. Note that the files will be copied as-is; there are no commands or
1668 # markers available.
1669 # This tag requires that the tag GENERATE_LATEX is set to YES.
1673 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1674 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1675 # contain links (just like the HTML output) instead of page references. This
1676 # makes the output suitable for online browsing using a PDF viewer.
1677 # The default value is: YES.
1678 # This tag requires that the tag GENERATE_LATEX is set to YES.
1682 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1683 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1684 # higher quality PDF documentation.
1685 # The default value is: YES.
1686 # This tag requires that the tag GENERATE_LATEX is set to YES.
1690 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1691 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1692 # if errors occur, instead of asking the user for help. This option is also used
1693 # when generating formulas in HTML.
1694 # The default value is: NO.
1695 # This tag requires that the tag GENERATE_LATEX is set to YES.
1697 LATEX_BATCHMODE = NO
1699 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1700 # index chapters (such as File Index, Compound Index, etc.) in the output.
1701 # The default value is: NO.
1702 # This tag requires that the tag GENERATE_LATEX is set to YES.
1704 LATEX_HIDE_INDICES = NO
1706 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1707 # code with syntax highlighting in the LaTeX output.
1709 # Note that which sources are shown also depends on other settings such as
1711 # The default value is: NO.
1712 # This tag requires that the tag GENERATE_LATEX is set to YES.
1714 LATEX_SOURCE_CODE = NO
1716 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1717 # bibliography, e.g. plainnat, or ieeetr. See
1718 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1719 # The default value is: plain.
1720 # This tag requires that the tag GENERATE_LATEX is set to YES.
1722 LATEX_BIB_STYLE = plain
1724 #---------------------------------------------------------------------------
1725 # Configuration options related to the RTF output
1726 #---------------------------------------------------------------------------
1728 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1729 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1731 # The default value is: NO.
1735 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1736 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1738 # The default directory is: rtf.
1739 # This tag requires that the tag GENERATE_RTF is set to YES.
1743 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1744 # documents. This may be useful for small projects and may help to save some
1746 # The default value is: NO.
1747 # This tag requires that the tag GENERATE_RTF is set to YES.
1751 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1752 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1753 # output) instead of page references. This makes the output suitable for online
1754 # browsing using Word or some other Word compatible readers that support those
1757 # Note: WordPad (write) and others do not support links.
1758 # The default value is: NO.
1759 # This tag requires that the tag GENERATE_RTF is set to YES.
1763 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1764 # file, i.e. a series of assignments. You only have to provide replacements,
1765 # missing definitions are set to their default value.
1767 # See also section "Doxygen usage" for information on how to generate the
1768 # default style sheet that doxygen normally uses.
1769 # This tag requires that the tag GENERATE_RTF is set to YES.
1771 RTF_STYLESHEET_FILE =
1773 # Set optional variables used in the generation of an RTF document. Syntax is
1774 # similar to doxygen's config file. A template extensions file can be generated
1775 # using doxygen -e rtf extensionFile.
1776 # This tag requires that the tag GENERATE_RTF is set to YES.
1778 RTF_EXTENSIONS_FILE =
1780 #---------------------------------------------------------------------------
1781 # Configuration options related to the man page output
1782 #---------------------------------------------------------------------------
1784 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1785 # classes and files.
1786 # The default value is: NO.
1790 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1791 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1792 # it. A directory man3 will be created inside the directory specified by
1794 # The default directory is: man.
1795 # This tag requires that the tag GENERATE_MAN is set to YES.
1799 # The MAN_EXTENSION tag determines the extension that is added to the generated
1800 # man pages. In case the manual section does not start with a number, the number
1801 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1803 # The default value is: .3.
1804 # This tag requires that the tag GENERATE_MAN is set to YES.
1808 # The MAN_SUBDIR tag determines the name of the directory created within
1809 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1810 # MAN_EXTENSION with the initial . removed.
1811 # This tag requires that the tag GENERATE_MAN is set to YES.
1815 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1816 # will generate one additional man file for each entity documented in the real
1817 # man page(s). These additional files only source the real man page, but without
1818 # them the man command would be unable to find the correct page.
1819 # The default value is: NO.
1820 # This tag requires that the tag GENERATE_MAN is set to YES.
1824 #---------------------------------------------------------------------------
1825 # Configuration options related to the XML output
1826 #---------------------------------------------------------------------------
1828 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1829 # captures the structure of the code including all documentation.
1830 # The default value is: NO.
1834 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1835 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1837 # The default directory is: xml.
1838 # This tag requires that the tag GENERATE_XML is set to YES.
1842 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1843 # listings (including syntax highlighting and cross-referencing information) to
1844 # the XML output. Note that enabling this will significantly increase the size
1845 # of the XML output.
1846 # The default value is: YES.
1847 # This tag requires that the tag GENERATE_XML is set to YES.
1849 XML_PROGRAMLISTING = YES
1851 #---------------------------------------------------------------------------
1852 # Configuration options related to the DOCBOOK output
1853 #---------------------------------------------------------------------------
1855 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1856 # that can be used to generate PDF.
1857 # The default value is: NO.
1859 GENERATE_DOCBOOK = NO
1861 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1862 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1864 # The default directory is: docbook.
1865 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1867 DOCBOOK_OUTPUT = docbook
1869 # If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
1870 # program listings (including syntax highlighting and cross-referencing
1871 # information) to the DOCBOOK output. Note that enabling this will significantly
1872 # increase the size of the DOCBOOK output.
1873 # The default value is: NO.
1874 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1876 DOCBOOK_PROGRAMLISTING = NO
1878 #---------------------------------------------------------------------------
1879 # Configuration options for the AutoGen Definitions output
1880 #---------------------------------------------------------------------------
1882 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1883 # Definitions (see http://autogen.sf.net) file that captures the structure of
1884 # the code including all documentation. Note that this feature is still
1885 # experimental and incomplete at the moment.
1886 # The default value is: NO.
1888 GENERATE_AUTOGEN_DEF = NO
1890 #---------------------------------------------------------------------------
1891 # Configuration options related to the Perl module output
1892 #---------------------------------------------------------------------------
1894 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1895 # file that captures the structure of the code including all documentation.
1897 # Note that this feature is still experimental and incomplete at the moment.
1898 # The default value is: NO.
1900 GENERATE_PERLMOD = NO
1902 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1903 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1904 # output from the Perl module output.
1905 # The default value is: NO.
1906 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1910 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1911 # formatted so it can be parsed by a human reader. This is useful if you want to
1912 # understand what is going on. On the other hand, if this tag is set to NO the
1913 # size of the Perl module output will be much smaller and Perl will parse it
1915 # The default value is: YES.
1916 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1918 PERLMOD_PRETTY = YES
1920 # The names of the make variables in the generated doxyrules.make file are
1921 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1922 # so different doxyrules.make files included by the same Makefile don't
1923 # overwrite each other's variables.
1924 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1926 PERLMOD_MAKEVAR_PREFIX =
1928 #---------------------------------------------------------------------------
1929 # Configuration options related to the preprocessor
1930 #---------------------------------------------------------------------------
1932 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1933 # C-preprocessor directives found in the sources and include files.
1934 # The default value is: YES.
1936 ENABLE_PREPROCESSING = YES
1938 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1939 # in the source code. If set to NO only conditional compilation will be
1940 # performed. Macro expansion can be done in a controlled way by setting
1941 # EXPAND_ONLY_PREDEF to YES.
1942 # The default value is: NO.
1943 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1945 MACRO_EXPANSION = NO
1947 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1948 # the macro expansion is limited to the macros specified with the PREDEFINED and
1949 # EXPAND_AS_DEFINED tags.
1950 # The default value is: NO.
1951 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1953 EXPAND_ONLY_PREDEF = NO
1955 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1956 # INCLUDE_PATH will be searched if a #include is found.
1957 # The default value is: YES.
1958 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1960 SEARCH_INCLUDES = YES
1962 # The INCLUDE_PATH tag can be used to specify one or more directories that
1963 # contain include files that are not input files but should be processed by the
1965 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1969 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1970 # patterns (like *.h and *.hpp) to filter out the header-files in the
1971 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1973 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1975 INCLUDE_FILE_PATTERNS =
1977 # The PREDEFINED tag can be used to specify one or more macro names that are
1978 # defined before the preprocessor is started (similar to the -D option of e.g.
1979 # gcc). The argument of the tag is a list of macros of the form: name or
1980 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1981 # is assumed. To prevent a macro definition from being undefined via #undef or
1982 # recursively expanded use the := operator instead of the = operator.
1983 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1987 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1988 # tag can be used to specify a list of macro names that should be expanded. The
1989 # macro definition that is found in the sources will be used. Use the PREDEFINED
1990 # tag if you want to use a different macro definition that overrules the
1991 # definition found in the source code.
1992 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1996 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1997 # remove all references to function-like macros that are alone on a line, have
1998 # an all uppercase name, and do not end with a semicolon. Such function macros
1999 # are typically used for boiler-plate code, and will confuse the parser if not
2001 # The default value is: YES.
2002 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2004 SKIP_FUNCTION_MACROS = NO
2006 #---------------------------------------------------------------------------
2007 # Configuration options related to external references
2008 #---------------------------------------------------------------------------
2010 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2011 # file the location of the external documentation should be added. The format of
2012 # a tag file without this location is as follows:
2013 # TAGFILES = file1 file2 ...
2014 # Adding location for the tag files is done as follows:
2015 # TAGFILES = file1=loc1 "file2 = loc2" ...
2016 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2017 # section "Linking to external documentation" for more information about the use
2019 # Note: Each tag file must have a unique name (where the name does NOT include
2020 # the path). If a tag file is not located in the directory in which doxygen is
2021 # run, you must also specify the path to the tagfile here.
2025 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2026 # tag file that is based on the input files it reads. See section "Linking to
2027 # external documentation" for more information about the usage of tag files.
2031 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2032 # class index. If set to NO only the inherited external classes will be listed.
2033 # The default value is: NO.
2037 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2038 # the modules index. If set to NO, only the current project's groups will be
2040 # The default value is: YES.
2042 EXTERNAL_GROUPS = YES
2044 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2045 # the related pages index. If set to NO, only the current project's pages will
2047 # The default value is: YES.
2049 EXTERNAL_PAGES = YES
2051 # The PERL_PATH should be the absolute path and name of the perl script
2052 # interpreter (i.e. the result of 'which perl').
2053 # The default file (with absolute path) is: /usr/bin/perl.
2055 PERL_PATH = /usr/bin/perl
2057 #---------------------------------------------------------------------------
2058 # Configuration options related to the dot tool
2059 #---------------------------------------------------------------------------
2061 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2062 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2063 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2064 # disabled, but it is recommended to install and use dot, since it yields more
2066 # The default value is: YES.
2068 CLASS_DIAGRAMS = YES
2070 # You can define message sequence charts within doxygen comments using the \msc
2071 # command. Doxygen will then run the mscgen tool (see:
2072 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2073 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2074 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2075 # default search path.
2079 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2080 # then run dia to produce the diagram and insert it in the documentation. The
2081 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2082 # If left empty dia is assumed to be found in the default search path.
2086 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2087 # and usage relations if the target is undocumented or is not a class.
2088 # The default value is: YES.
2090 HIDE_UNDOC_RELATIONS = NO
2092 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2093 # available from the path. This tool is part of Graphviz (see:
2094 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2095 # Bell Labs. The other options in this section have no effect if this option is
2097 # The default value is: YES.
2101 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2102 # to run in parallel. When set to 0 doxygen will base this on the number of
2103 # processors available in the system. You can set it explicitly to a value
2104 # larger than 0 to get control over the balance between CPU load and processing
2106 # Minimum value: 0, maximum value: 32, default value: 0.
2107 # This tag requires that the tag HAVE_DOT is set to YES.
2111 # When you want a differently looking font in the dot files that doxygen
2112 # generates you can specify the font name using DOT_FONTNAME. You need to make
2113 # sure dot is able to find the font, which can be done by putting it in a
2114 # standard location or by setting the DOTFONTPATH environment variable or by
2115 # setting DOT_FONTPATH to the directory containing the font.
2116 # The default value is: Helvetica.
2117 # This tag requires that the tag HAVE_DOT is set to YES.
2119 DOT_FONTNAME = Arial
2121 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2123 # Minimum value: 4, maximum value: 24, default value: 10.
2124 # This tag requires that the tag HAVE_DOT is set to YES.
2128 # By default doxygen will tell dot to use the default font as specified with
2129 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2130 # the path where dot can find it using this tag.
2131 # This tag requires that the tag HAVE_DOT is set to YES.
2135 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2136 # each documented class showing the direct and indirect inheritance relations.
2137 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2138 # The default value is: YES.
2139 # This tag requires that the tag HAVE_DOT is set to YES.
2143 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2144 # graph for each documented class showing the direct and indirect implementation
2145 # dependencies (inheritance, containment, and class references variables) of the
2146 # class with other documented classes.
2147 # The default value is: YES.
2148 # This tag requires that the tag HAVE_DOT is set to YES.
2150 COLLABORATION_GRAPH = NO
2152 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2153 # groups, showing the direct groups dependencies.
2154 # The default value is: YES.
2155 # This tag requires that the tag HAVE_DOT is set to YES.
2159 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2160 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2162 # The default value is: NO.
2163 # This tag requires that the tag HAVE_DOT is set to YES.
2167 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2168 # class node. If there are many fields or methods and many nodes the graph may
2169 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2170 # number of items for each type to make the size more manageable. Set this to 0
2171 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2172 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2173 # but if the number exceeds 15, the total amount of fields shown is limited to
2175 # Minimum value: 0, maximum value: 100, default value: 10.
2176 # This tag requires that the tag HAVE_DOT is set to YES.
2178 UML_LIMIT_NUM_FIELDS = 10
2180 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2181 # collaboration graphs will show the relations between templates and their
2183 # The default value is: NO.
2184 # This tag requires that the tag HAVE_DOT is set to YES.
2186 TEMPLATE_RELATIONS = YES
2188 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2189 # YES then doxygen will generate a graph for each documented file showing the
2190 # direct and indirect include dependencies of the file with other documented
2192 # The default value is: YES.
2193 # This tag requires that the tag HAVE_DOT is set to YES.
2197 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2198 # set to YES then doxygen will generate a graph for each documented file showing
2199 # the direct and indirect include dependencies of the file with other documented
2201 # The default value is: YES.
2202 # This tag requires that the tag HAVE_DOT is set to YES.
2204 INCLUDED_BY_GRAPH = NO
2206 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2207 # dependency graph for every global function or class method.
2209 # Note that enabling this option will significantly increase the time of a run.
2210 # So in most cases it will be better to enable call graphs for selected
2211 # functions only using the \callgraph command.
2212 # The default value is: NO.
2213 # This tag requires that the tag HAVE_DOT is set to YES.
2217 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2218 # dependency graph for every global function or class method.
2220 # Note that enabling this option will significantly increase the time of a run.
2221 # So in most cases it will be better to enable caller graphs for selected
2222 # functions only using the \callergraph command.
2223 # The default value is: NO.
2224 # This tag requires that the tag HAVE_DOT is set to YES.
2228 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2229 # hierarchy of all classes instead of a textual one.
2230 # The default value is: YES.
2231 # This tag requires that the tag HAVE_DOT is set to YES.
2233 GRAPHICAL_HIERARCHY = YES
2235 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2236 # dependencies a directory has on other directories in a graphical way. The
2237 # dependency relations are determined by the #include relations between the
2238 # files in the directories.
2239 # The default value is: YES.
2240 # This tag requires that the tag HAVE_DOT is set to YES.
2242 DIRECTORY_GRAPH = YES
2244 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2246 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2247 # to make the SVG files visible in IE 9+ (other browsers do not have this
2249 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2250 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2251 # gif:cairo:gd, gif:gd, gif:gd:gd and svg.
2252 # The default value is: png.
2253 # This tag requires that the tag HAVE_DOT is set to YES.
2255 DOT_IMAGE_FORMAT = jpg
2257 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2258 # enable generation of interactive SVG images that allow zooming and panning.
2260 # Note that this requires a modern browser other than Internet Explorer. Tested
2261 # and working are Firefox, Chrome, Safari, and Opera.
2262 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2263 # the SVG files visible. Older versions of IE do not have SVG support.
2264 # The default value is: NO.
2265 # This tag requires that the tag HAVE_DOT is set to YES.
2267 INTERACTIVE_SVG = NO
2269 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2270 # found. If left blank, it is assumed the dot tool can be found in the path.
2271 # This tag requires that the tag HAVE_DOT is set to YES.
2275 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2276 # contain dot files that are included in the documentation (see the \dotfile
2278 # This tag requires that the tag HAVE_DOT is set to YES.
2282 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2283 # contain msc files that are included in the documentation (see the \mscfile
2288 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2289 # contain dia files that are included in the documentation (see the \diafile
2294 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2295 # path where java can find the plantuml.jar file. If left blank, it is assumed
2296 # PlantUML is not used or called during a preprocessing step. Doxygen will
2297 # generate a warning when it encounters a \startuml command in this case and
2298 # will not generate output for the diagram.
2299 # This tag requires that the tag HAVE_DOT is set to YES.
2303 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2304 # that will be shown in the graph. If the number of nodes in a graph becomes
2305 # larger than this value, doxygen will truncate the graph, which is visualized
2306 # by representing a node as a red box. Note that doxygen if the number of direct
2307 # children of the root node in a graph is already larger than
2308 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2309 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2310 # Minimum value: 0, maximum value: 10000, default value: 50.
2311 # This tag requires that the tag HAVE_DOT is set to YES.
2313 DOT_GRAPH_MAX_NODES = 50
2315 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2316 # generated by dot. A depth value of 3 means that only nodes reachable from the
2317 # root by following a path via at most 3 edges will be shown. Nodes that lay
2318 # further from the root node will be omitted. Note that setting this option to 1
2319 # or 2 may greatly reduce the computation time needed for large code bases. Also
2320 # note that the size of a graph can be further restricted by
2321 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2322 # Minimum value: 0, maximum value: 1000, default value: 0.
2323 # This tag requires that the tag HAVE_DOT is set to YES.
2325 MAX_DOT_GRAPH_DEPTH = 0
2327 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2328 # background. This is disabled by default, because dot on Windows does not seem
2329 # to support this out of the box.
2331 # Warning: Depending on the platform used, enabling this option may lead to
2332 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2334 # The default value is: NO.
2335 # This tag requires that the tag HAVE_DOT is set to YES.
2337 DOT_TRANSPARENT = NO
2339 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2340 # files in one run (i.e. multiple -o and -T options on the command line). This
2341 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2342 # this, this feature is disabled by default.
2343 # The default value is: NO.
2344 # This tag requires that the tag HAVE_DOT is set to YES.
2346 DOT_MULTI_TARGETS = NO
2348 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2349 # explaining the meaning of the various boxes and arrows in the dot generated
2351 # The default value is: YES.
2352 # This tag requires that the tag HAVE_DOT is set to YES.
2354 GENERATE_LEGEND = NO
2356 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2357 # files that are used to generate the various graphs.
2358 # The default value is: YES.
2359 # This tag requires that the tag HAVE_DOT is set to YES.