1 # Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 # This library is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU Lesser General Public
8 # License as published by the Free Software Foundation; either
9 # version 2.1 of the License.
11 # This library is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # Lesser General Public License for more details.
16 # You should have received a copy of the GNU Lesser General Public
17 # License along with this library; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 # This file describes the settings to be used by the documentation system
25 # All text after a hash (#) is considered a comment and will be ignored
27 # TAG = value [value, ...]
28 # For lists items can also be appended using:
29 # TAG += value [value, ...]
30 # Values that contain spaces should be placed between quotes (" ")
31 #---------------------------------------------------------------------------
32 # General configuration options
33 #---------------------------------------------------------------------------
34 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
35 # by quotes) that should identify the project.
39 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
40 # This could be handy for archiving the generated documentation or
41 # if some version control system is used.
45 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
46 # base path where the generated documentation will be put.
47 # If a relative path is entered, it will be relative to the location
48 # where doxygen was started. If left blank the current directory will be used.
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
57 # German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
58 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
60 OUTPUT_LANGUAGE = English
62 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
63 # documentation are documented, even if no documentation was available.
64 # Private class members and static file members will be hidden unless
65 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
69 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
70 # will be included in the documentation.
74 # If the EXTRACT_STATIC tag is set to YES all static members of a file
75 # will be included in the documentation.
79 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
80 # undocumented members of documented classes, files or namespaces.
81 # If set to NO (the default) these members will be included in the
82 # various overviews, but no documentation section is generated.
83 # This option has no effect if EXTRACT_ALL is enabled.
85 HIDE_UNDOC_MEMBERS = NO
87 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
88 # undocumented classes that are normally visible in the class hierarchy.
89 # If set to NO (the default) these class will be included in the various
90 # overviews. This option has no effect if EXTRACT_ALL is enabled.
92 HIDE_UNDOC_CLASSES = NO
94 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
95 # include brief member descriptions after the members that are listed in
96 # the file and class documentation (similar to JavaDoc).
97 # Set to NO to disable this.
99 BRIEF_MEMBER_DESC = YES
101 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
102 # the brief description of a member or function before the detailed description.
103 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
104 # brief descriptions will be completely suppressed.
108 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
109 # Doxygen will generate a detailed section even if there is only a brief
112 ALWAYS_DETAILED_SEC = NO
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115 # path before files name in the file list and in the header files. If set
116 # to NO the shortest path that makes the file name unique will be used.
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121 # can be used to strip a user defined part of the path. Stripping is
122 # only done if one of the specified strings matches the left-hand part of
123 # the path. It is allowed to use relative paths in the argument list.
127 # The INTERNAL_DOCS tag determines if documentation
128 # that is typed after a \internal command is included. If the tag is set
129 # to NO (the default) then the documentation will be excluded.
130 # Set it to YES to include the internal documentation.
134 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
135 # generate a class diagram (in Html and LaTeX) for classes with base or
136 # super classes. Setting the tag to NO turns the diagrams off.
140 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
141 # be generated. Documented entities will be cross-referenced with these sources.
145 # Setting the INLINE_SOURCES tag to YES will include the body
146 # of functions and classes directly in the documentation.
150 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
151 # doxygen to hide any special comment blocks from generated source code
152 # fragments. Normal C and C++ comments will always remain visible.
154 STRIP_CODE_COMMENTS = YES
156 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
157 # file names in lower case letters. If set to YES upper case letters are also
158 # allowed. This is useful if you have classes or files whose names only differ
159 # in case and if your file system supports case sensitive file names. Windows
160 # users are adviced to set this option to NO.
162 CASE_SENSE_NAMES = YES
164 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
165 # (but less readable) file names. This can be useful is your file systems
166 # doesn't support long names like on DOS, Mac, or CD-ROM.
170 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
171 # will show members with their full class and namespace scopes in the
172 # documentation. If set to YES the scope will be hidden.
174 HIDE_SCOPE_NAMES = NO
176 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
177 # will generate a verbatim copy of the header file for each class for
178 # which an include is specified. Set to NO to disable this.
180 VERBATIM_HEADERS = YES
182 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
183 # will put list of the files that are included by a file in the documentation
186 SHOW_INCLUDE_FILES = YES
188 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
189 # will interpret the first line (until the first dot) of a JavaDoc-style
190 # comment as the brief description. If set to NO, the JavaDoc
191 # comments will behave just like the Qt-style comments (thus requiring an
192 # explict @brief command for a brief description.
194 JAVADOC_AUTOBRIEF = NO
196 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
197 # member inherits the documentation from any documented member that it
202 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
203 # is inserted in the documentation for inline members.
207 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
208 # will sort the (detailed) documentation of file and class members
209 # alphabetically by member name. If set to NO the members will appear in
212 SORT_MEMBER_DOCS = YES
214 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
215 # tag is set to YES, then doxygen will reuse the documentation of the first
216 # member in the group (if any) for the other members of the group. By default
217 # all members of a group must be documented explicitly.
219 DISTRIBUTE_GROUP_DOC = NO
221 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
222 # Doxygen uses this value to replace tabs by spaces in code fragments.
226 # The ENABLED_SECTIONS tag can be used to enable conditional
227 # documentation sections, marked by \if sectionname ... \endif.
231 # The GENERATE_TODOLIST tag can be used to enable (YES) or
232 # disable (NO) the todo list. This list is created by putting \todo
233 # commands in the documentation.
235 GENERATE_TODOLIST = YES
237 # The GENERATE_TESTLIST tag can be used to enable (YES) or
238 # disable (NO) the test list. This list is created by putting \test
239 # commands in the documentation.
241 GENERATE_TESTLIST = YES
243 # The GENERATE_BUGLIST tag can be used to enable (YES) or
244 # disable (NO) the bug list. This list is created by putting \bug
245 # commands in the documentation.
247 GENERATE_BUGLIST = YES
249 # This tag can be used to specify a number of aliases that acts
250 # as commands in the documentation. An alias has the form "name=value".
251 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
252 # put the command \sideeffect (or @sideeffect) in the documentation, which
253 # will result in a user defined paragraph with heading "Side Effects:".
254 # You can put \n's in the value part of an alias to insert newlines.
258 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
259 # the initial value of a variable or define consist of for it to appear in
260 # the documentation. If the initializer consists of more lines than specified
261 # here it will be hidden. Use a value of 0 to hide initializers completely.
262 # The appearance of the initializer of individual variables and defines in the
263 # documentation can be controlled using \showinitializer or \hideinitializer
264 # command in the documentation regardless of this setting.
266 MAX_INITIALIZER_LINES = 30
268 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
269 # only. Doxygen will then generate output that is more tailored for C.
270 # For instance some of the names that are used will be different. The list
271 # of all members will be omitted, etc.
273 OPTIMIZE_OUTPUT_FOR_C = NO
275 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
276 # at the bottom of the documentation of classes and structs. If set to YES the
277 # list will mention the files that were used to generate the documentation.
279 SHOW_USED_FILES = YES
281 #---------------------------------------------------------------------------
282 # configuration options related to warning and progress messages
283 #---------------------------------------------------------------------------
285 # The QUIET tag can be used to turn on/off the messages that are generated
286 # by doxygen. Possible values are YES and NO. If left blank NO is used.
290 # The WARNINGS tag can be used to turn on/off the warning messages that are
291 # generated by doxygen. Possible values are YES and NO. If left blank
296 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
297 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
298 # automatically be disabled.
300 WARN_IF_UNDOCUMENTED = YES
302 # The WARN_FORMAT tag determines the format of the warning messages that
303 # doxygen can produce. The string should contain the $file, $line, and $text
304 # tags, which will be replaced by the file and line number from which the
305 # warning originated and the warning text.
309 # The WARN_LOGFILE tag can be used to specify a file to which warning
310 # and error messages should be written. If left blank the output is written
315 #---------------------------------------------------------------------------
316 # configuration options related to the input files
317 #---------------------------------------------------------------------------
319 # The INPUT tag can be used to specify the files and/or directories that contain
320 # documented source files. You may enter file names like "myfile.cpp" or
321 # directories like "/usr/src/myproject". Separate the files or directories
324 INPUT = /home01/prascle/devSalome/rootsrc
326 # If the value of the INPUT tag contains directories, you can use the
327 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
328 # and *.h) to filter out the source-files in the directories. If left
329 # blank all files are included.
331 FILE_PATTERNS = *idl *.cxx *.hxx *.hh *.h *.c *.cc *.py
333 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
334 # should be searched for input files as well. Possible values are YES and NO.
335 # If left blank NO is used.
339 # The EXCLUDE tag can be used to specify files and/or directories that should
340 # excluded from the INPUT source files. This way you can easily exclude a
341 # subdirectory from a directory tree whose root is specified with the INPUT tag.
345 # If the value of the INPUT tag contains directories, you can use the
346 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
347 # certain files from those directories.
351 # The EXAMPLE_PATH tag can be used to specify one or more files or
352 # directories that contain example code fragments that are included (see
353 # the \include command).
357 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
358 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
359 # and *.h) to filter out the source-files in the directories. If left
360 # blank all files are included.
364 # The IMAGE_PATH tag can be used to specify one or more files or
365 # directories that contain image that are included in the documentation (see
366 # the \image command).
370 # The INPUT_FILTER tag can be used to specify a program that doxygen should
371 # invoke to filter for each input file. Doxygen will invoke the filter program
372 # by executing (via popen()) the command <filter> <input-file>, where <filter>
373 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
374 # input file. Doxygen will then use the output that the filter program writes
375 # to standard output.
379 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
380 # INPUT_FILTER) will be used to filter the input files when producing source
383 FILTER_SOURCE_FILES = NO
385 #---------------------------------------------------------------------------
386 # configuration options related to the alphabetical class index
387 #---------------------------------------------------------------------------
389 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
390 # of all compounds will be generated. Enable this if the project
391 # contains a lot of classes, structs, unions or interfaces.
393 ALPHABETICAL_INDEX = NO
395 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
396 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
397 # in which this list will be split (can be a number in the range [1..20])
399 COLS_IN_ALPHA_INDEX = 5
401 # In case all classes in a project start with a common prefix, all
402 # classes will be put under the same header in the alphabetical index.
403 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
404 # should be ignored while generating the index headers.
408 #---------------------------------------------------------------------------
409 # configuration options related to the HTML output
410 #---------------------------------------------------------------------------
412 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
413 # generate HTML output.
417 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
418 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
419 # put in front of it. If left blank `html' will be used as the default path.
421 HTML_OUTPUT = /home01/prascle/devSalome/doc/html
423 # The HTML_HEADER tag can be used to specify a personal HTML header for
424 # each generated HTML page. If it is left blank doxygen will generate a
429 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
430 # each generated HTML page. If it is left blank doxygen will generate a
435 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
436 # style sheet that is used by each HTML page. It can be used to
437 # fine-tune the look of the HTML output. If the tag is left blank doxygen
438 # will generate a default style sheet
442 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
443 # files or namespaces will be aligned in HTML using tables. If set to
444 # NO a bullet list will be used.
446 HTML_ALIGN_MEMBERS = YES
448 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
449 # will be generated that can be used as input for tools like the
450 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
451 # of the generated HTML documentation.
453 GENERATE_HTMLHELP = NO
455 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
456 # controls if a separate .chi index file is generated (YES) or that
457 # it should be included in the master .chm file (NO).
461 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
462 # controls whether a binary table of contents is generated (YES) or a
463 # normal table of contents (NO) in the .chm file.
467 # The TOC_EXPAND flag can be set to YES to add extra items for group members
468 # to the contents of the Html help documentation and to the tree view.
472 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
473 # top of each HTML page. The value NO (the default) enables the index and
474 # the value YES disables it.
478 # This tag can be used to set the number of enum values (range [1..20])
479 # that doxygen will group on one line in the generated HTML documentation.
481 ENUM_VALUES_PER_LINE = 4
483 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
484 # generated containing a tree-like index structure (just like the one that
485 # is generated for HTML Help). For this to work a browser that supports
486 # JavaScript and frames is required (for instance Netscape 4.0+
487 # or Internet explorer 4.0+).
489 GENERATE_TREEVIEW = NO
491 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
492 # used to set the initial width (in pixels) of the frame in which the tree
497 #---------------------------------------------------------------------------
498 # configuration options related to the LaTeX output
499 #---------------------------------------------------------------------------
501 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
502 # generate Latex output.
506 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
507 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
508 # put in front of it. If left blank `latex' will be used as the default path.
510 LATEX_OUTPUT = /home01/prascle/devSalome/doc/latex
512 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
513 # LaTeX documents. This may be useful for small projects and may help to
514 # save some trees in general.
518 # The PAPER_TYPE tag can be used to set the paper type that is used
519 # by the printer. Possible values are: a4, a4wide, letter, legal and
520 # executive. If left blank a4wide will be used.
524 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
525 # packages that should be included in the LaTeX output.
529 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
530 # the generated latex document. The header should contain everything until
531 # the first chapter. If it is left blank doxygen will generate a
532 # standard header. Notice: only use this tag if you know what you are doing!
536 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
537 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
538 # contain links (just like the HTML output) instead of page references
539 # This makes the output suitable for online browsing using a pdf viewer.
543 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
544 # plain latex in the generated Makefile. Set this option to YES to get a
545 # higher quality PDF documentation.
549 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
550 # command to the generated LaTeX files. This will instruct LaTeX to keep
551 # running if errors occur, instead of asking the user for help.
552 # This option is also used when generating formulas in HTML.
556 #---------------------------------------------------------------------------
557 # configuration options related to the RTF output
558 #---------------------------------------------------------------------------
560 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
561 # The RTF output is optimised for Word 97 and may not look very pretty with
562 # other RTF readers or editors.
566 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
567 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
568 # put in front of it. If left blank `rtf' will be used as the default path.
572 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
573 # RTF documents. This may be useful for small projects and may help to
574 # save some trees in general.
578 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
579 # will contain hyperlink fields. The RTF file will
580 # contain links (just like the HTML output) instead of page references.
581 # This makes the output suitable for online browsing using WORD or other
582 # programs which support those fields.
583 # Note: wordpad (write) and others do not support links.
587 # Load stylesheet definitions from file. Syntax is similar to doxygen's
588 # config file, i.e. a series of assigments. You only have to provide
589 # replacements, missing definitions are set to their default value.
591 RTF_STYLESHEET_FILE =
593 # Set optional variables used in the generation of an rtf document.
594 # Syntax is similar to doxygen's config file.
596 RTF_EXTENSIONS_FILE =
598 #---------------------------------------------------------------------------
599 # configuration options related to the man page output
600 #---------------------------------------------------------------------------
602 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
607 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
608 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
609 # put in front of it. If left blank `man' will be used as the default path.
613 # The MAN_EXTENSION tag determines the extension that is added to
614 # the generated man pages (default is the subroutine's section .3)
618 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
619 # then it will generate one additional man file for each entity
620 # documented in the real man page(s). These additional files
621 # only source the real man page, but without them the man command
622 # would be unable to find the correct page. The default is NO.
626 #---------------------------------------------------------------------------
627 # Configuration options related to the preprocessor
628 #---------------------------------------------------------------------------
630 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
631 # evaluate all C-preprocessor directives found in the sources and include
634 ENABLE_PREPROCESSING = YES
636 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
637 # names in the source code. If set to NO (the default) only conditional
638 # compilation will be performed. Macro expansion can be done in a controlled
639 # way by setting EXPAND_ONLY_PREDEF to YES.
643 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
644 # then the macro expansion is limited to the macros specified with the
645 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
647 EXPAND_ONLY_PREDEF = NO
649 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
650 # in the INCLUDE_PATH (see below) will be search if a #include is found.
652 SEARCH_INCLUDES = YES
654 # The INCLUDE_PATH tag can be used to specify one or more directories that
655 # contain include files that are not input files but should be processed by
660 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
661 # patterns (like *.h and *.hpp) to filter out the header-files in the
662 # directories. If left blank, the patterns specified with FILE_PATTERNS will
665 INCLUDE_FILE_PATTERNS =
667 # The PREDEFINED tag can be used to specify one or more macro names that
668 # are defined before the preprocessor is started (similar to the -D option of
669 # gcc). The argument of the tag is a list of macros of the form: name
670 # or name=definition (no spaces). If the definition and the = are
671 # omitted =1 is assumed.
675 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
676 # this tag can be used to specify a list of macro names that should be expanded.
677 # The macro definition that is found in the sources will be used.
678 # Use the PREDEFINED tag if you want to use a different macro definition.
682 #---------------------------------------------------------------------------
683 # Configuration::addtions related to external references
684 #---------------------------------------------------------------------------
686 # The TAGFILES tag can be used to specify one or more tagfiles.
690 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
691 # a tag file that is based on the input files it reads.
695 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
696 # in the class index. If set to NO only the inherited external classes
701 # The PERL_PATH should be the absolute path and name of the perl script
702 # interpreter (i.e. the result of `which perl').
706 #---------------------------------------------------------------------------
707 # Configuration options related to the dot tool
708 #---------------------------------------------------------------------------
710 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
711 # available from the path. This tool is part of Graphviz, a graph visualization
712 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
713 # have no effect if this option is set to NO (the default)
717 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
718 # will generate a graph for each documented class showing the direct and
719 # indirect inheritance relations. Setting this tag to YES will force the
720 # the CLASS_DIAGRAMS tag to NO.
724 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
725 # will generate a graph for each documented class showing the direct and
726 # indirect implementation dependencies (inheritance, containment, and
727 # class references variables) of the class with other documented classes.
729 COLLABORATION_GRAPH = YES
731 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
732 # tags are set to YES then doxygen will generate a graph for each documented
733 # file showing the direct and indirect include dependencies of the file with
734 # other documented files.
738 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
739 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
740 # documented header file showing the documented files that directly or
741 # indirectly include this file.
743 INCLUDED_BY_GRAPH = YES
745 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
746 # will graphical hierarchy of all classes instead of a textual one.
748 GRAPHICAL_HIERARCHY = YES
750 # The tag DOT_PATH can be used to specify the path where the dot tool can be
751 # found. If left blank, it is assumed the dot tool can be found on the path.
755 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
756 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
757 # this value, doxygen will try to truncate the graph, so that it fits within
758 # the specified constraint. Beware that most browsers cannot cope with very
761 MAX_DOT_GRAPH_WIDTH = 1024
763 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
764 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
765 # this value, doxygen will try to truncate the graph, so that it fits within
766 # the specified constraint. Beware that most browsers cannot cope with very
769 MAX_DOT_GRAPH_HEIGHT = 1024
771 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
772 # generate a legend page explaining the meaning of the various boxes and
773 # arrows in the dot generated graphs.
775 GENERATE_LEGEND = YES
777 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
778 # remove the intermedate dot files that are used to generate
779 # the various graphs.
783 #---------------------------------------------------------------------------
784 # Configuration::addtions related to the search engine
785 #---------------------------------------------------------------------------
787 # The SEARCHENGINE tag specifies whether or not a search engine should be
788 # used. If set to NO the values of all tags below this one will be ignored.
792 # The CGI_NAME tag should be the name of the CGI script that
793 # starts the search engine (doxysearch) with the correct parameters.
794 # A script with this name will be generated by doxygen.
798 # The CGI_URL tag should be the absolute URL to the directory where the
799 # cgi binaries are located. See the documentation of your http daemon for
804 # The DOC_URL tag should be the absolute URL to the directory where the
805 # documentation is located. If left blank the absolute path to the
806 # documentation, with file:// prepended to it, will be used.
810 # The DOC_ABSPATH tag should be the absolute path to the directory where the
811 # documentation is located. If left blank the directory on the local machine
816 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
821 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
822 # documentation generated for other projects. This allows doxysearch to search
823 # the documentation for these projects as well.