Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 8351 was 8351, checked in by rgrieder, 9 years ago

Merged kicklib2 branch back to trunk (includes former branches ois_update, mac_osx and kicklib).

Notes for updating

Linux:
You don't need an extra package for CEGUILua and Tolua, it's already shipped with CEGUI.
However you do need to make sure that the OgreRenderer is installed too with CEGUI 0.7 (may be a separate package).
Also, Orxonox now recognises if you install the CgProgramManager (a separate package available on newer Ubuntu on Debian systems).

Windows:
Download the new dependency packages versioned 6.0 and use these. If you have problems with that or if you don't like the in game console problem mentioned below, you can download the new 4.3 version of the packages (only available for Visual Studio 2005/2008).

Key new features:

  • *Support for Mac OS X*
  • Visual Studio 2010 support
  • Bullet library update to 2.77
  • OIS library update to 1.3
  • Support for CEGUI 0.7 —> Support for Arch Linux and even SuSE
  • Improved install target
  • Compiles now with GCC 4.6
  • Ogre Cg Shader plugin activated for Linux if available
  • And of course lots of bug fixes

There are also some regressions:

  • No support for CEGUI 0.5, Ogre 1.4 and boost 1.35 - 1.39 any more
  • In game console is not working in main menu for CEGUI 0.7
  • Tolua (just the C lib, not the application) and CEGUILua libraries are no longer in our repository. —> You will need to get these as well when compiling Orxonox
  • And of course lots of new bugs we don't yet know about
  • Property svn:eol-style set to native
