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 hash (#) is considered a comment and will be ignored
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # This tag specifies the encoding used for all characters in the config file that
18 # follow. The default is UTF-8 which is also the encoding used for all text before
19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
23 DOXYFILE_ENCODING = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
34 PROJECT_NUMBER = $(DOX_VERSION)
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
41 OUTPUT_DIRECTORY = docs
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
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, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
57 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
58 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
59 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
60 # Swedish, and Ukrainian.
62 OUTPUT_LANGUAGE = English
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # include brief member descriptions after the members that are listed in
66 # the file and class documentation (similar to JavaDoc).
67 # Set to NO to disable this.
69 BRIEF_MEMBER_DESC = YES
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # the brief description of a member or function before the detailed description.
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74 # brief descriptions will be completely suppressed.
78 # This tag implements a quasi-intelligent brief description abbreviator
79 # that is used to form the text in various listings. Each string
80 # in this list, if found as the leading text of the brief description, will be
81 # stripped from the text and the result after processing the whole list, is
82 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # If left blank, the following values are used ("$name" is automatically
84 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # "The $name file" "is" "provides" "specifies" "contains"
86 # "represents" "a" "an" "the"
88 ABBREVIATE_BRIEF = "The $name class" \
100 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
101 # Doxygen will generate a detailed section even if there is only a brief
104 ALWAYS_DETAILED_SEC = YES
106 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
107 # inherited members of a class in the documentation of that class as if those
108 # members were ordinary class members. Constructors, destructors and assignment
109 # operators of the base classes will not be shown.
111 INLINE_INHERITED_MEMB = NO
113 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
114 # path before files name in the file list and in the header files. If set
115 # to NO the shortest path that makes the file name unique will be used.
117 FULL_PATH_NAMES = YES
119 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
120 # can be used to strip a user-defined part of the path. Stripping is
121 # only done if one of the specified strings matches the left-hand part of
122 # the path. The tag can be used to show relative paths in the file list.
123 # If left blank the directory from which doxygen is run is used as the
128 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
129 # the path mentioned in the documentation of a class, which tells
130 # the reader which header file to include in order to use a class.
131 # If left blank only the name of the header file containing the class
132 # definition is used. Otherwise one should specify the include paths that
133 # are normally passed to the compiler using the -I flag.
135 STRIP_FROM_INC_PATH =
137 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
138 # (but less readable) file names. This can be useful is your file systems
139 # doesn't support long names like on DOS, Mac, or CD-ROM.
143 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
144 # will interpret the first line (until the first dot) of a JavaDoc-style
145 # comment as the brief description. If set to NO, the JavaDoc
146 # comments will behave just like the Qt-style comments (thus requiring an
147 # explicit @brief command for a brief description.
149 JAVADOC_AUTOBRIEF = NO
151 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
152 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
153 # comments) as a brief description. This used to be the default behaviour.
154 # The new default is to treat a multi-line C++ comment block as a detailed
155 # description. Set this tag to YES if you prefer the old behaviour instead.
157 MULTILINE_CPP_IS_BRIEF = NO
159 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
160 # will output the detailed description near the top, like JavaDoc.
161 # If set to NO, the detailed description appears after the member
166 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
167 # member inherits the documentation from any documented member that it
172 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
173 # tag is set to YES, then doxygen will reuse the documentation of the first
174 # member in the group (if any) for the other members of the group. By default
175 # all members of a group must be documented explicitly.
177 DISTRIBUTE_GROUP_DOC = YES
179 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
180 # a new page for each member. If set to NO, the documentation of a member will
181 # be part of the file/class/namespace that contains it.
183 SEPARATE_MEMBER_PAGES = NO
185 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
186 # Doxygen uses this value to replace tabs by spaces in code fragments.
190 # This tag can be used to specify a number of aliases that acts
191 # as commands in the documentation. An alias has the form "name=value".
192 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
193 # put the command \sideeffect (or @sideeffect) in the documentation, which
194 # will result in a user-defined paragraph with heading "Side Effects:".
195 # You can put \n's in the value part of an alias to insert newlines.
197 ALIASES = "hint=<em>Hint! " \
199 "dev=\if dev\n<em>Dev:</em> " \
201 "ext=\if ext\n<b>Ext:</b> " \
203 "guide=<A HREF='http://opensg.vrsource.org/trac/wiki/DevGuide/^1^'>^1^</A>" \
204 "wiki=<A HREF='http://opensg.vrsource.org/trac/wiki/^1^'>^1^</A>" \
207 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
208 # sources only. Doxygen will then generate output that is more tailored for C.
209 # For instance, some of the names that are used will be different. The list
210 # of all members will be omitted, etc.
212 OPTIMIZE_OUTPUT_FOR_C = NO
214 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
215 # only. Doxygen will then generate output that is more tailored for Java.
216 # For instance, namespaces will be presented as packages, qualified scopes
217 # will look different, etc.
219 OPTIMIZE_OUTPUT_JAVA = NO
221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
222 # include (a tag file for) the STL sources as input, then you should
223 # set this tag to YES in order to let doxygen match functions declarations and
224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225 # func(std::string) {}). This also make the inheritance and collaboration
226 # diagrams that involve STL classes more complete and accurate.
228 BUILTIN_STL_SUPPORT = YES
230 # If you use Microsoft's C++/CLI language, you should set this option to YES to
231 # enable parsing support.
235 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
236 # the same type (for instance a group of public functions) to be put as a
237 # subgroup of that type (e.g. under the Public Functions section). Set it to
238 # NO to prevent subgrouping. Alternatively, this can be done per class using
239 # the \nosubgrouping command.
243 #---------------------------------------------------------------------------
244 # Build related configuration options
245 #---------------------------------------------------------------------------
247 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
248 # documentation are documented, even if no documentation was available.
249 # Private class members and static file members will be hidden unless
250 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
254 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
255 # will be included in the documentation.
257 EXTRACT_PRIVATE = YES
259 # If the EXTRACT_STATIC tag is set to YES all static members of a file
260 # will be included in the documentation.
264 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
265 # defined locally in source files will be included in the documentation.
266 # If set to NO only classes defined in header files are included.
268 EXTRACT_LOCAL_CLASSES = YES
270 # This flag is only useful for Objective-C code. When set to YES local
271 # methods, which are defined in the implementation section but not in
272 # the interface are included in the documentation.
273 # If set to NO (the default) only methods in the interface are included.
275 EXTRACT_LOCAL_METHODS = NO
277 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
278 # undocumented members of documented classes, files or namespaces.
279 # If set to NO (the default) these members will be included in the
280 # various overviews, but no documentation section is generated.
281 # This option has no effect if EXTRACT_ALL is enabled.
283 HIDE_UNDOC_MEMBERS = NO
285 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
286 # undocumented classes that are normally visible in the class hierarchy.
287 # If set to NO (the default) these classes will be included in the various
288 # overviews. This option has no effect if EXTRACT_ALL is enabled.
290 HIDE_UNDOC_CLASSES = NO
292 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
293 # friend (class|struct|union) declarations.
294 # If set to NO (the default) these declarations will be included in the
297 HIDE_FRIEND_COMPOUNDS = NO
299 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
300 # documentation blocks found inside the body of a function.
301 # If set to NO (the default) these blocks will be appended to the
302 # function's detailed documentation block.
304 HIDE_IN_BODY_DOCS = NO
306 # The INTERNAL_DOCS tag determines if documentation
307 # that is typed after a \internal command is included. If the tag is set
308 # to NO (the default) then the documentation will be excluded.
309 # Set it to YES to include the internal documentation.
313 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
314 # file names in lower-case letters. If set to YES upper-case letters are also
315 # allowed. This is useful if you have classes or files whose names only differ
316 # in case and if your file system supports case sensitive file names. Windows
317 # and Mac users are advised to set this option to NO.
319 CASE_SENSE_NAMES = YES
321 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
322 # will show members with their full class and namespace scopes in the
323 # documentation. If set to YES the scope will be hidden.
325 HIDE_SCOPE_NAMES = NO
327 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
328 # will put a list of the files that are included by a file in the documentation
331 SHOW_INCLUDE_FILES = YES
333 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
334 # is inserted in the documentation for inline members.
338 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
339 # will sort the (detailed) documentation of file and class members
340 # alphabetically by member name. If set to NO the members will appear in
343 SORT_MEMBER_DOCS = NO
345 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
346 # brief documentation of file, namespace and class members alphabetically
347 # by member name. If set to NO (the default) the members will appear in
352 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
353 # sorted by fully-qualified names, including namespaces. If set to
354 # NO (the default), the class list will be sorted only by class name,
355 # not including the namespace part.
356 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
357 # Note: This option applies only to the class list, not to the
360 SORT_BY_SCOPE_NAME = NO
362 # The GENERATE_TODOLIST tag can be used to enable (YES) or
363 # disable (NO) the todo list. This list is created by putting \todo
364 # commands in the documentation.
366 GENERATE_TODOLIST = YES
368 # The GENERATE_TESTLIST tag can be used to enable (YES) or
369 # disable (NO) the test list. This list is created by putting \test
370 # commands in the documentation.
372 GENERATE_TESTLIST = YES
374 # The GENERATE_BUGLIST tag can be used to enable (YES) or
375 # disable (NO) the bug list. This list is created by putting \bug
376 # commands in the documentation.
378 GENERATE_BUGLIST = YES
380 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
381 # disable (NO) the deprecated list. This list is created by putting
382 # \deprecated commands in the documentation.
384 GENERATE_DEPRECATEDLIST= YES
386 # The ENABLED_SECTIONS tag can be used to enable conditional
387 # documentation sections, marked by \if sectionname ... \endif.
389 ENABLED_SECTIONS = ext dev dev_traits
391 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
392 # the initial value of a variable or define consists of for it to appear in
393 # the documentation. If the initializer consists of more lines than specified
394 # here it will be hidden. Use a value of 0 to hide initializers completely.
395 # The appearance of the initializer of individual variables and defines in the
396 # documentation can be controlled using \showinitializer or \hideinitializer
397 # command in the documentation regardless of this setting.
399 MAX_INITIALIZER_LINES = 30
401 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
402 # at the bottom of the documentation of classes and structs. If set to YES the
403 # list will mention the files that were used to generate the documentation.
405 SHOW_USED_FILES = YES
407 # If the sources in your project are distributed over multiple directories
408 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
409 # in the documentation. The default is YES.
411 SHOW_DIRECTORIES = YES
413 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
414 # doxygen should invoke to get the current version for each file (typically from the
415 # version control system). Doxygen will invoke the program by executing (via
416 # popen()) the command <command> <input-file>, where <command> is the value of
417 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
418 # provided by doxygen. Whatever the progam writes to standard output
419 # is used as the file version. See the manual for examples.
421 FILE_VERSION_FILTER =
423 #---------------------------------------------------------------------------
424 # configuration options related to warning and progress messages
425 #---------------------------------------------------------------------------
427 # The QUIET tag can be used to turn on/off the messages that are generated
428 # by doxygen. Possible values are YES and NO. If left blank NO is used.
432 # The WARNINGS tag can be used to turn on/off the warning messages that are
433 # generated by doxygen. Possible values are YES and NO. If left blank
438 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
439 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
440 # automatically be disabled.
442 WARN_IF_UNDOCUMENTED = YES
444 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
445 # potential errors in the documentation, such as not documenting some
446 # parameters in a documented function, or documenting parameters that
447 # don't exist or using markup commands wrongly.
449 WARN_IF_DOC_ERROR = YES
451 # This WARN_NO_PARAMDOC option can be abled to get warnings for
452 # functions that are documented, but have no documentation for their parameters
453 # or return value. If set to NO (the default) doxygen will only warn about
454 # wrong or incomplete parameter documentation, but not about the absence of
457 WARN_NO_PARAMDOC = NO
459 # The WARN_FORMAT tag determines the format of the warning messages that
460 # doxygen can produce. The string should contain the $file, $line, and $text
461 # tags, which will be replaced by the file and line number from which the
462 # warning originated and the warning text. Optionally the format may contain
463 # $version, which will be replaced by the version of the file (if it could
464 # be obtained via FILE_VERSION_FILTER)
466 WARN_FORMAT = "$file:$line: $text"
468 # The WARN_LOGFILE tag can be used to specify a file to which warning
469 # and error messages should be written. If left blank the output is written
474 #---------------------------------------------------------------------------
475 # configuration options related to the input files
476 #---------------------------------------------------------------------------
478 # The INPUT tag can be used to specify the files and/or directories that contain
479 # documented source files. You may enter file names like "myfile.cpp" or
480 # directories like "/usr/src/myproject". Separate the files or directories
483 #INPUT = $(DOX_INPUT)
485 # The input is generated dynamically to get around environment length
488 @INCLUDE = opensg_input.doxy
491 # If the value of the INPUT tag contains directories, you can use the
492 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
493 # and *.h) to filter out the source-files in the directories. If left
494 # blank the following patterns are tested:
495 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
496 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
498 FILE_PATTERNS = OSG*.cpp \
503 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
504 # should be searched for input files as well. Possible values are YES and NO.
505 # If left blank NO is used.
509 # The EXCLUDE tag can be used to specify files and/or directories that should
510 # excluded from the INPUT source files. This way you can easily exclude a
511 # subdirectory from a directory tree whose root is specified with the INPUT tag.
515 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
516 # directories that are symbolic links (a Unix filesystem feature) are excluded
519 EXCLUDE_SYMLINKS = NO
521 # If the value of the INPUT tag contains directories, you can use the
522 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
523 # certain files from those directories. Note that the wildcards are matched
524 # against the file with absolute path, so to exclude all test directories
525 # for example use the pattern */test/*
527 EXCLUDE_PATTERNS = */ScanParseSkel/* \
529 */OSGStatisticsDefaultFont* \
530 */OSGGraphicStatisticsFont* \
533 # The EXAMPLE_PATH tag can be used to specify one or more files or
534 # directories that contain example code fragments that are included (see
535 # the \include command).
539 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
540 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
541 # and *.h) to filter out the source-files in the directories. If left
542 # blank all files are included.
546 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
547 # searched for input files to be used with the \include or \dontinclude
548 # commands irrespective of the value of the RECURSIVE tag.
549 # Possible values are YES and NO. If left blank NO is used.
551 EXAMPLE_RECURSIVE = NO
553 # The IMAGE_PATH tag can be used to specify one or more files or
554 # directories that contain image that are included in the documentation (see
555 # the \image command).
559 # The INPUT_FILTER tag can be used to specify a program that doxygen should
560 # invoke to filter for each input file. Doxygen will invoke the filter program
561 # by executing (via popen()) the command <filter> <input-file>, where <filter>
562 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
563 # input file. Doxygen will then use the output that the filter program writes
564 # to standard output. If FILTER_PATTERNS is specified, this tag will be
569 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
570 # basis. Doxygen will compare the file name with each pattern and apply the
571 # filter if there is a match. The filters are a list of the form:
572 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
573 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
574 # is applied to all files.
578 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
579 # INPUT_FILTER) will be used to filter the input files when producing source
580 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
582 FILTER_SOURCE_FILES = NO
584 #---------------------------------------------------------------------------
585 # configuration options related to source browsing
586 #---------------------------------------------------------------------------
588 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
589 # be generated. Documented entities will be cross-referenced with these sources.
590 # Note: To get rid of all source code in the generated output, make sure also
591 # VERBATIM_HEADERS is set to NO.
595 # Setting the INLINE_SOURCES tag to YES will include the body
596 # of functions and classes directly in the documentation.
600 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
601 # doxygen to hide any special comment blocks from generated source code
602 # fragments. Normal C and C++ comments will always remain visible.
604 STRIP_CODE_COMMENTS = YES
606 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
607 # then for each documented function all documented
608 # functions referencing it will be listed.
610 REFERENCED_BY_RELATION = YES
612 # If the REFERENCES_RELATION tag is set to YES (the default)
613 # then for each documented function all documented entities
614 # called/used by that function will be listed.
616 REFERENCES_RELATION = YES
618 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
619 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
620 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
621 # link to the source code. Otherwise they will link to the documentstion.
623 REFERENCES_LINK_SOURCE = YES
625 # If the USE_HTAGS tag is set to YES then the references to source code
626 # will point to the HTML generated by the htags(1) tool instead of doxygen
627 # built-in source browser. The htags tool is part of GNU's global source
628 # tagging system (see http://www.gnu.org/software/global/global.html). You
629 # will need version 4.8.6 or higher.
633 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
634 # will generate a verbatim copy of the header file for each class for
635 # which an include is specified. Set to NO to disable this.
637 VERBATIM_HEADERS = YES
639 #---------------------------------------------------------------------------
640 # configuration options related to the alphabetical class index
641 #---------------------------------------------------------------------------
643 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
644 # of all compounds will be generated. Enable this if the project
645 # contains a lot of classes, structs, unions or interfaces.
647 ALPHABETICAL_INDEX = YES
649 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
650 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
651 # in which this list will be split (can be a number in the range [1..20])
653 COLS_IN_ALPHA_INDEX = 1
655 # In case all classes in a project start with a common prefix, all
656 # classes will be put under the same header in the alphabetical index.
657 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
658 # should be ignored while generating the index headers.
660 IGNORE_PREFIX = osg OSG
662 #---------------------------------------------------------------------------
663 # configuration options related to the HTML output
664 #---------------------------------------------------------------------------
666 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
667 # generate HTML output.
671 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
672 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
673 # put in front of it. If left blank `html' will be used as the default path.
677 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
678 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
679 # doxygen will generate files with .html extension.
681 HTML_FILE_EXTENSION = .html
683 # The HTML_HEADER tag can be used to specify a personal HTML header for
684 # each generated HTML page. If it is left blank doxygen will generate a
689 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
690 # each generated HTML page. If it is left blank doxygen will generate a
695 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
696 # style sheet that is used by each HTML page. It can be used to
697 # fine-tune the look of the HTML output. If the tag is left blank doxygen
698 # will generate a default style sheet. Note that doxygen will try to copy
699 # the style sheet file to the HTML output directory, so don't put your own
700 # stylesheet in the HTML output directory as well, or it will be erased!
704 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
705 # files or namespaces will be aligned in HTML using tables. If set to
706 # NO a bullet list will be used.
708 HTML_ALIGN_MEMBERS = YES
710 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
711 # will be generated that can be used as input for tools like the
712 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
713 # of the generated HTML documentation.
715 ### !!! This crashes and breaks the whole doc on 1.5.1 !!!
716 # GENERATE_HTMLHELP = YES
717 GENERATE_HTMLHELP = NO
720 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
721 # be used to specify the file name of the resulting .chm file. You
722 # can add a path in front of the file if the result should not be
723 # written to the html output directory.
727 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
728 # be used to specify the location (absolute path including file name) of
729 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
730 # the HTML help compiler on the generated index.hhp.
732 HHC_LOCATION = /bin/echo
734 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
735 # controls if a separate .chi index file is generated (YES) or that
736 # it should be included in the master .chm file (NO).
740 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
741 # controls whether a binary table of contents is generated (YES) or a
742 # normal table of contents (NO) in the .chm file.
746 # The TOC_EXPAND flag can be set to YES to add extra items for group members
747 # to the contents of the HTML help documentation and to the tree view.
751 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
752 # top of each HTML page. The value NO (the default) enables the index and
753 # the value YES disables it.
757 # This tag can be used to set the number of enum values (range [1..20])
758 # that doxygen will group on one line in the generated HTML documentation.
760 ENUM_VALUES_PER_LINE = 4
762 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
763 # generated containing a tree-like index structure (just like the one that
764 # is generated for HTML Help). For this to work a browser that supports
765 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
766 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
767 # probably better off using the HTML help feature.
769 GENERATE_TREEVIEW = NO
771 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
772 # used to set the initial width (in pixels) of the frame in which the tree
777 #---------------------------------------------------------------------------
778 # configuration options related to the LaTeX output
779 #---------------------------------------------------------------------------
781 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
782 # generate Latex output.
786 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
787 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
788 # put in front of it. If left blank `latex' will be used as the default path.
792 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
793 # invoked. If left blank `latex' will be used as the default command name.
795 LATEX_CMD_NAME = latex
797 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
798 # generate index for LaTeX. If left blank `makeindex' will be used as the
799 # default command name.
801 MAKEINDEX_CMD_NAME = makeindex
803 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
804 # LaTeX documents. This may be useful for small projects and may help to
805 # save some trees in general.
809 # The PAPER_TYPE tag can be used to set the paper type that is used
810 # by the printer. Possible values are: a4, a4wide, letter, legal and
811 # executive. If left blank a4wide will be used.
815 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
816 # packages that should be included in the LaTeX output.
818 EXTRA_PACKAGES = times
820 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
821 # the generated latex document. The header should contain everything until
822 # the first chapter. If it is left blank doxygen will generate a
823 # standard header. Notice: only use this tag if you know what you are doing!
827 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
828 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
829 # contain links (just like the HTML output) instead of page references
830 # This makes the output suitable for online browsing using a pdf viewer.
834 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
835 # plain latex in the generated Makefile. Set this option to YES to get a
836 # higher quality PDF documentation.
840 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
841 # command to the generated LaTeX files. This will instruct LaTeX to keep
842 # running if errors occur, instead of asking the user for help.
843 # This option is also used when generating formulas in HTML.
847 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
848 # include the index chapters (such as File Index, Compound Index, etc.)
851 LATEX_HIDE_INDICES = NO
853 #---------------------------------------------------------------------------
854 # configuration options related to the RTF output
855 #---------------------------------------------------------------------------
857 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
858 # The RTF output is optimized for Word 97 and may not look very pretty with
859 # other RTF readers or editors.
863 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
864 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
865 # put in front of it. If left blank `rtf' will be used as the default path.
869 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
870 # RTF documents. This may be useful for small projects and may help to
871 # save some trees in general.
875 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
876 # will contain hyperlink fields. The RTF file will
877 # contain links (just like the HTML output) instead of page references.
878 # This makes the output suitable for online browsing using WORD or other
879 # programs which support those fields.
880 # Note: wordpad (write) and others do not support links.
884 # Load stylesheet definitions from file. Syntax is similar to doxygen's
885 # config file, i.e. a series of assignments. You only have to provide
886 # replacements, missing definitions are set to their default value.
888 RTF_STYLESHEET_FILE =
890 # Set optional variables used in the generation of an rtf document.
891 # Syntax is similar to doxygen's config file.
893 RTF_EXTENSIONS_FILE =
895 #---------------------------------------------------------------------------
896 # configuration options related to the man page output
897 #---------------------------------------------------------------------------
899 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
904 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
905 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
906 # put in front of it. If left blank `man' will be used as the default path.
910 # The MAN_EXTENSION tag determines the extension that is added to
911 # the generated man pages (default is the subroutine's section .3)
915 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
916 # then it will generate one additional man file for each entity
917 # documented in the real man page(s). These additional files
918 # only source the real man page, but without them the man command
919 # would be unable to find the correct page. The default is NO.
923 #---------------------------------------------------------------------------
924 # configuration options related to the XML output
925 #---------------------------------------------------------------------------
927 # If the GENERATE_XML tag is set to YES Doxygen will
928 # generate an XML file that captures the structure of
929 # the code including all documentation.
933 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
934 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
935 # put in front of it. If left blank `xml' will be used as the default path.
939 # The XML_SCHEMA tag can be used to specify an XML schema,
940 # which can be used by a validating XML parser to check the
941 # syntax of the XML files.
945 # The XML_DTD tag can be used to specify an XML DTD,
946 # which can be used by a validating XML parser to check the
947 # syntax of the XML files.
951 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
952 # dump the program listings (including syntax highlighting
953 # and cross-referencing information) to the XML output. Note that
954 # enabling this will significantly increase the size of the XML output.
956 XML_PROGRAMLISTING = YES
958 #---------------------------------------------------------------------------
959 # configuration options for the AutoGen Definitions output
960 #---------------------------------------------------------------------------
962 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
963 # generate an AutoGen Definitions (see autogen.sf.net) file
964 # that captures the structure of the code including all
965 # documentation. Note that this feature is still experimental
966 # and incomplete at the moment.
968 GENERATE_AUTOGEN_DEF = NO
970 #---------------------------------------------------------------------------
971 # configuration options related to the Perl module output
972 #---------------------------------------------------------------------------
974 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
975 # generate a Perl module file that captures the structure of
976 # the code including all documentation. Note that this
977 # feature is still experimental and incomplete at the
980 GENERATE_PERLMOD = NO
982 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
983 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
984 # to generate PDF and DVI output from the Perl module output.
988 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
989 # nicely formatted so it can be parsed by a human reader. This is useful
990 # if you want to understand what is going on. On the other hand, if this
991 # tag is set to NO the size of the Perl module output will be much smaller
992 # and Perl will parse it just the same.
996 # The names of the make variables in the generated doxyrules.make file
997 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
998 # This is useful so different doxyrules.make files included by the same
999 # Makefile don't overwrite each other's variables.
1001 PERLMOD_MAKEVAR_PREFIX =
1003 #---------------------------------------------------------------------------
1004 # Configuration options related to the preprocessor
1005 #---------------------------------------------------------------------------
1007 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1008 # evaluate all C-preprocessor directives found in the sources and include
1011 ENABLE_PREPROCESSING = YES
1013 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1014 # names in the source code. If set to NO (the default) only conditional
1015 # compilation will be performed. Macro expansion can be done in a controlled
1016 # way by setting EXPAND_ONLY_PREDEF to YES.
1018 MACRO_EXPANSION = YES
1020 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1021 # then the macro expansion is limited to the macros specified with the
1022 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
1024 EXPAND_ONLY_PREDEF = YES
1026 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1027 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1029 SEARCH_INCLUDES = YES
1031 # The INCLUDE_PATH tag can be used to specify one or more directories that
1032 # contain include files that are not input files but should be processed by
1037 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1038 # patterns (like *.h and *.hpp) to filter out the header-files in the
1039 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1042 INCLUDE_FILE_PATTERNS =
1044 # The PREDEFINED tag can be used to specify one or more macro names that
1045 # are defined before the preprocessor is started (similar to the -D option of
1046 # gcc). The argument of the tag is a list of macros of the form: name
1047 # or name=definition (no spaces). If the definition and the = are
1048 # omitted =1 is assumed. To prevent a macro definition from being
1049 # undefined via #undef or recursively expanded use the := operator
1050 # instead of the = operator.
1052 PREDEFINED = DOC_LEVEL=3 \
1053 DOC_LEVEL_NAME=dev \
1056 OSG_DOC_DEV_TRAITS \
1057 "OSG_BEGIN_NAMESPACE=namespace OSG {" \
1058 OSG_END_NAMESPACE=} \
1059 "OSG_USING_NAMESPACE=namespace OSG {} using namespace OSG;" \
1062 DOXYGEN_SHOULD_SKIP_THIS \
1067 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1068 # this tag can be used to specify a list of macro names that should be expanded.
1069 # The macro definition that is found in the sources will be used.
1070 # Use the PREDEFINED tag if you want to use a different macro definition.
1072 EXPAND_AS_DEFINED = OSG_CHECK_ARG \
1073 OSG_BASELIB_DLLMAPPING \
1074 OSG_SYSTEMLIB_DLLMAPPING \
1078 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1079 # doxygen's preprocessor will remove all function-like macros that are alone
1080 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1081 # function macros are typically used for boiler-plate code, and will confuse
1082 # the parser if not removed.
1084 SKIP_FUNCTION_MACROS = YES
1086 #---------------------------------------------------------------------------
1087 # Configuration::additions related to external references
1088 #---------------------------------------------------------------------------
1090 # The TAGFILES option can be used to specify one or more tagfiles.
1091 # Optionally an initial location of the external documentation
1092 # can be added for each tagfile. The format of a tag file without
1093 # this location is as follows:
1094 # TAGFILES = file1 file2 ...
1095 # Adding location for the tag files is done as follows:
1096 # TAGFILES = file1=loc1 "file2 = loc2" ...
1097 # where "loc1" and "loc2" can be relative or absolute paths or
1098 # URLs. If a location is present for each tag, the installdox tool
1099 # does not have to be run to correct the links.
1100 # Note that each tag file must have a unique name
1101 # (where the name does NOT include the path)
1102 # If a tag file is not located in the directory in which doxygen
1103 # is run, you must also specify the path to the tagfile here.
1107 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1108 # a tag file that is based on the input files it reads.
1112 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1113 # in the class index. If set to NO only the inherited external classes
1118 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1119 # in the modules index. If set to NO, only the current project's groups will
1122 EXTERNAL_GROUPS = YES
1124 # The PERL_PATH should be the absolute path and name of the perl script
1125 # interpreter (i.e. the result of `which perl').
1127 PERL_PATH = /usr/bin/perl
1129 #---------------------------------------------------------------------------
1130 # Configuration options related to the dot tool
1131 #---------------------------------------------------------------------------
1133 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1134 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1135 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1136 # this option is superseded by the HAVE_DOT option below. This is only a
1137 # fallback. It is recommended to install and use dot, since it yields more
1140 CLASS_DIAGRAMS = YES
1142 # If set to YES, the inheritance and collaboration graphs will hide
1143 # inheritance and usage relations if the target is undocumented
1144 # or is not a class.
1146 HIDE_UNDOC_RELATIONS = YES
1148 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1149 # available from the path. This tool is part of Graphviz, a graph visualization
1150 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1151 # have no effect if this option is set to NO (the default)
1155 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1156 # will generate a graph for each documented class showing the direct and
1157 # indirect inheritance relations. Setting this tag to YES will force the
1158 # the CLASS_DIAGRAMS tag to NO.
1162 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1163 # will generate a graph for each documented class showing the direct and
1164 # indirect implementation dependencies (inheritance, containment, and
1165 # class references variables) of the class with other documented classes.
1167 COLLABORATION_GRAPH = YES
1169 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1170 # will generate a graph for groups, showing the direct groups dependencies
1174 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1175 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1180 # If set to YES, the inheritance and collaboration graphs will show the
1181 # relations between templates and their instances.
1183 TEMPLATE_RELATIONS = YES
1185 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1186 # tags are set to YES then doxygen will generate a graph for each documented
1187 # file showing the direct and indirect include dependencies of the file with
1188 # other documented files.
1192 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1193 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1194 # documented header file showing the documented files that directly or
1195 # indirectly include this file.
1197 INCLUDED_BY_GRAPH = YES
1199 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1200 # generate a call dependency graph for every global function or class method.
1201 # Note that enabling this option will significantly increase the time of a run.
1202 # So in most cases it will be better to enable call graphs for selected
1203 # functions only using the \callgraph command.
1207 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1208 # generate a caller dependency graph for every global function or class method.
1209 # Note that enabling this option will significantly increase the time of a run.
1210 # So in most cases it will be better to enable caller graphs for selected
1211 # functions only using the \callergraph command.
1215 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1216 # will graphical hierarchy of all classes instead of a textual one.
1218 GRAPHICAL_HIERARCHY = YES
1220 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1221 # then doxygen will show the dependencies a directory has on other directories
1222 # in a graphical way. The dependency relations are determined by the #include
1223 # relations between the files in the directories.
1225 DIRECTORY_GRAPH = NO
1227 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1228 # generated by dot. Possible values are png, jpg, or gif
1229 # If left blank png will be used.
1231 DOT_IMAGE_FORMAT = png
1233 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1234 # found. If left blank, it is assumed the dot tool can be found in the path.
1238 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1239 # contain dot files that are included in the documentation (see the
1240 # \dotfile command).
1244 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1245 # nodes that will be shown in the graph. If the number of nodes in a graph
1246 # becomes larger than this value, doxygen will truncate the graph, which is
1247 # visualized by representing a node as a red box. Note that doxygen will always
1248 # show the root nodes and its direct children regardless of this setting.
1250 DOT_GRAPH_MAX_NODES = 50
1252 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1253 # background. This is disabled by default, which results in a white background.
1254 # Warning: Depending on the platform used, enabling this option may lead to
1255 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1258 DOT_TRANSPARENT = NO
1260 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1261 # files in one run (i.e. multiple -o and -T options on the command line). This
1262 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1263 # support this, this feature is disabled by default.
1265 DOT_MULTI_TARGETS = YES
1267 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1268 # generate a legend page explaining the meaning of the various boxes and
1269 # arrows in the dot generated graphs.
1271 GENERATE_LEGEND = YES
1273 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1274 # remove the intermediate dot files that are used to generate
1275 # the various graphs.
1279 #---------------------------------------------------------------------------
1280 # Configuration::additions related to the search engine
1281 #---------------------------------------------------------------------------
1283 # The SEARCHENGINE tag specifies whether or not a search engine should be
1284 # used. If set to NO the values of all tags below this one will be ignored.