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