File size: 65.7 KB
Line 
1# Doxyfile 1.6.3
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8#       TAG = value [value, ...]
9# For lists items can also be appended using:
10#       TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING      = UTF-8
24
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26# by quotes) that should identify the project.
27
28PROJECT_NAME           = "@PROJECT_NAME@"
29
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.
33
34PROJECT_NUMBER         = "@ORXONOX_VERSION@ Codename: @ORXONOX_VERSION_NAME@"
35
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.
40
41OUTPUT_DIRECTORY       = @DOXY_OUTPUT_DIR@
42
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.
49
50CREATE_SUBDIRS         = NO
51
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.
62
63OUTPUT_LANGUAGE        = English
64
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).
68# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC      = YES
71
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
75# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF           = YES
78
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"
87# "represents" "a" "an" "the"
88
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
100
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
103# description.
104
105ALWAYS_DETAILED_SEC    = NO
106
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
110# operators of the base classes will not be shown.
111
112INLINE_INHERITED_MEMB  = NO
113
114# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115# path before files name in the file list and in the header files. If set
116# to NO the shortest path that makes the file name unique will be used.
117
118FULL_PATH_NAMES        = YES
119
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
125# path to strip.
126
127STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@/src \
128                         @CMAKE_BINARY_DIR@/src
129
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
135# are normally passed to the compiler using the -I flag.
136
137STRIP_FROM_INC_PATH    = @DOXYGEN_INCLUDE_DIRECTORIES@
138
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
141# doesn't support long names like on DOS, Mac, or CD-ROM.
142
143SHORT_NAMES            = NO
144
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.)
150
151JAVADOC_AUTOBRIEF      = YES
152
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
165# description. Set this tag to YES if you prefer the old behaviour instead.
166
167MULTILINE_CPP_IS_BRIEF = NO
168
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
171# re-implements.
172
173INHERIT_DOCS           = YES
174
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
177# be part of the file/class/namespace that contains it.
178
179SEPARATE_MEMBER_PAGES  = NO
180
181# The TAB_SIZE tag can be used to set the number of spaces in a tab.
182# Doxygen uses this value to replace tabs by spaces in code fragments.
183
184TAB_SIZE               = 4
185
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:".
191# You can put \n's in the value part of an alias to insert newlines.
192
193ALIASES                =
194
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
198# of all members will be omitted, etc.
199
200OPTIMIZE_OUTPUT_FOR_C  = NO
201
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.
206
207OPTIMIZE_OUTPUT_JAVA   = NO
208
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
237# diagrams that involve STL classes more complete and accurate.
238
239BUILTIN_STL_SUPPORT    = YES
240
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
264# all members of a group must be documented explicitly.
265
266DISTRIBUTE_GROUP_DOC   = NO
267
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
272# the \nosubgrouping command.
273
274SUBGROUPING            = YES
275
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
302#---------------------------------------------------------------------------
303# Build related configuration options
304#---------------------------------------------------------------------------
305
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
309# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
310
311EXTRACT_ALL            = YES
312
313# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
314# will be included in the documentation.
315
316EXTRACT_PRIVATE        = YES
317
318# If the EXTRACT_STATIC tag is set to YES all static members of a file
319# will be included in the documentation.
320
321EXTRACT_STATIC         = YES
322
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.
325# If set to NO only classes defined in header files are included.
326
327EXTRACT_LOCAL_CLASSES  = YES
328
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.
332# If set to NO (the default) only methods in the interface are included.
333
334EXTRACT_LOCAL_METHODS  = NO
335
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.
348# This option has no effect if EXTRACT_ALL is enabled.
349
350HIDE_UNDOC_MEMBERS     = NO
351
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
355# overviews. This option has no effect if EXTRACT_ALL is enabled.
356
357HIDE_UNDOC_CLASSES     = NO
358
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
362# documentation.
363
364HIDE_FRIEND_COMPOUNDS  = NO
365
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
369# function's detailed documentation block.
370
371HIDE_IN_BODY_DOCS      = NO
372
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.
376# Set it to YES to include the internal documentation.
377
378INTERNAL_DOCS          = NO
379
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
384# and Mac users are advised to set this option to NO.
385
386CASE_SENSE_NAMES       = NO
387
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
390# documentation. If set to YES the scope will be hidden.
391
392HIDE_SCOPE_NAMES       = NO
393
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
396# of that file.
397
398SHOW_INCLUDE_FILES     = YES
399
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]
407# is inserted in the documentation for inline members.
408
409INLINE_INFO            = YES
410
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
414# declaration order.
415
416SORT_MEMBER_DOCS       = YES
417
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
421# declaration order.
422
423SORT_BRIEF_DOCS        = YES
424
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.
439# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
440# Note: This option applies only to the class list, not to the
441# alphabetical list.
442
443SORT_BY_SCOPE_NAME     = YES
444
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
447# commands in the documentation.
448
449GENERATE_TODOLIST      = YES
450
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
453# commands in the documentation.
454
455GENERATE_TESTLIST      = YES
456
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
459# commands in the documentation.
460
461GENERATE_BUGLIST       = YES
462
463# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
464# disable (NO) the deprecated list. This list is created by putting
465# \deprecated commands in the documentation.
466
467GENERATE_DEPRECATEDLIST= YES
468
469# The ENABLED_SECTIONS tag can be used to enable conditional
470# documentation sections, marked by \if sectionname ... \endif.
471
472ENABLED_SECTIONS       =
473
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
480# command in the documentation regardless of this setting.
481
482MAX_INITIALIZER_LINES  = 30
483
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
486# list will mention the files that were used to generate the documentation.
487
488SHOW_USED_FILES        = YES
489
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.
493
494SHOW_DIRECTORIES       = YES
495
496# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
497# This will remove the Files entry from the Quick Index and from the
498# Folder Tree View (if specified). The default is YES.
499
500SHOW_FILES             = YES
501
502# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
503# Namespaces page.
504# This will remove the Namespaces entry from the Quick Index
505# and from the Folder Tree View (if specified). The default is YES.
506
507SHOW_NAMESPACES        = YES
508
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
515# is used as the file version. See the manual for examples.
516
517FILE_VERSION_FILTER    =
518
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
528#---------------------------------------------------------------------------
529# configuration options related to warning and progress messages
530#---------------------------------------------------------------------------
531
532# The QUIET tag can be used to turn on/off the messages that are generated
533# by doxygen. Possible values are YES and NO. If left blank NO is used.
534
535QUIET                  = NO
536
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
539# NO is used.
540
541WARNINGS               = YES
542
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
545# automatically be disabled.
546
547WARN_IF_UNDOCUMENTED   = YES
548
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
552# don't exist or using markup commands wrongly.
553
554WARN_IF_DOC_ERROR      = YES
555
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
560# documentation.
561
562WARN_NO_PARAMDOC       = NO
563
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
569# be obtained via FILE_VERSION_FILTER)
570
571WARN_FORMAT            = @DOXY_WARN_FORMAT@
572
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
575# to stderr.
576
577WARN_LOGFILE           = @DOXY_LOGFILE@
578
579#---------------------------------------------------------------------------
580# configuration options related to the input files
581#---------------------------------------------------------------------------
582
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
586# with spaces.
587
588INPUT                  = @CMAKE_SOURCE_DIR@/src \
589                         @CMAKE_CURRENT_SOURCE_DIR@ \
590                         @CMAKE_BINARY_DIR@/src/OrxonoxConfig.h \
591                         @CMAKE_BINARY_DIR@/src/SpecialConfig.h \
592                         @INTERNAL_DOCFILE@
593
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.
599
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
609FILE_PATTERNS          = *.cpp \
610                         *.cc \
611                         *.c \
612                         *.h \
613                         *.hpp \
614                         *.dox
615
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.
618# If left blank NO is used.
619
620RECURSIVE              = YES
621
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
624# subdirectory from a directory tree whose root is specified with the INPUT tag.
625
626EXCLUDE                = @CMAKE_SOURCE_DIR@/src/external/bullet/ \
627                         @CMAKE_SOURCE_DIR@/src/external/cpptcl/ \
628                         @CMAKE_SOURCE_DIR@/src/libraries/core/command/IOConsoleWindows.h \
629                         @CMAKE_SOURCE_DIR@/src/libraries/core/command/IOConsoleWindows.cc \
630                         @CMAKE_SOURCE_DIR@/src/libraries/tools/bsp \
631
632# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
633# directories that are symbolic links (a Unix filesystem feature) are excluded
634# from the input.
635
636EXCLUDE_SYMLINKS       = NO
637
638# If the value of the INPUT tag contains directories, you can use the
639# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
640# certain files from those directories. Note that the wildcards are matched
641# against the file with absolute path, so to exclude all test directories
642# for example use the pattern */test/*
643
644EXCLUDE_PATTERNS       = */.svn/*
645
646# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
647# (namespaces, classes, functions, etc.) that should be excluded from the
648# output. The symbol name can be a fully qualified name, a word, or if the
649# wildcard * is used, a substring. Examples: ANamespace, AClass,
650# AClass::ANamespace, ANamespace::*Test
651
652EXCLUDE_SYMBOLS        = orxonox::detail
653
654# The EXAMPLE_PATH tag can be used to specify one or more files or
655# directories that contain example code fragments that are included (see
656# the \include command).
657
658EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/examples/
659
660# If the value of the EXAMPLE_PATH tag contains directories, you can use the
661# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
662# and *.h) to filter out the source-files in the directories. If left
663# blank all files are included.
664
665EXAMPLE_PATTERNS       = *.cpp \
666                         *.cc \
667                         *.h \
668                         *.hh \
669                         INSTALL DEPENDENCIES CHANGELOG LICENSE LGPL
670
671# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
672# searched for input files to be used with the \include or \dontinclude
673# commands irrespective of the value of the RECURSIVE tag.
674# Possible values are YES and NO. If left blank NO is used.
675
676EXAMPLE_RECURSIVE      = YES
677
678# The IMAGE_PATH tag can be used to specify one or more files or
679# directories that contain image that are included in the documentation (see
680# the \image command).
681
682IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images/
683
684# The INPUT_FILTER tag can be used to specify a program that doxygen should
685# invoke to filter for each input file. Doxygen will invoke the filter program
686# by executing (via popen()) the command <filter> <input-file>, where <filter>
687# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
688# input file. Doxygen will then use the output that the filter program writes
689# to standard output.
690# If FILTER_PATTERNS is specified, this tag will be
691# ignored.
692
693INPUT_FILTER           =
694
695# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
696# basis.
697# Doxygen will compare the file name with each pattern and apply the
698# filter if there is a match.
699# The filters are a list of the form:
700# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
701# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
702# is applied to all files.
703
704FILTER_PATTERNS        =
705
706# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
707# INPUT_FILTER) will be used to filter the input files when producing source
708# files to browse (i.e. when SOURCE_BROWSER is set to YES).
709
710FILTER_SOURCE_FILES    = NO
711
712#---------------------------------------------------------------------------
713# configuration options related to source browsing
714#---------------------------------------------------------------------------
715
716# If the SOURCE_BROWSER tag is set to YES then a list of source files will
717# be generated. Documented entities will be cross-referenced with these sources.
718# Note: To get rid of all source code in the generated output, make sure also
719# VERBATIM_HEADERS is set to NO.
720
721SOURCE_BROWSER         = NO
722
723# Setting the INLINE_SOURCES tag to YES will include the body
724# of functions and classes directly in the documentation.
725
726INLINE_SOURCES         = NO
727
728# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
729# doxygen to hide any special comment blocks from generated source code
730# fragments. Normal C and C++ comments will always remain visible.
731
732STRIP_CODE_COMMENTS    = YES
733
734# If the REFERENCED_BY_RELATION tag is set to YES
735# then for each documented function all documented
736# functions referencing it will be listed.
737
738REFERENCED_BY_RELATION = NO
739
740# If the REFERENCES_RELATION tag is set to YES
741# then for each documented function all documented entities
742# called/used by that function will be listed.
743
744REFERENCES_RELATION    = NO
745
746# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
747# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
748# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
749# link to the source code.
750# Otherwise they will link to the documentation.
751
752REFERENCES_LINK_SOURCE = YES
753
754# If the USE_HTAGS tag is set to YES then the references to source code
755# will point to the HTML generated by the htags(1) tool instead of doxygen
756# built-in source browser. The htags tool is part of GNU's global source
757# tagging system (see http://www.gnu.org/software/global/global.html). You
758# will need version 4.8.6 or higher.
759
760USE_HTAGS              = NO
761
762# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
763# will generate a verbatim copy of the header file for each class for
764# which an include is specified. Set to NO to disable this.
765
766VERBATIM_HEADERS       = YES
767
768#---------------------------------------------------------------------------
769# configuration options related to the alphabetical class index
770#---------------------------------------------------------------------------
771
772# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
773# of all compounds will be generated. Enable this if the project
774# contains a lot of classes, structs, unions or interfaces.
775
776ALPHABETICAL_INDEX     = YES
777
778# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
779# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
780# in which this list will be split (can be a number in the range [1..20])
781
782COLS_IN_ALPHA_INDEX    = 2
783
784# In case all classes in a project start with a common prefix, all
785# classes will be put under the same header in the alphabetical index.
786# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
787# should be ignored while generating the index headers.
788
789IGNORE_PREFIX          =
790
791#---------------------------------------------------------------------------
792# configuration options related to the HTML output
793#---------------------------------------------------------------------------
794
795# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
796# generate HTML output.
797
798GENERATE_HTML          = YES
799
800# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
801# If a relative path is entered the value of OUTPUT_DIRECTORY will be
802# put in front of it. If left blank `html' will be used as the default path.
803
804HTML_OUTPUT            = html
805
806# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
807# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
808# doxygen will generate files with .html extension.
809
810HTML_FILE_EXTENSION    = .html
811
812# The HTML_HEADER tag can be used to specify a personal HTML header for
813# each generated HTML page. If it is left blank doxygen will generate a
814# standard header.
815
816HTML_HEADER            =
817
818# The HTML_FOOTER tag can be used to specify a personal HTML footer for
819# each generated HTML page. If it is left blank doxygen will generate a
820# standard footer.
821
822HTML_FOOTER            =
823
824# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
825# style sheet that is used by each HTML page. It can be used to
826# fine-tune the look of the HTML output. If the tag is left blank doxygen
827# will generate a default style sheet. Note that doxygen will try to copy
828# the style sheet file to the HTML output directory, so don't put your own
829# stylesheet in the HTML output directory as well, or it will be erased!
830
831HTML_STYLESHEET        =
832
833# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
834# page will contain the date and time when the page was generated. Setting
835# this to NO can help when comparing the output of multiple runs.
836
837HTML_TIMESTAMP         = YES
838
839# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
840# files or namespaces will be aligned in HTML using tables. If set to
841# NO a bullet list will be used.
842
843HTML_ALIGN_MEMBERS     = YES
844
845# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
846# documentation will contain sections that can be hidden and shown after the
847# page has loaded. For this to work a browser that supports
848# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
849# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
850
851HTML_DYNAMIC_SECTIONS  = NO
852
853# If the GENERATE_DOCSET tag is set to YES, additional index files
854# will be generated that can be used as input for Apple's Xcode 3
855# integrated development environment, introduced with OSX 10.5 (Leopard).
856# To create a documentation set, doxygen will generate a Makefile in the
857# HTML output directory. Running make will produce the docset in that
858# directory and running "make install" will install the docset in
859# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
860# it at startup.
861# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
862
863GENERATE_DOCSET        = NO
864
865# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
866# feed. A documentation feed provides an umbrella under which multiple
867# documentation sets from a single provider (such as a company or product suite)
868# can be grouped.
869
870DOCSET_FEEDNAME        = "Doxygen generated docs"
871
872# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
873# should uniquely identify the documentation set bundle. This should be a
874# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
875# will append .docset to the name.
876
877DOCSET_BUNDLE_ID       = org.doxygen.Project
878
879# If the GENERATE_HTMLHELP tag is set to YES, additional index files
880# will be generated that can be used as input for tools like the
881# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
882# of the generated HTML documentation.
883
884GENERATE_HTMLHELP      = YES
885
886# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
887# be used to specify the file name of the resulting .chm file. You
888# can add a path in front of the file if the result should not be
889# written to the html output directory.
890
891CHM_FILE               =
892
893# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
894# be used to specify the location (absolute path including file name) of
895# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
896# the HTML help compiler on the generated index.hhp.
897
898HHC_LOCATION           =
899
900# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
901# controls if a separate .chi index file is generated (YES) or that
902# it should be included in the master .chm file (NO).
903
904GENERATE_CHI           = NO
905
906# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
907# is used to encode HtmlHelp index (hhk), content (hhc) and project file
908# content.
909
910CHM_INDEX_ENCODING     =
911
912# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
913# controls whether a binary table of contents is generated (YES) or a
914# normal table of contents (NO) in the .chm file.
915
916BINARY_TOC             = NO
917
918# The TOC_EXPAND flag can be set to YES to add extra items for group members
919# to the contents of the HTML help documentation and to the tree view.
920
921TOC_EXPAND             = NO
922
923# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
924# are set, an additional index file will be generated that can be used as input for
925# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
926# HTML documentation.
927
928GENERATE_QHP           = NO
929
930# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
931# be used to specify the file name of the resulting .qch file.
932# The path specified is relative to the HTML output folder.
933
934QCH_FILE               =
935
936# The QHP_NAMESPACE tag specifies the namespace to use when generating
937# Qt Help Project output. For more information please see
938# http://doc.trolltech.com/qthelpproject.html#namespace
939
940QHP_NAMESPACE          = org.doxygen.Project
941
942# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
943# Qt Help Project output. For more information please see
944# http://doc.trolltech.com/qthelpproject.html#virtual-folders
945
946QHP_VIRTUAL_FOLDER     = doc
947
948# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
949# For more information please see
950# http://doc.trolltech.com/qthelpproject.html#custom-filters
951
952QHP_CUST_FILTER_NAME   =
953
954# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
955# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
956
957QHP_CUST_FILTER_ATTRS  =
958
959# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
960# filter section matches.
961# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
962
963QHP_SECT_FILTER_ATTRS  =
964
965# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
966# be used to specify the location of Qt's qhelpgenerator.
967# If non-empty doxygen will try to run qhelpgenerator on the generated
968# .qhp file.
969
970QHG_LOCATION           =
971
972# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
973#  will be generated, which together with the HTML files, form an Eclipse help
974#  plugin. To install this plugin and make it available under the help contents
975# menu in Eclipse, the contents of the directory containing the HTML and XML
976# files needs to be copied into the plugins directory of eclipse. The name of
977# the directory within the plugins directory should be the same as
978# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
979
980GENERATE_ECLIPSEHELP   = NO
981
982# A unique identifier for the eclipse help plugin. When installing the plugin
983# the directory name containing the HTML and XML files should also have
984# this name.
985
986ECLIPSE_DOC_ID         = org.doxygen.Project
987
988# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
989# top of each HTML page. The value NO (the default) enables the index and
990# the value YES disables it.
991
992DISABLE_INDEX          = NO
993
994# This tag can be used to set the number of enum values (range [1..20])
995# that doxygen will group on one line in the generated HTML documentation.
996
997ENUM_VALUES_PER_LINE   = 4
998
999# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1000# structure should be generated to display hierarchical information.
1001# If the tag value is set to YES, a side panel will be generated
1002# containing a tree-like index structure (just like the one that
1003# is generated for HTML Help). For this to work a browser that supports
1004# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1005# Windows users are probably better off using the HTML help feature.
1006
1007GENERATE_TREEVIEW      = NO
1008
1009# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1010# and Class Hierarchy pages using a tree view instead of an ordered list.
1011
1012USE_INLINE_TREES       = NO
1013
1014# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1015# used to set the initial width (in pixels) of the frame in which the tree
1016# is shown.
1017
1018TREEVIEW_WIDTH         = 250
1019
1020# Use this tag to change the font size of Latex formulas included
1021# as images in the HTML documentation. The default is 10. Note that
1022# when you change the font size after a successful doxygen run you need
1023# to manually remove any form_*.png images from the HTML output directory
1024# to force them to be regenerated.
1025
1026FORMULA_FONTSIZE       = 10
1027
1028# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
1029# 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
1030# typically be disabled. For large projects the javascript based search engine
1031# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1032
1033SEARCHENGINE           = YES
1034
1035# 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
1036# 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
1037# and does not have live searching capabilities.
1038
1039SERVER_BASED_SEARCH    = NO
1040
1041#---------------------------------------------------------------------------
1042# configuration options related to the LaTeX output
1043#---------------------------------------------------------------------------
1044
1045# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1046# generate Latex output.
1047
1048GENERATE_LATEX         = NO
1049
1050# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1051# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1052# put in front of it. If left blank `latex' will be used as the default path.
1053
1054LATEX_OUTPUT           = latex
1055
1056# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1057# invoked. If left blank `latex' will be used as the default command name.
1058# Note that when enabling USE_PDFLATEX this option is only used for
1059# generating bitmaps for formulas in the HTML output, but not in the
1060# Makefile that is written to the output directory.
1061
1062LATEX_CMD_NAME         = @LATEX_COMPILER@
1063
1064# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1065# generate index for LaTeX. If left blank `makeindex' will be used as the
1066# default command name.
1067
1068MAKEINDEX_CMD_NAME     = @MAKEINDEX_COMPILER@
1069
1070# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1071# LaTeX documents. This may be useful for small projects and may help to
1072# save some trees in general.
1073
1074COMPACT_LATEX          = NO
1075
1076# The PAPER_TYPE tag can be used to set the paper type that is used
1077# by the printer. Possible values are: a4, a4wide, letter, legal and
1078# executive. If left blank a4wide will be used.
1079
1080PAPER_TYPE             = a4wide
1081
1082# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1083# packages that should be included in the LaTeX output.
1084
1085EXTRA_PACKAGES         =
1086
1087# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1088# the generated latex document. The header should contain everything until
1089# the first chapter. If it is left blank doxygen will generate a
1090# standard header. Notice: only use this tag if you know what you are doing!
1091
1092LATEX_HEADER           =
1093
1094# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1095# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1096# contain links (just like the HTML output) instead of page references
1097# This makes the output suitable for online browsing using a pdf viewer.
1098
1099PDF_HYPERLINKS         = YES
1100
1101# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1102# plain latex in the generated Makefile. Set this option to YES to get a
1103# higher quality PDF documentation.
1104
1105USE_PDFLATEX           = YES
1106
1107# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1108# command to the generated LaTeX files. This will instruct LaTeX to keep
1109# running if errors occur, instead of asking the user for help.
1110# This option is also used when generating formulas in HTML.
1111
1112LATEX_BATCHMODE        = YES
1113
1114# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1115# include the index chapters (such as File Index, Compound Index, etc.)
1116# in the output.
1117
1118LATEX_HIDE_INDICES     = NO
1119
1120# 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.
1121
1122LATEX_SOURCE_CODE      = NO
1123
1124#---------------------------------------------------------------------------
1125# configuration options related to the RTF output
1126#---------------------------------------------------------------------------
1127
1128# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1129# The RTF output is optimized for Word 97 and may not look very pretty with
1130# other RTF readers or editors.
1131
1132GENERATE_RTF           = NO
1133
1134# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1135# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1136# put in front of it. If left blank `rtf' will be used as the default path.
1137
1138RTF_OUTPUT             = rtf
1139
1140# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1141# RTF documents. This may be useful for small projects and may help to
1142# save some trees in general.
1143
1144COMPACT_RTF            = NO
1145
1146# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1147# will contain hyperlink fields. The RTF file will
1148# contain links (just like the HTML output) instead of page references.
1149# This makes the output suitable for online browsing using WORD or other
1150# programs which support those fields.
1151# Note: wordpad (write) and others do not support links.
1152
1153RTF_HYPERLINKS         = NO
1154
1155# Load stylesheet definitions from file. Syntax is similar to doxygen's
1156# config file, i.e. a series of assignments. You only have to provide
1157# replacements, missing definitions are set to their default value.
1158
1159RTF_STYLESHEET_FILE    =
1160
1161# Set optional variables used in the generation of an rtf document.
1162# Syntax is similar to doxygen's config file.
1163
1164RTF_EXTENSIONS_FILE    =
1165
1166#---------------------------------------------------------------------------
1167# configuration options related to the man page output
1168#---------------------------------------------------------------------------
1169
1170# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1171# generate man pages
1172
1173GENERATE_MAN           = NO
1174
1175# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1176# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1177# put in front of it. If left blank `man' will be used as the default path.
1178
1179MAN_OUTPUT             = man
1180
1181# The MAN_EXTENSION tag determines the extension that is added to
1182# the generated man pages (default is the subroutine's section .3)
1183
1184MAN_EXTENSION          = .3
1185
1186# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1187# then it will generate one additional man file for each entity
1188# documented in the real man page(s). These additional files
1189# only source the real man page, but without them the man command
1190# would be unable to find the correct page. The default is NO.
1191
1192MAN_LINKS              = NO
1193
1194#---------------------------------------------------------------------------
1195# configuration options related to the XML output
1196#---------------------------------------------------------------------------
1197
1198# If the GENERATE_XML tag is set to YES Doxygen will
1199# generate an XML file that captures the structure of
1200# the code including all documentation.
1201
1202GENERATE_XML           = NO
1203
1204# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1205# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1206# put in front of it. If left blank `xml' will be used as the default path.
1207
1208XML_OUTPUT             = xml
1209
1210# The XML_SCHEMA tag can be used to specify an XML schema,
1211# which can be used by a validating XML parser to check the
1212# syntax of the XML files.
1213
1214XML_SCHEMA             =
1215
1216# The XML_DTD tag can be used to specify an XML DTD,
1217# which can be used by a validating XML parser to check the
1218# syntax of the XML files.
1219
1220XML_DTD                =
1221
1222# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1223# dump the program listings (including syntax highlighting
1224# and cross-referencing information) to the XML output. Note that
1225# enabling this will significantly increase the size of the XML output.
1226
1227XML_PROGRAMLISTING     = YES
1228
1229#---------------------------------------------------------------------------
1230# configuration options for the AutoGen Definitions output
1231#---------------------------------------------------------------------------
1232
1233# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1234# generate an AutoGen Definitions (see autogen.sf.net) file
1235# that captures the structure of the code including all
1236# documentation. Note that this feature is still experimental
1237# and incomplete at the moment.
1238
1239GENERATE_AUTOGEN_DEF   = NO
1240
1241#---------------------------------------------------------------------------
1242# configuration options related to the Perl module output
1243#---------------------------------------------------------------------------
1244
1245# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1246# generate a Perl module file that captures the structure of
1247# the code including all documentation. Note that this
1248# feature is still experimental and incomplete at the
1249# moment.
1250
1251GENERATE_PERLMOD       = NO
1252
1253# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1254# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1255# to generate PDF and DVI output from the Perl module output.
1256
1257PERLMOD_LATEX          = NO
1258
1259# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1260# nicely formatted so it can be parsed by a human reader.
1261# This is useful
1262# if you want to understand what is going on.
1263# On the other hand, if this
1264# tag is set to NO the size of the Perl module output will be much smaller
1265# and Perl will parse it just the same.
1266
1267PERLMOD_PRETTY         = YES
1268
1269# The names of the make variables in the generated doxyrules.make file
1270# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1271# This is useful so different doxyrules.make files included by the same
1272# Makefile don't overwrite each other's variables.
1273
1274PERLMOD_MAKEVAR_PREFIX =
1275
1276#---------------------------------------------------------------------------
1277# Configuration options related to the preprocessor
1278#---------------------------------------------------------------------------
1279
1280# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1281# evaluate all C-preprocessor directives found in the sources and include
1282# files.
1283
1284ENABLE_PREPROCESSING   = YES
1285
1286# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1287# names in the source code. If set to NO (the default) only conditional
1288# compilation will be performed. Macro expansion can be done in a controlled
1289# way by setting EXPAND_ONLY_PREDEF to YES.
1290
1291MACRO_EXPANSION        = NO
1292
1293# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1294# then the macro expansion is limited to the macros specified with the
1295# PREDEFINED and EXPAND_AS_DEFINED tags.
1296
1297EXPAND_ONLY_PREDEF     = YES
1298
1299# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1300# in the INCLUDE_PATH (see below) will be search if a #include is found.
1301
1302SEARCH_INCLUDES        = NO
1303
1304# The INCLUDE_PATH tag can be used to specify one or more directories that
1305# contain include files that are not input files but should be processed by
1306# the preprocessor.
1307
1308INCLUDE_PATH           = #@DOXYGEN_INCLUDE_DIRECTORIES@
1309
1310# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1311# patterns (like *.h and *.hpp) to filter out the header-files in the
1312# directories. If left blank, the patterns specified with FILE_PATTERNS will
1313# be used.
1314
1315INCLUDE_FILE_PATTERNS  =
1316
1317# The PREDEFINED tag can be used to specify one or more macro names that
1318# are defined before the preprocessor is started (similar to the -D option of
1319# gcc). The argument of the tag is a list of macros of the form: name
1320# or name=definition (no spaces). If the definition and the = are
1321# omitted =1 is assumed. To prevent a macro definition from being
1322# undefined via #undef or recursively expanded use the := operator
1323# instead of the = operator.
1324
1325PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS \
1326                         @DOXY_PLATFORM_DEF@ \
1327                         @DOXY_COMPILER_DEF@
1328
1329# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1330# this tag can be used to specify a list of macro names that should be expanded.
1331# The macro definition that is found in the sources will be used.
1332# Use the PREDEFINED tag if you want to use a different macro definition.
1333
1334EXPAND_AS_DEFINED      =
1335
1336# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1337# doxygen's preprocessor will remove all function-like macros that are alone
1338# on a line, have an all uppercase name, and do not end with a semicolon. Such
1339# function macros are typically used for boiler-plate code, and will confuse
1340# the parser if not removed.
1341
1342SKIP_FUNCTION_MACROS   = YES
1343
1344#---------------------------------------------------------------------------
1345# Configuration::additions related to external references
1346#---------------------------------------------------------------------------
1347
1348# The TAGFILES option can be used to specify one or more tagfiles.
1349# Optionally an initial location of the external documentation
1350# can be added for each tagfile. The format of a tag file without
1351# this location is as follows:
1352#
1353# TAGFILES = file1 file2 ...
1354# Adding location for the tag files is done as follows:
1355#
1356# TAGFILES = file1=loc1 "file2 = loc2" ...
1357# where "loc1" and "loc2" can be relative or absolute paths or
1358# URLs. If a location is present for each tag, the installdox tool
1359# does not have to be run to correct the links.
1360# Note that each tag file must have a unique name
1361# (where the name does NOT include the path)
1362# If a tag file is not located in the directory in which doxygen
1363# is run, you must also specify the path to the tagfile here.
1364
1365TAGFILES               =
1366
1367# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1368# a tag file that is based on the input files it reads.
1369
1370GENERATE_TAGFILE       = @DOXY_OUTPUT_DIR@/html/@PROJECT_NAME@.TAGFILE
1371
1372# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1373# in the class index. If set to NO only the inherited external classes
1374# will be listed.
1375
1376ALLEXTERNALS           = NO
1377
1378# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1379# in the modules index. If set to NO, only the current project's groups will
1380# be listed.
1381
1382EXTERNAL_GROUPS        = YES
1383
1384# The PERL_PATH should be the absolute path and name of the perl script
1385# interpreter (i.e. the result of `which perl').
1386
1387PERL_PATH              = /usr/bin/perl
1388
1389#---------------------------------------------------------------------------
1390# Configuration options related to the dot tool
1391#---------------------------------------------------------------------------
1392
1393# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1394# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1395# or super classes. Setting the tag to NO turns the diagrams off. Note that
1396# this option is superseded by the HAVE_DOT option below. This is only a
1397# fallback. It is recommended to install and use dot, since it yields more
1398# powerful graphs.
1399
1400CLASS_DIAGRAMS         = YES
1401
1402# You can define message sequence charts within doxygen comments using the \msc
1403# command. Doxygen will then run the mscgen tool (see
1404# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1405# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1406# the mscgen tool resides. If left empty the tool is assumed to be found in the
1407# default search path.
1408
1409MSCGEN_PATH            =
1410
1411# If set to YES, the inheritance and collaboration graphs will hide
1412# inheritance and usage relations if the target is undocumented
1413# or is not a class.
1414
1415HIDE_UNDOC_RELATIONS   = YES
1416
1417# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1418# available from the path. This tool is part of Graphviz, a graph visualization
1419# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1420# have no effect if this option is set to NO (the default)
1421
1422HAVE_DOT               = NO
1423
1424# By default doxygen will write a font called FreeSans.ttf to the output
1425# directory and reference it in all dot files that doxygen generates. This
1426# font does not include all possible unicode characters however, so when you need
1427# these (or just want a differently looking font) you can specify the font name
1428# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1429# which can be done by putting it in a standard location or by setting the
1430# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1431# containing the font.
1432
1433DOT_FONTNAME           = FreeSans
1434
1435# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1436# The default size is 10pt.
1437
1438DOT_FONTSIZE           = 10
1439
1440# By default doxygen will tell dot to use the output directory to look for the
1441# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1442# different font using DOT_FONTNAME you can set the path where dot
1443# can find it using this tag.
1444
1445DOT_FONTPATH           =
1446
1447# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1448# will generate a graph for each documented class showing the direct and
1449# indirect inheritance relations. Setting this tag to YES will force the
1450# the CLASS_DIAGRAMS tag to NO.
1451
1452CLASS_GRAPH            = YES
1453
1454# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1455# will generate a graph for each documented class showing the direct and
1456# indirect implementation dependencies (inheritance, containment, and
1457# class references variables) of the class with other documented classes.
1458
1459COLLABORATION_GRAPH    = YES
1460
1461# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1462# will generate a graph for groups, showing the direct groups dependencies
1463
1464GROUP_GRAPHS           = YES
1465
1466# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1467# collaboration diagrams in a style similar to the OMG's Unified Modeling
1468# Language.
1469
1470UML_LOOK               = NO
1471
1472# If set to YES, the inheritance and collaboration graphs will show the
1473# relations between templates and their instances.
1474
1475TEMPLATE_RELATIONS     = NO
1476
1477# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1478# tags are set to YES then doxygen will generate a graph for each documented
1479# file showing the direct and indirect include dependencies of the file with
1480# other documented files.
1481
1482INCLUDE_GRAPH          = YES
1483
1484# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1485# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1486# documented header file showing the documented files that directly or
1487# indirectly include this file.
1488
1489INCLUDED_BY_GRAPH      = YES
1490
1491# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1492# doxygen will generate a call dependency graph for every global function
1493# or class method. Note that enabling this option will significantly increase
1494# the time of a run. So in most cases it will be better to enable call graphs
1495# for selected functions only using the \callgraph command.
1496
1497CALL_GRAPH             = NO
1498
1499# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1500# doxygen will generate a caller dependency graph for every global function
1501# or class method. Note that enabling this option will significantly increase
1502# the time of a run. So in most cases it will be better to enable caller
1503# graphs for selected functions only using the \callergraph command.
1504
1505CALLER_GRAPH           = NO
1506
1507# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1508# will graphical hierarchy of all classes instead of a textual one.
1509
1510GRAPHICAL_HIERARCHY    = YES
1511
1512# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1513# then doxygen will show the dependencies a directory has on other directories
1514# in a graphical way. The dependency relations are determined by the #include
1515# relations between the files in the directories.
1516
1517DIRECTORY_GRAPH        = YES
1518
1519# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1520# generated by dot. Possible values are png, jpg, or gif
1521# If left blank png will be used.
1522
1523DOT_IMAGE_FORMAT       = png
1524
1525# The tag DOT_PATH can be used to specify the path where the dot tool can be
1526# found. If left blank, it is assumed the dot tool can be found in the path.
1527
1528DOT_PATH               = @DOXYGEN_DOT_EXECUTABLE_PATH@
1529
1530# The DOTFILE_DIRS tag can be used to specify one or more directories that
1531# contain dot files that are included in the documentation (see the
1532# \dotfile command).
1533
1534DOTFILE_DIRS           = @CMAKE_CURRENT_SOURCE_DIR@/dot
1535
1536# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1537# nodes that will be shown in the graph. If the number of nodes in a graph
1538# becomes larger than this value, doxygen will truncate the graph, which is
1539# visualized by representing a node as a red box. Note that doxygen if the
1540# number of direct children of the root node in a graph is already larger than
1541# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1542# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1543
1544DOT_GRAPH_MAX_NODES    = 50
1545
1546# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1547# graphs generated by dot. A depth value of 3 means that only nodes reachable
1548# from the root by following a path via at most 3 edges will be shown. Nodes
1549# that lay further from the root node will be omitted. Note that setting this
1550# option to 1 or 2 may greatly reduce the computation time needed for large
1551# code bases. Also note that the size of a graph can be further restricted by
1552# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1553
1554MAX_DOT_GRAPH_DEPTH    = 1000
1555
1556# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1557# background. This is disabled by default, because dot on Windows does not
1558# seem to support this out of the box. Warning: Depending on the platform used,
1559# enabling this option may lead to badly anti-aliased labels on the edges of
1560# a graph (i.e. they become hard to read).
1561
1562DOT_TRANSPARENT        = NO
1563
1564# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1565# files in one run (i.e. multiple -o and -T options on the command line). This
1566# makes dot run faster, but since only newer versions of dot (>1.8.10)
1567# support this, this feature is disabled by default.
1568
1569DOT_MULTI_TARGETS      = NO
1570
1571# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1572# generate a legend page explaining the meaning of the various boxes and
1573# arrows in the dot generated graphs.
1574
1575GENERATE_LEGEND        = YES
1576
1577# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1578# remove the intermediate dot files that are used to generate
1579# the various graphs.
1580
1581DOT_CLEANUP            = YES
Note: See TracBrowser for help on using the repository browser.