Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/doc/api/doxy.config.in @ 8038

Last change on this file since 8038 was 7818, checked in by rgrieder, 14 years ago

Merged changes related to Visual Leak Detector and source file handling from sandbox QT to trunk.

  • Property svn:eol-style set to native
File size: 66.0 KB
RevLine 
[7401]1# Doxyfile 1.6.3
[2633]2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8#       TAG = value [value, ...]
9# For lists items can also be appended using:
10#       TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
[7401]17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING      = UTF-8
24
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
[2633]26# by quotes) that should identify the project.
27
28PROJECT_NAME           = "@PROJECT_NAME@"
29
[7401]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
[2633]32# if some version control system is used.
33
[2880]34PROJECT_NUMBER         = "@ORXONOX_VERSION@ Codename: @ORXONOX_VERSION_NAME@"
[2633]35
[7401]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
[2633]39# where doxygen was started. If left blank the current directory will be used.
40
[2656]41OUTPUT_DIRECTORY       = @DOXY_OUTPUT_DIR@
[2633]42
[7401]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
[2633]48# otherwise cause performance problems for the file system.
49
50CREATE_SUBDIRS         = NO
51
[7401]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# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
[2633]62
63OUTPUT_LANGUAGE        = English
64
[7401]65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
[2633]68# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC      = YES
71
[7401]72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
[2633]75# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF           = YES
78
[7401]79# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
[2633]87# "represents" "a" "an" "the"
88
[2874]89ABBREVIATE_BRIEF       = "The $name class" \
90                         "The $name widget" \
91                         "The $name file" \
92                         is \
93                         provides \
94                         specifies \
95                         contains \
96                         represents \
97                         a \
98                         an \
99                         the
[2633]100
[7401]101# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102# Doxygen will generate a detailed section even if there is only a brief
[2633]103# description.
104
105ALWAYS_DETAILED_SEC    = NO
106
[7401]107# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108# inherited members of a class in the documentation of that class as if those
109# members were ordinary class members. Constructors, destructors and assignment
[2633]110# operators of the base classes will not be shown.
111
[2891]112INLINE_INHERITED_MEMB  = NO
[2633]113
[7401]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
[2633]116# to NO the shortest path that makes the file name unique will be used.
117
118FULL_PATH_NAMES        = YES
119
[7401]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. The tag can be used to show relative paths in the file list.
124# If left blank the directory from which doxygen is run is used as the
[2633]125# path to strip.
126
[7401]127STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@/src \
128                         @CMAKE_BINARY_DIR@/src
[2633]129
[7401]130# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
131# the path mentioned in the documentation of a class, which tells
132# the reader which header file to include in order to use a class.
133# If left blank only the name of the header file containing the class
134# definition is used. Otherwise one should specify the include paths that
[2633]135# are normally passed to the compiler using the -I flag.
136
[7401]137STRIP_FROM_INC_PATH    = @DOXYGEN_INCLUDE_DIRECTORIES@
[2633]138
[7401]139# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
140# (but less readable) file names. This can be useful is your file systems
[2633]141# doesn't support long names like on DOS, Mac, or CD-ROM.
142
143SHORT_NAMES            = NO
144
[7401]145# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
146# will interpret the first line (until the first dot) of a JavaDoc-style
147# comment as the brief description. If set to NO, the JavaDoc
148# comments will behave just like regular Qt-style comments
149# (thus requiring an explicit @brief command for a brief description.)
[2633]150
[5967]151JAVADOC_AUTOBRIEF      = YES
[2633]152
[7401]153# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
154# interpret the first line (until the first dot) of a Qt-style
155# comment as the brief description. If set to NO, the comments
156# will behave just like regular Qt-style comments (thus requiring
157# an explicit \brief command for a brief description.)
158
159QT_AUTOBRIEF           = NO
160
161# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
162# treat a multi-line C++ special comment block (i.e. a block of //! or ///
163# comments) as a brief description. This used to be the default behaviour.
164# The new default is to treat a multi-line C++ comment block as a detailed
[2633]165# description. Set this tag to YES if you prefer the old behaviour instead.
166
167MULTILINE_CPP_IS_BRIEF = NO
168
[7401]169# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
170# member inherits the documentation from any documented member that it
[2633]171# re-implements.
172
173INHERIT_DOCS           = YES
174
[7401]175# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
176# a new page for each member. If set to NO, the documentation of a member will
[2633]177# be part of the file/class/namespace that contains it.
178
179SEPARATE_MEMBER_PAGES  = NO
180
[7401]181# The TAB_SIZE tag can be used to set the number of spaces in a tab.
[2633]182# Doxygen uses this value to replace tabs by spaces in code fragments.
183
[2874]184TAB_SIZE               = 4
[2633]185
[7401]186# This tag can be used to specify a number of aliases that acts
187# as commands in the documentation. An alias has the form "name=value".
188# For example adding "sideeffect=\par Side Effects:\n" will allow you to
189# put the command \sideeffect (or @sideeffect) in the documentation, which
190# will result in a user-defined paragraph with heading "Side Effects:".
[2633]191# You can put \n's in the value part of an alias to insert newlines.
192
193ALIASES                =
194
[7401]195# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
196# sources only. Doxygen will then generate output that is more tailored for C.
197# For instance, some of the names that are used will be different. The list
[2633]198# of all members will be omitted, etc.
199
200OPTIMIZE_OUTPUT_FOR_C  = NO
201
[7401]202# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
203# sources only. Doxygen will then generate output that is more tailored for
204# Java. For instance, namespaces will be presented as packages, qualified
205# scopes will look different, etc.
[2633]206
207OPTIMIZE_OUTPUT_JAVA   = NO
208
[7401]209# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
210# sources only. Doxygen will then generate output that is more tailored for
211# Fortran.
212
213OPTIMIZE_FOR_FORTRAN   = NO
214
215# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
216# sources. Doxygen will then generate output that is tailored for
217# VHDL.
218
219OPTIMIZE_OUTPUT_VHDL   = NO
220
221# Doxygen selects the parser to use depending on the extension of the files it parses.
222# With this tag you can assign which parser to use for a given extension.
223# Doxygen has a built-in mapping, but you can override or extend it using this tag.
224# The format is ext=language, where ext is a file extension, and language is one of
225# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
226# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
227# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
228# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
229
230EXTENSION_MAPPING      =
231
232# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
233# to include (a tag file for) the STL sources as input, then you should
234# set this tag to YES in order to let doxygen match functions declarations and
235# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
236# func(std::string) {}). This also make the inheritance and collaboration
[2633]237# diagrams that involve STL classes more complete and accurate.
238
[7401]239BUILTIN_STL_SUPPORT    = YES
[2633]240
[7401]241# If you use Microsoft's C++/CLI language, you should set this option to YES to
242# enable parsing support.
243
244CPP_CLI_SUPPORT        = NO
245
246# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
247# Doxygen will parse them like normal C++ but will assume all classes use public
248# instead of private inheritance when no explicit protection keyword is present.
249
250SIP_SUPPORT            = NO
251
252# For Microsoft's IDL there are propget and propput attributes to indicate getter
253# and setter methods for a property. Setting this option to YES (the default)
254# will make doxygen to replace the get and set methods by a property in the
255# documentation. This will only work if the methods are indeed getting or
256# setting a simple type. If this is not the case, or you want to show the
257# methods anyway, you should set this option to NO.
258
259IDL_PROPERTY_SUPPORT   = YES
260
261# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
262# tag is set to YES, then doxygen will reuse the documentation of the first
263# member in the group (if any) for the other members of the group. By default
[2633]264# all members of a group must be documented explicitly.
265
266DISTRIBUTE_GROUP_DOC   = NO
267
[7401]268# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
269# the same type (for instance a group of public functions) to be put as a
270# subgroup of that type (e.g. under the Public Functions section). Set it to
271# NO to prevent subgrouping. Alternatively, this can be done per class using
[2633]272# the \nosubgrouping command.
273
274SUBGROUPING            = YES
275
[7401]276# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277# is documented as struct, union, or enum with the name of the typedef. So
278# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279# with name TypeT. When disabled the typedef will appear as a member of a file,
280# namespace, or class. And the struct will be named TypeS. This can typically
281# be useful for C code in case the coding convention dictates that all compound
282# types are typedef'ed and only the typedef is referenced, never the tag name.
283
284TYPEDEF_HIDES_STRUCT   = NO
285
286# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
287# determine which symbols to keep in memory and which to flush to disk.
288# When the cache is full, less often used symbols will be written to disk.
289# For small to medium size projects (<1000 input files) the default value is
290# probably good enough. For larger projects a too small cache size can cause
291# doxygen to be busy swapping symbols to and from disk most of the time
292# causing a significant performance penality.
293# If the system has enough physical memory increasing the cache will improve the
294# performance by keeping more symbols in memory. Note that the value works on
295# a logarithmic scale so increasing the size by one will rougly double the
296# memory usage. The cache size is given by this formula:
297# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298# corresponding to a cache size of 2^16 = 65536 symbols
299
300SYMBOL_CACHE_SIZE      = 0
301
[2633]302#---------------------------------------------------------------------------
303# Build related configuration options
304#---------------------------------------------------------------------------
305
[7401]306# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
307# documentation are documented, even if no documentation was available.
308# Private class members and static file members will be hidden unless
[2633]309# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
310
311EXTRACT_ALL            = YES
312
[7401]313# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
[2633]314# will be included in the documentation.
315
316EXTRACT_PRIVATE        = YES
317
[7401]318# If the EXTRACT_STATIC tag is set to YES all static members of a file
[2633]319# will be included in the documentation.
320
321EXTRACT_STATIC         = YES
322
[7401]323# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
324# defined locally in source files will be included in the documentation.
[2633]325# If set to NO only classes defined in header files are included.
326
327EXTRACT_LOCAL_CLASSES  = YES
328
[7401]329# This flag is only useful for Objective-C code. When set to YES local
330# methods, which are defined in the implementation section but not in
331# the interface are included in the documentation.
[2633]332# If set to NO (the default) only methods in the interface are included.
333
334EXTRACT_LOCAL_METHODS  = NO
335
[7401]336# If this flag is set to YES, the members of anonymous namespaces will be
337# extracted and appear in the documentation as a namespace called
338# 'anonymous_namespace{file}', where file will be replaced with the base
339# name of the file that contains the anonymous namespace. By default
340# anonymous namespace are hidden.
341
342EXTRACT_ANON_NSPACES   = NO
343
344# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
345# undocumented members of documented classes, files or namespaces.
346# If set to NO (the default) these members will be included in the
347# various overviews, but no documentation section is generated.
[2633]348# This option has no effect if EXTRACT_ALL is enabled.
349
350HIDE_UNDOC_MEMBERS     = NO
351
[7401]352# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
353# undocumented classes that are normally visible in the class hierarchy.
354# If set to NO (the default) these classes will be included in the various
[2633]355# overviews. This option has no effect if EXTRACT_ALL is enabled.
356
357HIDE_UNDOC_CLASSES     = NO
358
[7401]359# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
360# friend (class|struct|union) declarations.
361# If set to NO (the default) these declarations will be included in the
[2633]362# documentation.
363
364HIDE_FRIEND_COMPOUNDS  = NO
365
[7401]366# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
367# documentation blocks found inside the body of a function.
368# If set to NO (the default) these blocks will be appended to the
[2633]369# function's detailed documentation block.
370
371HIDE_IN_BODY_DOCS      = NO
372
[7401]373# The INTERNAL_DOCS tag determines if documentation
374# that is typed after a \internal command is included. If the tag is set
375# to NO (the default) then the documentation will be excluded.
[2633]376# Set it to YES to include the internal documentation.
377
378INTERNAL_DOCS          = NO
379
[7401]380# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
381# file names in lower-case letters. If set to YES upper-case letters are also
382# allowed. This is useful if you have classes or files whose names only differ
383# in case and if your file system supports case sensitive file names. Windows
[2633]384# and Mac users are advised to set this option to NO.
385
[7401]386CASE_SENSE_NAMES       = NO
[2633]387
[7401]388# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
389# will show members with their full class and namespace scopes in the
[2633]390# documentation. If set to YES the scope will be hidden.
391
392HIDE_SCOPE_NAMES       = NO
393
[7401]394# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
395# will put a list of the files that are included by a file in the documentation
[2633]396# of that file.
397
398SHOW_INCLUDE_FILES     = YES
399
[7401]400# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401# will list include files with double quotes in the documentation
402# rather than with sharp brackets.
403
404FORCE_LOCAL_INCLUDES   = NO
405
406# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
[2633]407# is inserted in the documentation for inline members.
408
409INLINE_INFO            = YES
410
[7401]411# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
412# will sort the (detailed) documentation of file and class members
413# alphabetically by member name. If set to NO the members will appear in
[2633]414# declaration order.
415
416SORT_MEMBER_DOCS       = YES
417
[7401]418# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
419# brief documentation of file, namespace and class members alphabetically
420# by member name. If set to NO (the default) the members will appear in
[2633]421# declaration order.
422
423SORT_BRIEF_DOCS        = YES
424
[7401]425# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
426
427SORT_MEMBERS_CTORS_1ST = YES
428
429# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
430# hierarchy of group names into alphabetical order. If set to NO (the default)
431# the group names will appear in their defined order.
432
433SORT_GROUP_NAMES       = NO
434
435# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
436# sorted by fully-qualified names, including namespaces. If set to
437# NO (the default), the class list will be sorted only by class name,
438# not including the namespace part.
[2633]439# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
[7401]440# Note: This option applies only to the class list, not to the
[2633]441# alphabetical list.
442
[7401]443SORT_BY_SCOPE_NAME     = YES
[2633]444
[7401]445# The GENERATE_TODOLIST tag can be used to enable (YES) or
446# disable (NO) the todo list. This list is created by putting \todo
[2633]447# commands in the documentation.
448
449GENERATE_TODOLIST      = YES
450
[7401]451# The GENERATE_TESTLIST tag can be used to enable (YES) or
452# disable (NO) the test list. This list is created by putting \test
[2633]453# commands in the documentation.
454
455GENERATE_TESTLIST      = YES
456
[7401]457# The GENERATE_BUGLIST tag can be used to enable (YES) or
458# disable (NO) the bug list. This list is created by putting \bug
[2633]459# commands in the documentation.
460
461GENERATE_BUGLIST       = YES
462
[7401]463# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
464# disable (NO) the deprecated list. This list is created by putting
[2633]465# \deprecated commands in the documentation.
466
467GENERATE_DEPRECATEDLIST= YES
468
[7401]469# The ENABLED_SECTIONS tag can be used to enable conditional
[2633]470# documentation sections, marked by \if sectionname ... \endif.
471
[7401]472ENABLED_SECTIONS       =
[2633]473
[7401]474# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
475# the initial value of a variable or define consists of for it to appear in
476# the documentation. If the initializer consists of more lines than specified
477# here it will be hidden. Use a value of 0 to hide initializers completely.
478# The appearance of the initializer of individual variables and defines in the
479# documentation can be controlled using \showinitializer or \hideinitializer
[2633]480# command in the documentation regardless of this setting.
481
482MAX_INITIALIZER_LINES  = 30
483
[7401]484# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
485# at the bottom of the documentation of classes and structs. If set to YES the
[2633]486# list will mention the files that were used to generate the documentation.
487
488SHOW_USED_FILES        = YES
489
[7401]490# If the sources in your project are distributed over multiple directories
491# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
492# in the documentation. The default is NO.
[2633]493
494SHOW_DIRECTORIES       = YES
495
[3196]496# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
[7401]497# This will remove the Files entry from the Quick Index and from the
498# Folder Tree View (if specified). The default is YES.
[3196]499
500SHOW_FILES             = YES
501
502# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
[7401]503# Namespaces page.
504# This will remove the Namespaces entry from the Quick Index
[3196]505# and from the Folder Tree View (if specified). The default is YES.
506
507SHOW_NAMESPACES        = YES
508
[7401]509# The FILE_VERSION_FILTER tag can be used to specify a program or script that
510# doxygen should invoke to get the current version for each file (typically from
511# the version control system). Doxygen will invoke the program by executing (via
512# popen()) the command <command> <input-file>, where <command> is the value of
513# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
514# provided by doxygen. Whatever the program writes to standard output
[2633]515# is used as the file version. See the manual for examples.
516
[7401]517FILE_VERSION_FILTER    =
[2633]518
[7401]519# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
520# doxygen. The layout file controls the global structure of the generated output files
521# in an output format independent way. The create the layout file that represents
522# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
523# file name after the option, if omitted DoxygenLayout.xml will be used as the name
524# of the layout file.
525
526LAYOUT_FILE            =
527
[2633]528#---------------------------------------------------------------------------
529# configuration options related to warning and progress messages
530#---------------------------------------------------------------------------
531
[7401]532# The QUIET tag can be used to turn on/off the messages that are generated
[2633]533# by doxygen. Possible values are YES and NO. If left blank NO is used.
534
535QUIET                  = NO
536
[7401]537# The WARNINGS tag can be used to turn on/off the warning messages that are
538# generated by doxygen. Possible values are YES and NO. If left blank
[2633]539# NO is used.
540
541WARNINGS               = YES
542
[7401]543# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
544# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
[2633]545# automatically be disabled.
546
547WARN_IF_UNDOCUMENTED   = YES
548
[7401]549# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
550# potential errors in the documentation, such as not documenting some
551# parameters in a documented function, or documenting parameters that
[2633]552# don't exist or using markup commands wrongly.
553
554WARN_IF_DOC_ERROR      = YES
555
[7401]556# This WARN_NO_PARAMDOC option can be abled to get warnings for
557# functions that are documented, but have no documentation for their parameters
558# or return value. If set to NO (the default) doxygen will only warn about
559# wrong or incomplete parameter documentation, but not about the absence of
[2633]560# documentation.
561
562WARN_NO_PARAMDOC       = NO
563
[7401]564# The WARN_FORMAT tag determines the format of the warning messages that
565# doxygen can produce. The string should contain the $file, $line, and $text
566# tags, which will be replaced by the file and line number from which the
567# warning originated and the warning text. Optionally the format may contain
568# $version, which will be replaced by the version of the file (if it could
[2633]569# be obtained via FILE_VERSION_FILTER)
570
571WARN_FORMAT            = @DOXY_WARN_FORMAT@
572
[7401]573# The WARN_LOGFILE tag can be used to specify a file to which warning
574# and error messages should be written. If left blank the output is written
[2633]575# to stderr.
576
[3196]577WARN_LOGFILE           = @DOXY_LOGFILE@
[2633]578
579#---------------------------------------------------------------------------
580# configuration options related to the input files
581#---------------------------------------------------------------------------
582
[7401]583# The INPUT tag can be used to specify the files and/or directories that contain
584# documented source files. You may enter file names like "myfile.cpp" or
585# directories like "/usr/src/myproject". Separate the files or directories
[2633]586# with spaces.
587
588INPUT                  = @CMAKE_SOURCE_DIR@/src \
[3196]589                         @CMAKE_CURRENT_SOURCE_DIR@ \
[6085]590                         @CMAKE_BINARY_DIR@/src/OrxonoxConfig.h \
[7401]591                         @CMAKE_BINARY_DIR@/src/SpecialConfig.h \
592                         @INTERNAL_DOCFILE@
[2633]593
[7401]594# This tag can be used to specify the character encoding of the source files
595# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
596# also the default input encoding. Doxygen uses libiconv (or the iconv built
597# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
598# the list of possible encodings.
[2633]599
[7401]600INPUT_ENCODING         = UTF-8
601
602# If the value of the INPUT tag contains directories, you can use the
603# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
604# and *.h) to filter out the source-files in the directories. If left
605# blank the following patterns are tested:
606# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
607# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
608
[2633]609FILE_PATTERNS          = *.cpp \
610                         *.cc \
[7818]611                         *.c \
[2633]612                         *.h \
613                         *.hpp \
614                         *.dox
615
[7401]616# The RECURSIVE tag can be used to turn specify whether or not subdirectories
617# should be searched for input files as well. Possible values are YES and NO.
[2633]618# If left blank NO is used.
619
620RECURSIVE              = YES
621
[7401]622# The EXCLUDE tag can be used to specify files and/or directories that should
623# excluded from the INPUT source files. This way you can easily exclude a
[2633]624# subdirectory from a directory tree whose root is specified with the INPUT tag.
625
[7401]626EXCLUDE                = @CMAKE_SOURCE_DIR@/src/external/bullet/ \
627                         @CMAKE_SOURCE_DIR@/src/external/cpptcl/ \
628                         @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.5.0 \
629                         @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.6.0 \
630                         @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.6.1 \
631                         @CMAKE_SOURCE_DIR@/src/libraries/core/command/IOConsoleWindows.h \
632                         @CMAKE_SOURCE_DIR@/src/libraries/core/command/IOConsoleWindows.cc \
633                         @CMAKE_SOURCE_DIR@/src/libraries/tools/bsp \
[2633]634
[7401]635# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
636# directories that are symbolic links (a Unix filesystem feature) are excluded
[2633]637# from the input.
638
639EXCLUDE_SYMLINKS       = NO
640
[7401]641# If the value of the INPUT tag contains directories, you can use the
642# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
643# certain files from those directories. Note that the wildcards are matched
644# against the file with absolute path, so to exclude all test directories
[2633]645# for example use the pattern */test/*
646
[2876]647EXCLUDE_PATTERNS       = */.svn/*
[2633]648
[7401]649# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
650# (namespaces, classes, functions, etc.) that should be excluded from the
651# output. The symbol name can be a fully qualified name, a word, or if the
652# wildcard * is used, a substring. Examples: ANamespace, AClass,
653# AClass::ANamespace, ANamespace::*Test
654
655EXCLUDE_SYMBOLS        = orxonox::detail
656
657# The EXAMPLE_PATH tag can be used to specify one or more files or
658# directories that contain example code fragments that are included (see
[2633]659# the \include command).
660
[3196]661EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/examples/
[2633]662
[7401]663# If the value of the EXAMPLE_PATH tag contains directories, you can use the
664# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
665# and *.h) to filter out the source-files in the directories. If left
[2633]666# blank all files are included.
667
668EXAMPLE_PATTERNS       = *.cpp \
669                         *.cc \
670                         *.h \
671                         *.hh \
672                         INSTALL DEPENDENCIES CHANGELOG LICENSE LGPL
673
[7401]674# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
675# searched for input files to be used with the \include or \dontinclude
676# commands irrespective of the value of the RECURSIVE tag.
[2633]677# Possible values are YES and NO. If left blank NO is used.
678
679EXAMPLE_RECURSIVE      = YES
680
[7401]681# The IMAGE_PATH tag can be used to specify one or more files or
682# directories that contain image that are included in the documentation (see
[2633]683# the \image command).
684
[3196]685IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images/
[2633]686
[7401]687# The INPUT_FILTER tag can be used to specify a program that doxygen should
688# invoke to filter for each input file. Doxygen will invoke the filter program
689# by executing (via popen()) the command <filter> <input-file>, where <filter>
690# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
691# input file. Doxygen will then use the output that the filter program writes
692# to standard output.
693# If FILTER_PATTERNS is specified, this tag will be
[2633]694# ignored.
695
[7401]696INPUT_FILTER           =
[2633]697
[7401]698# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
699# basis.
700# Doxygen will compare the file name with each pattern and apply the
701# filter if there is a match.
702# The filters are a list of the form:
703# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
704# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
[2633]705# is applied to all files.
706
[7401]707FILTER_PATTERNS        =
[2633]708
[7401]709# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
710# INPUT_FILTER) will be used to filter the input files when producing source
[2633]711# files to browse (i.e. when SOURCE_BROWSER is set to YES).
712
713FILTER_SOURCE_FILES    = NO
714
715#---------------------------------------------------------------------------
716# configuration options related to source browsing
717#---------------------------------------------------------------------------
718
[7401]719# If the SOURCE_BROWSER tag is set to YES then a list of source files will
720# be generated. Documented entities will be cross-referenced with these sources.
721# Note: To get rid of all source code in the generated output, make sure also
[2633]722# VERBATIM_HEADERS is set to NO.
723
[2874]724SOURCE_BROWSER         = NO
[2633]725
[7401]726# Setting the INLINE_SOURCES tag to YES will include the body
[2633]727# of functions and classes directly in the documentation.
728
729INLINE_SOURCES         = NO
730
[7401]731# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
732# doxygen to hide any special comment blocks from generated source code
[2633]733# fragments. Normal C and C++ comments will always remain visible.
734
[2874]735STRIP_CODE_COMMENTS    = YES
[2633]736
[7401]737# If the REFERENCED_BY_RELATION tag is set to YES
738# then for each documented function all documented
[2633]739# functions referencing it will be listed.
740
[7401]741REFERENCED_BY_RELATION = NO
[2633]742
[7401]743# If the REFERENCES_RELATION tag is set to YES
744# then for each documented function all documented entities
[2633]745# called/used by that function will be listed.
746
[7401]747REFERENCES_RELATION    = NO
[2633]748
[7401]749# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
750# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
751# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
752# link to the source code.
753# Otherwise they will link to the documentation.
754
755REFERENCES_LINK_SOURCE = YES
756
757# If the USE_HTAGS tag is set to YES then the references to source code
758# will point to the HTML generated by the htags(1) tool instead of doxygen
759# built-in source browser. The htags tool is part of GNU's global source
760# tagging system (see http://www.gnu.org/software/global/global.html). You
[2633]761# will need version 4.8.6 or higher.
762
763USE_HTAGS              = NO
764
[7401]765# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
766# will generate a verbatim copy of the header file for each class for
[2633]767# which an include is specified. Set to NO to disable this.
768
769VERBATIM_HEADERS       = YES
770
771#---------------------------------------------------------------------------
772# configuration options related to the alphabetical class index
773#---------------------------------------------------------------------------
774
[7401]775# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
776# of all compounds will be generated. Enable this if the project
[2633]777# contains a lot of classes, structs, unions or interfaces.
778
779ALPHABETICAL_INDEX     = YES
780
[7401]781# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
782# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
[2633]783# in which this list will be split (can be a number in the range [1..20])
784
785COLS_IN_ALPHA_INDEX    = 2
786
[7401]787# In case all classes in a project start with a common prefix, all
788# classes will be put under the same header in the alphabetical index.
789# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
[2633]790# should be ignored while generating the index headers.
791
[7401]792IGNORE_PREFIX          =
[2633]793
794#---------------------------------------------------------------------------
795# configuration options related to the HTML output
796#---------------------------------------------------------------------------
797
[7401]798# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
[2633]799# generate HTML output.
800
801GENERATE_HTML          = YES
802
[7401]803# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
804# If a relative path is entered the value of OUTPUT_DIRECTORY will be
[2633]805# put in front of it. If left blank `html' will be used as the default path.
806
807HTML_OUTPUT            = html
808
[7401]809# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
810# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
[2633]811# doxygen will generate files with .html extension.
812
813HTML_FILE_EXTENSION    = .html
814
[7401]815# The HTML_HEADER tag can be used to specify a personal HTML header for
816# each generated HTML page. If it is left blank doxygen will generate a
[2633]817# standard header.
818
[7401]819HTML_HEADER            =
[2633]820
[7401]821# The HTML_FOOTER tag can be used to specify a personal HTML footer for
822# each generated HTML page. If it is left blank doxygen will generate a
[2633]823# standard footer.
824
[7401]825HTML_FOOTER            =
[2633]826
[7401]827# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
828# style sheet that is used by each HTML page. It can be used to
829# fine-tune the look of the HTML output. If the tag is left blank doxygen
830# will generate a default style sheet. Note that doxygen will try to copy
831# the style sheet file to the HTML output directory, so don't put your own
[2633]832# stylesheet in the HTML output directory as well, or it will be erased!
833
[7401]834HTML_STYLESHEET        =
[2633]835
[7401]836# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
837# page will contain the date and time when the page was generated. Setting
838# this to NO can help when comparing the output of multiple runs.
839
840HTML_TIMESTAMP         = YES
841
842# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
843# files or namespaces will be aligned in HTML using tables. If set to
[2633]844# NO a bullet list will be used.
845
846HTML_ALIGN_MEMBERS     = YES
847
[7401]848# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
849# documentation will contain sections that can be hidden and shown after the
850# page has loaded. For this to work a browser that supports
851# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
852# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
853
854HTML_DYNAMIC_SECTIONS  = NO
855
856# If the GENERATE_DOCSET tag is set to YES, additional index files
857# will be generated that can be used as input for Apple's Xcode 3
858# integrated development environment, introduced with OSX 10.5 (Leopard).
859# To create a documentation set, doxygen will generate a Makefile in the
860# HTML output directory. Running make will produce the docset in that
861# directory and running "make install" will install the docset in
862# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
863# it at startup.
864# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
865
866GENERATE_DOCSET        = NO
867
868# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
869# feed. A documentation feed provides an umbrella under which multiple
870# documentation sets from a single provider (such as a company or product suite)
871# can be grouped.
872
873DOCSET_FEEDNAME        = "Doxygen generated docs"
874
875# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
876# should uniquely identify the documentation set bundle. This should be a
877# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
878# will append .docset to the name.
879
880DOCSET_BUNDLE_ID       = org.doxygen.Project
881
882# If the GENERATE_HTMLHELP tag is set to YES, additional index files
883# will be generated that can be used as input for tools like the
884# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
[2633]885# of the generated HTML documentation.
886
887GENERATE_HTMLHELP      = YES
888
[7401]889# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
890# be used to specify the file name of the resulting .chm file. You
891# can add a path in front of the file if the result should not be
[2633]892# written to the html output directory.
893
[7401]894CHM_FILE               =
[2633]895
[7401]896# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
897# be used to specify the location (absolute path including file name) of
898# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
[2633]899# the HTML help compiler on the generated index.hhp.
900
[7401]901HHC_LOCATION           =
[2633]902
[7401]903# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
904# controls if a separate .chi index file is generated (YES) or that
[2633]905# it should be included in the master .chm file (NO).
906
907GENERATE_CHI           = NO
908
[7401]909# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
910# is used to encode HtmlHelp index (hhk), content (hhc) and project file
911# content.
912
913CHM_INDEX_ENCODING     =
914
915# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
916# controls whether a binary table of contents is generated (YES) or a
[2633]917# normal table of contents (NO) in the .chm file.
918
919BINARY_TOC             = NO
920
[7401]921# The TOC_EXPAND flag can be set to YES to add extra items for group members
[2633]922# to the contents of the HTML help documentation and to the tree view.
923
924TOC_EXPAND             = NO
925
[7401]926# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
927# are set, an additional index file will be generated that can be used as input for
928# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
929# HTML documentation.
930
931GENERATE_QHP           = NO
932
933# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
934# be used to specify the file name of the resulting .qch file.
935# The path specified is relative to the HTML output folder.
936
937QCH_FILE               =
938
939# The QHP_NAMESPACE tag specifies the namespace to use when generating
940# Qt Help Project output. For more information please see
941# http://doc.trolltech.com/qthelpproject.html#namespace
942
943QHP_NAMESPACE          = org.doxygen.Project
944
945# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
946# Qt Help Project output. For more information please see
947# http://doc.trolltech.com/qthelpproject.html#virtual-folders
948
949QHP_VIRTUAL_FOLDER     = doc
950
951# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
952# For more information please see
953# http://doc.trolltech.com/qthelpproject.html#custom-filters
954
955QHP_CUST_FILTER_NAME   =
956
957# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
958# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
959
960QHP_CUST_FILTER_ATTRS  =
961
962# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
963# filter section matches.
964# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
965
966QHP_SECT_FILTER_ATTRS  =
967
968# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
969# be used to specify the location of Qt's qhelpgenerator.
970# If non-empty doxygen will try to run qhelpgenerator on the generated
971# .qhp file.
972
973QHG_LOCATION           =
974
975# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
976#  will be generated, which together with the HTML files, form an Eclipse help
977#  plugin. To install this plugin and make it available under the help contents
978# menu in Eclipse, the contents of the directory containing the HTML and XML
979# files needs to be copied into the plugins directory of eclipse. The name of
980# the directory within the plugins directory should be the same as
981# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
982
983GENERATE_ECLIPSEHELP   = NO
984
985# A unique identifier for the eclipse help plugin. When installing the plugin
986# the directory name containing the HTML and XML files should also have
987# this name.
988
989ECLIPSE_DOC_ID         = org.doxygen.Project
990
991# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
992# top of each HTML page. The value NO (the default) enables the index and
[2633]993# the value YES disables it.
994
995DISABLE_INDEX          = NO
996
[7401]997# This tag can be used to set the number of enum values (range [1..20])
[2633]998# that doxygen will group on one line in the generated HTML documentation.
999
1000ENUM_VALUES_PER_LINE   = 4
1001
[7401]1002# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1003# structure should be generated to display hierarchical information.
1004# If the tag value is set to YES, a side panel will be generated
1005# containing a tree-like index structure (just like the one that
1006# is generated for HTML Help). For this to work a browser that supports
1007# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1008# Windows users are probably better off using the HTML help feature.
[2633]1009
[2874]1010GENERATE_TREEVIEW      = NO
[2633]1011
[7401]1012# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1013# and Class Hierarchy pages using a tree view instead of an ordered list.
1014
1015USE_INLINE_TREES       = NO
1016
1017# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1018# used to set the initial width (in pixels) of the frame in which the tree
[2633]1019# is shown.
1020
1021TREEVIEW_WIDTH         = 250
1022
[7401]1023# Use this tag to change the font size of Latex formulas included
1024# as images in the HTML documentation. The default is 10. Note that
1025# when you change the font size after a successful doxygen run you need
1026# to manually remove any form_*.png images from the HTML output directory
1027# to force them to be regenerated.
1028
1029FORMULA_FONTSIZE       = 10
1030
1031# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
1032# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
1033# typically be disabled. For large projects the javascript based search engine
1034# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1035
1036SEARCHENGINE           = YES
1037
1038# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
1039# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
1040# and does not have live searching capabilities.
1041
1042SERVER_BASED_SEARCH    = NO
1043
[2633]1044#---------------------------------------------------------------------------
1045# configuration options related to the LaTeX output
1046#---------------------------------------------------------------------------
1047
[7401]1048# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
[2633]1049# generate Latex output.
1050
1051GENERATE_LATEX         = NO
1052
[7401]1053# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1054# If a relative path is entered the value of OUTPUT_DIRECTORY will be
[2633]1055# put in front of it. If left blank `latex' will be used as the default path.
1056
1057LATEX_OUTPUT           = latex
1058
[7401]1059# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
[2633]1060# invoked. If left blank `latex' will be used as the default command name.
[7401]1061# Note that when enabling USE_PDFLATEX this option is only used for
1062# generating bitmaps for formulas in the HTML output, but not in the
1063# Makefile that is written to the output directory.
[2633]1064
[7401]1065LATEX_CMD_NAME         = @LATEX_COMPILER@
[2633]1066
[7401]1067# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1068# generate index for LaTeX. If left blank `makeindex' will be used as the
[2633]1069# default command name.
1070
1071MAKEINDEX_CMD_NAME     = @MAKEINDEX_COMPILER@
1072
[7401]1073# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1074# LaTeX documents. This may be useful for small projects and may help to
[2633]1075# save some trees in general.
1076
1077COMPACT_LATEX          = NO
1078
[7401]1079# The PAPER_TYPE tag can be used to set the paper type that is used
1080# by the printer. Possible values are: a4, a4wide, letter, legal and
[2633]1081# executive. If left blank a4wide will be used.
1082
[2874]1083PAPER_TYPE             = a4wide
[2633]1084
[7401]1085# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
[2633]1086# packages that should be included in the LaTeX output.
1087
[7401]1088EXTRA_PACKAGES         =
[2633]1089
[7401]1090# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1091# the generated latex document. The header should contain everything until
1092# the first chapter. If it is left blank doxygen will generate a
[2633]1093# standard header. Notice: only use this tag if you know what you are doing!
1094
[7401]1095LATEX_HEADER           =
[2633]1096
[7401]1097# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1098# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1099# contain links (just like the HTML output) instead of page references
[2633]1100# This makes the output suitable for online browsing using a pdf viewer.
1101
1102PDF_HYPERLINKS         = YES
1103
[7401]1104# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1105# plain latex in the generated Makefile. Set this option to YES to get a
[2633]1106# higher quality PDF documentation.
1107
1108USE_PDFLATEX           = YES
1109
[7401]1110# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1111# command to the generated LaTeX files. This will instruct LaTeX to keep
1112# running if errors occur, instead of asking the user for help.
[2633]1113# This option is also used when generating formulas in HTML.
1114
1115LATEX_BATCHMODE        = YES
1116
[7401]1117# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1118# include the index chapters (such as File Index, Compound Index, etc.)
[2633]1119# in the output.
1120
1121LATEX_HIDE_INDICES     = NO
1122
[7401]1123# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1124
1125LATEX_SOURCE_CODE      = NO
1126
[2633]1127#---------------------------------------------------------------------------
1128# configuration options related to the RTF output
1129#---------------------------------------------------------------------------
1130
[7401]1131# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1132# The RTF output is optimized for Word 97 and may not look very pretty with
[2633]1133# other RTF readers or editors.
1134
1135GENERATE_RTF           = NO
1136
[7401]1137# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1138# If a relative path is entered the value of OUTPUT_DIRECTORY will be
[2633]1139# put in front of it. If left blank `rtf' will be used as the default path.
1140
1141RTF_OUTPUT             = rtf
1142
[7401]1143# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1144# RTF documents. This may be useful for small projects and may help to
[2633]1145# save some trees in general.
1146
1147COMPACT_RTF            = NO
1148
[7401]1149# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1150# will contain hyperlink fields. The RTF file will
1151# contain links (just like the HTML output) instead of page references.
1152# This makes the output suitable for online browsing using WORD or other
1153# programs which support those fields.
[2633]1154# Note: wordpad (write) and others do not support links.
1155
1156RTF_HYPERLINKS         = NO
1157
[7401]1158# Load stylesheet definitions from file. Syntax is similar to doxygen's
1159# config file, i.e. a series of assignments. You only have to provide
[2633]1160# replacements, missing definitions are set to their default value.
1161
[7401]1162RTF_STYLESHEET_FILE    =
[2633]1163
[7401]1164# Set optional variables used in the generation of an rtf document.
[2633]1165# Syntax is similar to doxygen's config file.
1166
[7401]1167RTF_EXTENSIONS_FILE    =
[2633]1168
1169#---------------------------------------------------------------------------
1170# configuration options related to the man page output
1171#---------------------------------------------------------------------------
1172
[7401]1173# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
[2633]1174# generate man pages
1175
1176GENERATE_MAN           = NO
1177
[7401]1178# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1179# If a relative path is entered the value of OUTPUT_DIRECTORY will be
[2633]1180# put in front of it. If left blank `man' will be used as the default path.
1181
1182MAN_OUTPUT             = man
1183
[7401]1184# The MAN_EXTENSION tag determines the extension that is added to
[2633]1185# the generated man pages (default is the subroutine's section .3)
1186
1187MAN_EXTENSION          = .3
1188
[7401]1189# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1190# then it will generate one additional man file for each entity
1191# documented in the real man page(s). These additional files
1192# only source the real man page, but without them the man command
[2633]1193# would be unable to find the correct page. The default is NO.
1194
1195MAN_LINKS              = NO
1196
1197#---------------------------------------------------------------------------
1198# configuration options related to the XML output
1199#---------------------------------------------------------------------------
1200
[7401]1201# If the GENERATE_XML tag is set to YES Doxygen will
1202# generate an XML file that captures the structure of
[2633]1203# the code including all documentation.
1204
1205GENERATE_XML           = NO
1206
[7401]1207# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1208# If a relative path is entered the value of OUTPUT_DIRECTORY will be
[2633]1209# put in front of it. If left blank `xml' will be used as the default path.
1210
1211XML_OUTPUT             = xml
1212
[7401]1213# The XML_SCHEMA tag can be used to specify an XML schema,
1214# which can be used by a validating XML parser to check the
[2633]1215# syntax of the XML files.
1216
[7401]1217XML_SCHEMA             =
[2633]1218
[7401]1219# The XML_DTD tag can be used to specify an XML DTD,
1220# which can be used by a validating XML parser to check the
[2633]1221# syntax of the XML files.
1222
[7401]1223XML_DTD                =
[2633]1224
[7401]1225# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1226# dump the program listings (including syntax highlighting
1227# and cross-referencing information) to the XML output. Note that
[2633]1228# enabling this will significantly increase the size of the XML output.
1229
1230XML_PROGRAMLISTING     = YES
1231
1232#---------------------------------------------------------------------------
1233# configuration options for the AutoGen Definitions output
1234#---------------------------------------------------------------------------
1235
[7401]1236# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1237# generate an AutoGen Definitions (see autogen.sf.net) file
1238# that captures the structure of the code including all
1239# documentation. Note that this feature is still experimental
[2633]1240# and incomplete at the moment.
1241
1242GENERATE_AUTOGEN_DEF   = NO
1243
1244#---------------------------------------------------------------------------
1245# configuration options related to the Perl module output
1246#---------------------------------------------------------------------------
1247
[7401]1248# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1249# generate a Perl module file that captures the structure of
1250# the code including all documentation. Note that this
1251# feature is still experimental and incomplete at the
[2633]1252# moment.
1253
1254GENERATE_PERLMOD       = NO
1255
[7401]1256# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1257# the necessary Makefile rules, Perl scripts and LaTeX code to be able
[2633]1258# to generate PDF and DVI output from the Perl module output.
1259
1260PERLMOD_LATEX          = NO
1261
[7401]1262# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1263# nicely formatted so it can be parsed by a human reader.
1264# This is useful
1265# if you want to understand what is going on.
1266# On the other hand, if this
1267# tag is set to NO the size of the Perl module output will be much smaller
[2633]1268# and Perl will parse it just the same.
1269
1270PERLMOD_PRETTY         = YES
1271
[7401]1272# The names of the make variables in the generated doxyrules.make file
1273# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1274# This is useful so different doxyrules.make files included by the same
[2633]1275# Makefile don't overwrite each other's variables.
1276
[7401]1277PERLMOD_MAKEVAR_PREFIX =
[2633]1278
1279#---------------------------------------------------------------------------
[7401]1280# Configuration options related to the preprocessor
[2633]1281#---------------------------------------------------------------------------
1282
[7401]1283# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1284# evaluate all C-preprocessor directives found in the sources and include
[2633]1285# files.
1286
1287ENABLE_PREPROCESSING   = YES
1288
[7401]1289# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1290# names in the source code. If set to NO (the default) only conditional
1291# compilation will be performed. Macro expansion can be done in a controlled
[2633]1292# way by setting EXPAND_ONLY_PREDEF to YES.
1293
[7401]1294MACRO_EXPANSION        = NO
[2633]1295
[7401]1296# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1297# then the macro expansion is limited to the macros specified with the
[2633]1298# PREDEFINED and EXPAND_AS_DEFINED tags.
1299
1300EXPAND_ONLY_PREDEF     = YES
1301
[7401]1302# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
[2633]1303# in the INCLUDE_PATH (see below) will be search if a #include is found.
1304
[7401]1305SEARCH_INCLUDES        = NO
[2633]1306
[7401]1307# The INCLUDE_PATH tag can be used to specify one or more directories that
1308# contain include files that are not input files but should be processed by
[2633]1309# the preprocessor.
1310
[7401]1311INCLUDE_PATH           = #@DOXYGEN_INCLUDE_DIRECTORIES@
[2633]1312
[7401]1313# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1314# patterns (like *.h and *.hpp) to filter out the header-files in the
1315# directories. If left blank, the patterns specified with FILE_PATTERNS will
[2633]1316# be used.
1317
[7401]1318INCLUDE_FILE_PATTERNS  =
[2633]1319
[7401]1320# The PREDEFINED tag can be used to specify one or more macro names that
1321# are defined before the preprocessor is started (similar to the -D option of
1322# gcc). The argument of the tag is a list of macros of the form: name
1323# or name=definition (no spaces). If the definition and the = are
1324# omitted =1 is assumed. To prevent a macro definition from being
1325# undefined via #undef or recursively expanded use the := operator
[2633]1326# instead of the = operator.
1327
[7401]1328PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS \
1329                         @DOXY_PLATFORM_DEF@ \
1330                         @DOXY_COMPILER_DEF@
[2633]1331
[7401]1332# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1333# this tag can be used to specify a list of macro names that should be expanded.
1334# The macro definition that is found in the sources will be used.
[2633]1335# Use the PREDEFINED tag if you want to use a different macro definition.
1336
[7401]1337EXPAND_AS_DEFINED      =
[2633]1338
[7401]1339# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1340# doxygen's preprocessor will remove all function-like macros that are alone
1341# on a line, have an all uppercase name, and do not end with a semicolon. Such
1342# function macros are typically used for boiler-plate code, and will confuse
[2633]1343# the parser if not removed.
1344
1345SKIP_FUNCTION_MACROS   = YES
1346
1347#---------------------------------------------------------------------------
[7401]1348# Configuration::additions related to external references
[2633]1349#---------------------------------------------------------------------------
1350
[7401]1351# The TAGFILES option can be used to specify one or more tagfiles.
1352# Optionally an initial location of the external documentation
1353# can be added for each tagfile. The format of a tag file without
1354# this location is as follows:
1355#
1356# TAGFILES = file1 file2 ...
1357# Adding location for the tag files is done as follows:
1358#
1359# TAGFILES = file1=loc1 "file2 = loc2" ...
1360# where "loc1" and "loc2" can be relative or absolute paths or
1361# URLs. If a location is present for each tag, the installdox tool
[2633]1362# does not have to be run to correct the links.
1363# Note that each tag file must have a unique name
1364# (where the name does NOT include the path)
[7401]1365# If a tag file is not located in the directory in which doxygen
[2633]1366# is run, you must also specify the path to the tagfile here.
1367
[7401]1368TAGFILES               =
[2633]1369
[7401]1370# When a file name is specified after GENERATE_TAGFILE, doxygen will create
[2633]1371# a tag file that is based on the input files it reads.
1372
[2656]1373GENERATE_TAGFILE       = @DOXY_OUTPUT_DIR@/html/@PROJECT_NAME@.TAGFILE
[2633]1374
[7401]1375# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1376# in the class index. If set to NO only the inherited external classes
[2633]1377# will be listed.
1378
[2874]1379ALLEXTERNALS           = NO
[2633]1380
[7401]1381# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1382# in the modules index. If set to NO, only the current project's groups will
[2633]1383# be listed.
1384
1385EXTERNAL_GROUPS        = YES
1386
[7401]1387# The PERL_PATH should be the absolute path and name of the perl script
[2633]1388# interpreter (i.e. the result of `which perl').
1389
1390PERL_PATH              = /usr/bin/perl
1391
1392#---------------------------------------------------------------------------
[7401]1393# Configuration options related to the dot tool
[2633]1394#---------------------------------------------------------------------------
1395
[7401]1396# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1397# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1398# or super classes. Setting the tag to NO turns the diagrams off. Note that
1399# this option is superseded by the HAVE_DOT option below. This is only a
1400# fallback. It is recommended to install and use dot, since it yields more
[2633]1401# powerful graphs.
1402
1403CLASS_DIAGRAMS         = YES
1404
[7401]1405# You can define message sequence charts within doxygen comments using the \msc
1406# command. Doxygen will then run the mscgen tool (see
1407# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1408# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1409# the mscgen tool resides. If left empty the tool is assumed to be found in the
1410# default search path.
1411
1412MSCGEN_PATH            =
1413
1414# If set to YES, the inheritance and collaboration graphs will hide
1415# inheritance and usage relations if the target is undocumented
[2633]1416# or is not a class.
1417
1418HIDE_UNDOC_RELATIONS   = YES
1419
[7401]1420# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1421# available from the path. This tool is part of Graphviz, a graph visualization
1422# toolkit from AT&T and Lucent Bell Labs. The other options in this section
[2633]1423# have no effect if this option is set to NO (the default)
1424
[6085]1425HAVE_DOT               = NO
[2633]1426
[7401]1427# By default doxygen will write a font called FreeSans.ttf to the output
1428# directory and reference it in all dot files that doxygen generates. This
1429# font does not include all possible unicode characters however, so when you need
1430# these (or just want a differently looking font) you can specify the font name
1431# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1432# which can be done by putting it in a standard location or by setting the
1433# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1434# containing the font.
1435
1436DOT_FONTNAME           = FreeSans
1437
1438# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1439# The default size is 10pt.
1440
1441DOT_FONTSIZE           = 10
1442
1443# By default doxygen will tell dot to use the output directory to look for the
1444# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1445# different font using DOT_FONTNAME you can set the path where dot
1446# can find it using this tag.
1447
1448DOT_FONTPATH           =
1449
1450# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1451# will generate a graph for each documented class showing the direct and
1452# indirect inheritance relations. Setting this tag to YES will force the
[2633]1453# the CLASS_DIAGRAMS tag to NO.
1454
1455CLASS_GRAPH            = YES
1456
[7401]1457# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1458# will generate a graph for each documented class showing the direct and
1459# indirect implementation dependencies (inheritance, containment, and
[2633]1460# class references variables) of the class with other documented classes.
1461
1462COLLABORATION_GRAPH    = YES
1463
[7401]1464# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
[2633]1465# will generate a graph for groups, showing the direct groups dependencies
1466
1467GROUP_GRAPHS           = YES
1468
[7401]1469# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1470# collaboration diagrams in a style similar to the OMG's Unified Modeling
[2633]1471# Language.
1472
1473UML_LOOK               = NO
1474
[7401]1475# If set to YES, the inheritance and collaboration graphs will show the
[2633]1476# relations between templates and their instances.
1477
[2874]1478TEMPLATE_RELATIONS     = NO
[2633]1479
[7401]1480# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1481# tags are set to YES then doxygen will generate a graph for each documented
1482# file showing the direct and indirect include dependencies of the file with
[2633]1483# other documented files.
1484
1485INCLUDE_GRAPH          = YES
1486
[7401]1487# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1488# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1489# documented header file showing the documented files that directly or
[2633]1490# indirectly include this file.
1491
1492INCLUDED_BY_GRAPH      = YES
1493
[7401]1494# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1495# doxygen will generate a call dependency graph for every global function
1496# or class method. Note that enabling this option will significantly increase
1497# the time of a run. So in most cases it will be better to enable call graphs
1498# for selected functions only using the \callgraph command.
[2633]1499
1500CALL_GRAPH             = NO
1501
[7401]1502# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1503# doxygen will generate a caller dependency graph for every global function
1504# or class method. Note that enabling this option will significantly increase
1505# the time of a run. So in most cases it will be better to enable caller
1506# graphs for selected functions only using the \callergraph command.
1507
1508CALLER_GRAPH           = NO
1509
1510# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
[2633]1511# will graphical hierarchy of all classes instead of a textual one.
1512
1513GRAPHICAL_HIERARCHY    = YES
1514
[7401]1515# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1516# then doxygen will show the dependencies a directory has on other directories
[2633]1517# in a graphical way. The dependency relations are determined by the #include
1518# relations between the files in the directories.
1519
1520DIRECTORY_GRAPH        = YES
1521
[7401]1522# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
[2633]1523# generated by dot. Possible values are png, jpg, or gif
1524# If left blank png will be used.
1525
1526DOT_IMAGE_FORMAT       = png
1527
[7401]1528# The tag DOT_PATH can be used to specify the path where the dot tool can be
[2633]1529# found. If left blank, it is assumed the dot tool can be found in the path.
1530
1531DOT_PATH               = @DOXYGEN_DOT_EXECUTABLE_PATH@
1532
[7401]1533# The DOTFILE_DIRS tag can be used to specify one or more directories that
1534# contain dot files that are included in the documentation (see the
[2633]1535# \dotfile command).
1536
[3196]1537DOTFILE_DIRS           = @CMAKE_CURRENT_SOURCE_DIR@/dot
[2633]1538
[7401]1539# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1540# nodes that will be shown in the graph. If the number of nodes in a graph
1541# becomes larger than this value, doxygen will truncate the graph, which is
1542# visualized by representing a node as a red box. Note that doxygen if the
1543# number of direct children of the root node in a graph is already larger than
1544# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1545# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
[2633]1546
[7401]1547DOT_GRAPH_MAX_NODES    = 50
1548
1549# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1550# graphs generated by dot. A depth value of 3 means that only nodes reachable
1551# from the root by following a path via at most 3 edges will be shown. Nodes
1552# that lay further from the root node will be omitted. Note that setting this
1553# option to 1 or 2 may greatly reduce the computation time needed for large
1554# code bases. Also note that the size of a graph can be further restricted by
1555# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1556
[2874]1557MAX_DOT_GRAPH_DEPTH    = 1000
[2633]1558
[7401]1559# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1560# background. This is disabled by default, because dot on Windows does not
1561# seem to support this out of the box. Warning: Depending on the platform used,
1562# enabling this option may lead to badly anti-aliased labels on the edges of
1563# a graph (i.e. they become hard to read).
[2633]1564
1565DOT_TRANSPARENT        = NO
1566
[7401]1567# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1568# files in one run (i.e. multiple -o and -T options on the command line). This
1569# makes dot run faster, but since only newer versions of dot (>1.8.10)
[2633]1570# support this, this feature is disabled by default.
[3196]1571
[2874]1572DOT_MULTI_TARGETS      = NO
[2633]1573
[7401]1574# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1575# generate a legend page explaining the meaning of the various boxes and
[2633]1576# arrows in the dot generated graphs.
1577
1578GENERATE_LEGEND        = YES
1579
[7401]1580# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1581# remove the intermediate dot files that are used to generate
[2633]1582# the various graphs.
1583
1584DOT_CLEANUP            = YES
Note: See TracBrowser for help on using the repository browser.