PageRenderTime 42ms CodeModel.GetById 21ms app.highlight 9ms RepoModel.GetById 1ms app.codeStats 1ms

/MapView/routeme.doxygen

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