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