| 
     1 # Doxyfile 1.3.6  | 
         | 
     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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded   | 
         | 
    18 # by quotes) that should identify the project.  | 
         | 
    19   | 
         | 
    20 PROJECT_NAME           = HugoLib  | 
         | 
    21   | 
         | 
    22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.   | 
         | 
    23 # This could be handy for archiving the generated documentation or   | 
         | 
    24 # if some version control system is used.  | 
         | 
    25   | 
         | 
    26 PROJECT_NUMBER         = 0.1  | 
         | 
    27   | 
         | 
    28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)   | 
         | 
    29 # base path where the generated documentation will be put.   | 
         | 
    30 # If a relative path is entered, it will be relative to the location   | 
         | 
    31 # where doxygen was started. If left blank the current directory will be used.  | 
         | 
    32   | 
         | 
    33 OUTPUT_DIRECTORY       =   | 
         | 
    34   | 
         | 
    35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all   | 
         | 
    36 # documentation generated by doxygen is written. Doxygen will use this   | 
         | 
    37 # information to generate all constant output in the proper language.   | 
         | 
    38 # The default language is English, other supported languages are:   | 
         | 
    39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,   | 
         | 
    40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en   | 
         | 
    41 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,   | 
         | 
    42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.  | 
         | 
    43   | 
         | 
    44 OUTPUT_LANGUAGE        = English  | 
         | 
    45   | 
         | 
    46 # This tag can be used to specify the encoding used in the generated output.   | 
         | 
    47 # The encoding is not always determined by the language that is chosen,   | 
         | 
    48 # but also whether or not the output is meant for Windows or non-Windows users.   | 
         | 
    49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES   | 
         | 
    50 # forces the Windows encoding (this is the default for the Windows binary),   | 
         | 
    51 # whereas setting the tag to NO uses a Unix-style encoding (the default for   | 
         | 
    52 # all platforms other than Windows).  | 
         | 
    53   | 
         | 
    54 USE_WINDOWS_ENCODING   = NO  | 
         | 
    55   | 
         | 
    56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will   | 
         | 
    57 # include brief member descriptions after the members that are listed in   | 
         | 
    58 # the file and class documentation (similar to JavaDoc).   | 
         | 
    59 # Set to NO to disable this.  | 
         | 
    60   | 
         | 
    61 BRIEF_MEMBER_DESC      = YES  | 
         | 
    62   | 
         | 
    63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend   | 
         | 
    64 # the brief description of a member or function before the detailed description.   | 
         | 
    65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the   | 
         | 
    66 # brief descriptions will be completely suppressed.  | 
         | 
    67   | 
         | 
    68 REPEAT_BRIEF           = NO  | 
         | 
    69   | 
         | 
    70 # This tag implements a quasi-intelligent brief description abbreviator   | 
         | 
    71 # that is used to form the text in various listings. Each string   | 
         | 
    72 # in this list, if found as the leading text of the brief description, will be   | 
         | 
    73 # stripped from the text and the result after processing the whole list, is used   | 
         | 
    74 # as the annotated text. Otherwise, the brief description is used as-is. If left   | 
         | 
    75 # blank, the following values are used ("$name" is automatically replaced with the  | 
         | 
    76 # name of the entity): "The $name class" "The $name widget" "The $name file"   | 
         | 
    77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"  | 
         | 
    78   | 
         | 
    79 ABBREVIATE_BRIEF       =   | 
         | 
    80   | 
         | 
    81 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then   | 
         | 
    82 # Doxygen will generate a detailed section even if there is only a brief   | 
         | 
    83 # description.  | 
         | 
    84   | 
         | 
    85 ALWAYS_DETAILED_SEC    = NO  | 
         | 
    86   | 
         | 
    87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited   | 
         | 
    88 # members of a class in the documentation of that class as if those members were   | 
         | 
    89 # ordinary class members. Constructors, destructors and assignment operators of   | 
         | 
    90 # the base classes will not be shown.  | 
         | 
    91   | 
         | 
    92 INLINE_INHERITED_MEMB  = NO  | 
         | 
    93   | 
         | 
    94 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full   | 
         | 
    95 # path before files name in the file list and in the header files. If set   | 
         | 
    96 # to NO the shortest path that makes the file name unique will be used.  | 
         | 
    97   | 
         | 
    98 FULL_PATH_NAMES        = NO  | 
         | 
    99   | 
         | 
   100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag   | 
         | 
   101 # can be used to strip a user-defined part of the path. Stripping is   | 
         | 
   102 # only done if one of the specified strings matches the left-hand part of   | 
         | 
   103 # the path. It is allowed to use relative paths in the argument list.   | 
         | 
   104 # If left blank the directory from which doxygen is run is used as the   | 
         | 
   105 # path to strip.  | 
         | 
   106   | 
         | 
   107 STRIP_FROM_PATH        =   | 
         | 
   108   | 
         | 
   109 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter   | 
         | 
   110 # (but less readable) file names. This can be useful is your file systems   | 
         | 
   111 # doesn't support long names like on DOS, Mac, or CD-ROM.  | 
         | 
   112   | 
         | 
   113 SHORT_NAMES            = NO  | 
         | 
   114   | 
         | 
   115 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen   | 
         | 
   116 # will interpret the first line (until the first dot) of a JavaDoc-style   | 
         | 
   117 # comment as the brief description. If set to NO, the JavaDoc   | 
         | 
   118 # comments will behave just like the Qt-style comments (thus requiring an   | 
         | 
   119 # explicit @brief command for a brief description.  | 
         | 
   120   | 
         | 
   121 JAVADOC_AUTOBRIEF      = NO  | 
         | 
   122   | 
         | 
   123 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen   | 
         | 
   124 # treat a multi-line C++ special comment block (i.e. a block of //! or ///   | 
         | 
   125 # comments) as a brief description. This used to be the default behaviour.   | 
         | 
   126 # The new default is to treat a multi-line C++ comment block as a detailed   | 
         | 
   127 # description. Set this tag to YES if you prefer the old behaviour instead.  | 
         | 
   128   | 
         | 
   129 MULTILINE_CPP_IS_BRIEF = NO  | 
         | 
   130   | 
         | 
   131 # If the DETAILS_AT_TOP tag is set to YES then Doxygen   | 
         | 
   132 # will output the detailed description near the top, like JavaDoc.  | 
         | 
   133 # If set to NO, the detailed description appears after the member   | 
         | 
   134 # documentation.  | 
         | 
   135   | 
         | 
   136 DETAILS_AT_TOP         = YES  | 
         | 
   137   | 
         | 
   138 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented   | 
         | 
   139 # member inherits the documentation from any documented member that it   | 
         | 
   140 # re-implements.  | 
         | 
   141   | 
         | 
   142 INHERIT_DOCS           = NO  | 
         | 
   143   | 
         | 
   144 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC   | 
         | 
   145 # tag is set to YES, then doxygen will reuse the documentation of the first   | 
         | 
   146 # member in the group (if any) for the other members of the group. By default   | 
         | 
   147 # all members of a group must be documented explicitly.  | 
         | 
   148   | 
         | 
   149 DISTRIBUTE_GROUP_DOC   = NO  | 
         | 
   150   | 
         | 
   151 # The TAB_SIZE tag can be used to set the number of spaces in a tab.   | 
         | 
   152 # Doxygen uses this value to replace tabs by spaces in code fragments.  | 
         | 
   153   | 
         | 
   154 TAB_SIZE               = 8  | 
         | 
   155   | 
         | 
   156 # This tag can be used to specify a number of aliases that acts   | 
         | 
   157 # as commands in the documentation. An alias has the form "name=value".   | 
         | 
   158 # For example adding "sideeffect=\par Side Effects:\n" will allow you to   | 
         | 
   159 # put the command \sideeffect (or @sideeffect) in the documentation, which   | 
         | 
   160 # will result in a user-defined paragraph with heading "Side Effects:".   | 
         | 
   161 # You can put \n's in the value part of an alias to insert newlines.  | 
         | 
   162   | 
         | 
   163 ALIASES                =   | 
         | 
   164   | 
         | 
   165 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources   | 
         | 
   166 # only. Doxygen will then generate output that is more tailored for C.   | 
         | 
   167 # For instance, some of the names that are used will be different. The list   | 
         | 
   168 # of all members will be omitted, etc.  | 
         | 
   169   | 
         | 
   170 OPTIMIZE_OUTPUT_FOR_C  = NO  | 
         | 
   171   | 
         | 
   172 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources   | 
         | 
   173 # only. Doxygen will then generate output that is more tailored for Java.   | 
         | 
   174 # For instance, namespaces will be presented as packages, qualified scopes   | 
         | 
   175 # will look different, etc.  | 
         | 
   176   | 
         | 
   177 OPTIMIZE_OUTPUT_JAVA   = NO  | 
         | 
   178   | 
         | 
   179 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of   | 
         | 
   180 # the same type (for instance a group of public functions) to be put as a   | 
         | 
   181 # subgroup of that type (e.g. under the Public Functions section). Set it to   | 
         | 
   182 # NO to prevent subgrouping. Alternatively, this can be done per class using   | 
         | 
   183 # the \nosubgrouping command.  | 
         | 
   184   | 
         | 
   185 SUBGROUPING            = YES  | 
         | 
   186   | 
         | 
   187 #---------------------------------------------------------------------------  | 
         | 
   188 # Build related configuration options  | 
         | 
   189 #---------------------------------------------------------------------------  | 
         | 
   190   | 
         | 
   191 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in   | 
         | 
   192 # documentation are documented, even if no documentation was available.   | 
         | 
   193 # Private class members and static file members will be hidden unless   | 
         | 
   194 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES  | 
         | 
   195   | 
         | 
   196 EXTRACT_ALL            = NO  | 
         | 
   197   | 
         | 
   198 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class   | 
         | 
   199 # will be included in the documentation.  | 
         | 
   200   | 
         | 
   201 EXTRACT_PRIVATE        = NO  | 
         | 
   202   | 
         | 
   203 # If the EXTRACT_STATIC tag is set to YES all static members of a file   | 
         | 
   204 # will be included in the documentation.  | 
         | 
   205   | 
         | 
   206 EXTRACT_STATIC         = NO  | 
         | 
   207   | 
         | 
   208 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)   | 
         | 
   209 # defined locally in source files will be included in the documentation.   | 
         | 
   210 # If set to NO only classes defined in header files are included.  | 
         | 
   211   | 
         | 
   212 EXTRACT_LOCAL_CLASSES  = YES  | 
         | 
   213   | 
         | 
   214 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all   | 
         | 
   215 # undocumented members of documented classes, files or namespaces.   | 
         | 
   216 # If set to NO (the default) these members will be included in the   | 
         | 
   217 # various overviews, but no documentation section is generated.   | 
         | 
   218 # This option has no effect if EXTRACT_ALL is enabled.  | 
         | 
   219   | 
         | 
   220 HIDE_UNDOC_MEMBERS     = YES  | 
         | 
   221   | 
         | 
   222 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all   | 
         | 
   223 # undocumented classes that are normally visible in the class hierarchy.   | 
         | 
   224 # If set to NO (the default) these classes will be included in the various   | 
         | 
   225 # overviews. This option has no effect if EXTRACT_ALL is enabled.  | 
         | 
   226   | 
         | 
   227 HIDE_UNDOC_CLASSES     = YES  | 
         | 
   228   | 
         | 
   229 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all   | 
         | 
   230 # friend (class|struct|union) declarations.   | 
         | 
   231 # If set to NO (the default) these declarations will be included in the   | 
         | 
   232 # documentation.  | 
         | 
   233   | 
         | 
   234 HIDE_FRIEND_COMPOUNDS  = NO  | 
         | 
   235   | 
         | 
   236 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any   | 
         | 
   237 # documentation blocks found inside the body of a function.   | 
         | 
   238 # If set to NO (the default) these blocks will be appended to the   | 
         | 
   239 # function's detailed documentation block.  | 
         | 
   240   | 
         | 
   241 HIDE_IN_BODY_DOCS      = NO  | 
         | 
   242   | 
         | 
   243 # The INTERNAL_DOCS tag determines if documentation   | 
         | 
   244 # that is typed after a \internal command is included. If the tag is set   | 
         | 
   245 # to NO (the default) then the documentation will be excluded.   | 
         | 
   246 # Set it to YES to include the internal documentation.  | 
         | 
   247   | 
         | 
   248 INTERNAL_DOCS          = NO  | 
         | 
   249   | 
         | 
   250 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate   | 
         | 
   251 # file names in lower-case letters. If set to YES upper-case letters are also   | 
         | 
   252 # allowed. This is useful if you have classes or files whose names only differ   | 
         | 
   253 # in case and if your file system supports case sensitive file names. Windows   | 
         | 
   254 # users are advised to set this option to NO.  | 
         | 
   255   | 
         | 
   256 CASE_SENSE_NAMES       = YES  | 
         | 
   257   | 
         | 
   258 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen   | 
         | 
   259 # will show members with their full class and namespace scopes in the   | 
         | 
   260 # documentation. If set to YES the scope will be hidden.  | 
         | 
   261   | 
         | 
   262 HIDE_SCOPE_NAMES       = YES  | 
         | 
   263   | 
         | 
   264 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen   | 
         | 
   265 # will put a list of the files that are included by a file in the documentation   | 
         | 
   266 # of that file.  | 
         | 
   267   | 
         | 
   268 SHOW_INCLUDE_FILES     = YES  | 
         | 
   269   | 
         | 
   270 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]   | 
         | 
   271 # is inserted in the documentation for inline members.  | 
         | 
   272   | 
         | 
   273 INLINE_INFO            = YES  | 
         | 
   274   | 
         | 
   275 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen   | 
         | 
   276 # will sort the (detailed) documentation of file and class members   | 
         | 
   277 # alphabetically by member name. If set to NO the members will appear in   | 
         | 
   278 # declaration order.  | 
         | 
   279   | 
         | 
   280 SORT_MEMBER_DOCS       = NO  | 
         | 
   281   | 
         | 
   282 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the   | 
         | 
   283 # brief documentation of file, namespace and class members alphabetically   | 
         | 
   284 # by member name. If set to NO (the default) the members will appear in   | 
         | 
   285 # declaration order.  | 
         | 
   286   | 
         | 
   287 SORT_BRIEF_DOCS        = NO  | 
         | 
   288   | 
         | 
   289 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be   | 
         | 
   290 # sorted by fully-qualified names, including namespaces. If set to   | 
         | 
   291 # NO (the default), the class list will be sorted only by class name,   | 
         | 
   292 # not including the namespace part.   | 
         | 
   293 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.  | 
         | 
   294 # Note: This option applies only to the class list, not to the   | 
         | 
   295 # alphabetical list.  | 
         | 
   296   | 
         | 
   297 SORT_BY_SCOPE_NAME     = NO  | 
         | 
   298   | 
         | 
   299 # The GENERATE_TODOLIST tag can be used to enable (YES) or   | 
         | 
   300 # disable (NO) the todo list. This list is created by putting \todo   | 
         | 
   301 # commands in the documentation.  | 
         | 
   302   | 
         | 
   303 GENERATE_TODOLIST      = YES  | 
         | 
   304   | 
         | 
   305 # The GENERATE_TESTLIST tag can be used to enable (YES) or   | 
         | 
   306 # disable (NO) the test list. This list is created by putting \test   | 
         | 
   307 # commands in the documentation.  | 
         | 
   308   | 
         | 
   309 GENERATE_TESTLIST      = YES  | 
         | 
   310   | 
         | 
   311 # The GENERATE_BUGLIST tag can be used to enable (YES) or   | 
         | 
   312 # disable (NO) the bug list. This list is created by putting \bug   | 
         | 
   313 # commands in the documentation.  | 
         | 
   314   | 
         | 
   315 GENERATE_BUGLIST       = YES  | 
         | 
   316   | 
         | 
   317 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or   | 
         | 
   318 # disable (NO) the deprecated list. This list is created by putting   | 
         | 
   319 # \deprecated commands in the documentation.  | 
         | 
   320   | 
         | 
   321 GENERATE_DEPRECATEDLIST= YES  | 
         | 
   322   | 
         | 
   323 # The ENABLED_SECTIONS tag can be used to enable conditional   | 
         | 
   324 # documentation sections, marked by \if sectionname ... \endif.  | 
         | 
   325   | 
         | 
   326 ENABLED_SECTIONS       =   | 
         | 
   327   | 
         | 
   328 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines   | 
         | 
   329 # the initial value of a variable or define consists of for it to appear in   | 
         | 
   330 # the documentation. If the initializer consists of more lines than specified   | 
         | 
   331 # here it will be hidden. Use a value of 0 to hide initializers completely.   | 
         | 
   332 # The appearance of the initializer of individual variables and defines in the   | 
         | 
   333 # documentation can be controlled using \showinitializer or \hideinitializer   | 
         | 
   334 # command in the documentation regardless of this setting.  | 
         | 
   335   | 
         | 
   336 MAX_INITIALIZER_LINES  = 30  | 
         | 
   337   | 
         | 
   338 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated   | 
         | 
   339 # at the bottom of the documentation of classes and structs. If set to YES the   | 
         | 
   340 # list will mention the files that were used to generate the documentation.  | 
         | 
   341   | 
         | 
   342 SHOW_USED_FILES        = YES  | 
         | 
   343   | 
         | 
   344 #---------------------------------------------------------------------------  | 
         | 
   345 # configuration options related to warning and progress messages  | 
         | 
   346 #---------------------------------------------------------------------------  | 
         | 
   347   | 
         | 
   348 # The QUIET tag can be used to turn on/off the messages that are generated   | 
         | 
   349 # by doxygen. Possible values are YES and NO. If left blank NO is used.  | 
         | 
   350   | 
         | 
   351 QUIET                  = NO  | 
         | 
   352   | 
         | 
   353 # The WARNINGS tag can be used to turn on/off the warning messages that are   | 
         | 
   354 # generated by doxygen. Possible values are YES and NO. If left blank   | 
         | 
   355 # NO is used.  | 
         | 
   356   | 
         | 
   357 WARNINGS               = YES  | 
         | 
   358   | 
         | 
   359 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings   | 
         | 
   360 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will   | 
         | 
   361 # automatically be disabled.  | 
         | 
   362   | 
         | 
   363 WARN_IF_UNDOCUMENTED   = YES  | 
         | 
   364   | 
         | 
   365 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for   | 
         | 
   366 # potential errors in the documentation, such as not documenting some   | 
         | 
   367 # parameters in a documented function, or documenting parameters that   | 
         | 
   368 # don't exist or using markup commands wrongly.  | 
         | 
   369   | 
         | 
   370 WARN_IF_DOC_ERROR      = YES  | 
         | 
   371   | 
         | 
   372 # The WARN_FORMAT tag determines the format of the warning messages that   | 
         | 
   373 # doxygen can produce. The string should contain the $file, $line, and $text   | 
         | 
   374 # tags, which will be replaced by the file and line number from which the   | 
         | 
   375 # warning originated and the warning text.  | 
         | 
   376   | 
         | 
   377 WARN_FORMAT            = "$file:$line: $text"  | 
         | 
   378   | 
         | 
   379 # The WARN_LOGFILE tag can be used to specify a file to which warning   | 
         | 
   380 # and error messages should be written. If left blank the output is written   | 
         | 
   381 # to stderr.  | 
         | 
   382   | 
         | 
   383 WARN_LOGFILE           = doxygen.log  | 
         | 
   384   | 
         | 
   385 #---------------------------------------------------------------------------  | 
         | 
   386 # configuration options related to the input files  | 
         | 
   387 #---------------------------------------------------------------------------  | 
         | 
   388   | 
         | 
   389 # The INPUT tag can be used to specify the files and/or directories that contain   | 
         | 
   390 # documented source files. You may enter file names like "myfile.cpp" or   | 
         | 
   391 # directories like "/usr/src/myproject". Separate the files or directories   | 
         | 
   392 # with spaces.  | 
         | 
   393   | 
         | 
   394 INPUT                  = ../hugo \  | 
         | 
   395                          ../hugo/skeletons \  | 
         | 
   396                          ../test/test_tools.h \  | 
         | 
   397                          athos/minlengthpaths.h \  | 
         | 
   398                          klao/path.h \  | 
         | 
   399                          jacint/max_flow.h \  | 
         | 
   400                          jacint/max_matching.h  | 
         | 
   401   | 
         | 
   402 # If the value of the INPUT tag contains directories, you can use the   | 
         | 
   403 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp   | 
         | 
   404 # and *.h) to filter out the source-files in the directories. If left   | 
         | 
   405 # blank the following patterns are tested:   | 
         | 
   406 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp   | 
         | 
   407 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc  | 
         | 
   408   | 
         | 
   409 FILE_PATTERNS          =   | 
         | 
   410   | 
         | 
   411 # The RECURSIVE tag can be used to turn specify whether or not subdirectories   | 
         | 
   412 # should be searched for input files as well. Possible values are YES and NO.   | 
         | 
   413 # If left blank NO is used.  | 
         | 
   414   | 
         | 
   415 RECURSIVE              = NO  | 
         | 
   416   | 
         | 
   417 # The EXCLUDE tag can be used to specify files and/or directories that should   | 
         | 
   418 # excluded from the INPUT source files. This way you can easily exclude a   | 
         | 
   419 # subdirectory from a directory tree whose root is specified with the INPUT tag.  | 
         | 
   420   | 
         | 
   421 EXCLUDE                =   | 
         | 
   422   | 
         | 
   423 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories   | 
         | 
   424 # that are symbolic links (a Unix filesystem feature) are excluded from the input.  | 
         | 
   425   | 
         | 
   426 EXCLUDE_SYMLINKS       = NO  | 
         | 
   427   | 
         | 
   428 # If the value of the INPUT tag contains directories, you can use the   | 
         | 
   429 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude   | 
         | 
   430 # certain files from those directories.  | 
         | 
   431   | 
         | 
   432 EXCLUDE_PATTERNS       =   | 
         | 
   433   | 
         | 
   434 # The EXAMPLE_PATH tag can be used to specify one or more files or   | 
         | 
   435 # directories that contain example code fragments that are included (see   | 
         | 
   436 # the \include command).  | 
         | 
   437   | 
         | 
   438 EXAMPLE_PATH           =   | 
         | 
   439   | 
         | 
   440 # If the value of the EXAMPLE_PATH tag contains directories, you can use the   | 
         | 
   441 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp   | 
         | 
   442 # and *.h) to filter out the source-files in the directories. If left   | 
         | 
   443 # blank all files are included.  | 
         | 
   444   | 
         | 
   445 EXAMPLE_PATTERNS       =   | 
         | 
   446   | 
         | 
   447 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be   | 
         | 
   448 # searched for input files to be used with the \include or \dontinclude   | 
         | 
   449 # commands irrespective of the value of the RECURSIVE tag.   | 
         | 
   450 # Possible values are YES and NO. If left blank NO is used.  | 
         | 
   451   | 
         | 
   452 EXAMPLE_RECURSIVE      = NO  | 
         | 
   453   | 
         | 
   454 # The IMAGE_PATH tag can be used to specify one or more files or   | 
         | 
   455 # directories that contain image that are included in the documentation (see   | 
         | 
   456 # the \image command).  | 
         | 
   457   | 
         | 
   458 IMAGE_PATH             =   | 
         | 
   459   | 
         | 
   460 # The INPUT_FILTER tag can be used to specify a program that doxygen should   | 
         | 
   461 # invoke to filter for each input file. Doxygen will invoke the filter program   | 
         | 
   462 # by executing (via popen()) the command <filter> <input-file>, where <filter>   | 
         | 
   463 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an   | 
         | 
   464 # input file. Doxygen will then use the output that the filter program writes   | 
         | 
   465 # to standard output.  | 
         | 
   466   | 
         | 
   467 INPUT_FILTER           =   | 
         | 
   468   | 
         | 
   469 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using   | 
         | 
   470 # INPUT_FILTER) will be used to filter the input files when producing source   | 
         | 
   471 # files to browse (i.e. when SOURCE_BROWSER is set to YES).  | 
         | 
   472   | 
         | 
   473 FILTER_SOURCE_FILES    = NO  | 
         | 
   474   | 
         | 
   475 #---------------------------------------------------------------------------  | 
         | 
   476 # configuration options related to source browsing  | 
         | 
   477 #---------------------------------------------------------------------------  | 
         | 
   478   | 
         | 
   479 # If the SOURCE_BROWSER tag is set to YES then a list of source files will   | 
         | 
   480 # be generated. Documented entities will be cross-referenced with these sources.   | 
         | 
   481 # Note: To get rid of all source code in the generated output, make sure also   | 
         | 
   482 # VERBATIM_HEADERS is set to NO.  | 
         | 
   483   | 
         | 
   484 SOURCE_BROWSER         = YES  | 
         | 
   485   | 
         | 
   486 # Setting the INLINE_SOURCES tag to YES will include the body   | 
         | 
   487 # of functions and classes directly in the documentation.  | 
         | 
   488   | 
         | 
   489 INLINE_SOURCES         = NO  | 
         | 
   490   | 
         | 
   491 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct   | 
         | 
   492 # doxygen to hide any special comment blocks from generated source code   | 
         | 
   493 # fragments. Normal C and C++ comments will always remain visible.  | 
         | 
   494   | 
         | 
   495 STRIP_CODE_COMMENTS    = YES  | 
         | 
   496   | 
         | 
   497 # If the REFERENCED_BY_RELATION tag is set to YES (the default)   | 
         | 
   498 # then for each documented function all documented   | 
         | 
   499 # functions referencing it will be listed.  | 
         | 
   500   | 
         | 
   501 REFERENCED_BY_RELATION = YES  | 
         | 
   502   | 
         | 
   503 # If the REFERENCES_RELATION tag is set to YES (the default)   | 
         | 
   504 # then for each documented function all documented entities   | 
         | 
   505 # called/used by that function will be listed.  | 
         | 
   506   | 
         | 
   507 REFERENCES_RELATION    = YES  | 
         | 
   508   | 
         | 
   509 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen   | 
         | 
   510 # will generate a verbatim copy of the header file for each class for   | 
         | 
   511 # which an include is specified. Set to NO to disable this.  | 
         | 
   512   | 
         | 
   513 VERBATIM_HEADERS       = YES  | 
         | 
   514   | 
         | 
   515 #---------------------------------------------------------------------------  | 
         | 
   516 # configuration options related to the alphabetical class index  | 
         | 
   517 #---------------------------------------------------------------------------  | 
         | 
   518   | 
         | 
   519 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index   | 
         | 
   520 # of all compounds will be generated. Enable this if the project   | 
         | 
   521 # contains a lot of classes, structs, unions or interfaces.  | 
         | 
   522   | 
         | 
   523 ALPHABETICAL_INDEX     = YES  | 
         | 
   524   | 
         | 
   525 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then   | 
         | 
   526 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns   | 
         | 
   527 # in which this list will be split (can be a number in the range [1..20])  | 
         | 
   528   | 
         | 
   529 COLS_IN_ALPHA_INDEX    = 2  | 
         | 
   530   | 
         | 
   531 # In case all classes in a project start with a common prefix, all   | 
         | 
   532 # classes will be put under the same header in the alphabetical index.   | 
         | 
   533 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that   | 
         | 
   534 # should be ignored while generating the index headers.  | 
         | 
   535   | 
         | 
   536 IGNORE_PREFIX          =   | 
         | 
   537   | 
         | 
   538 #---------------------------------------------------------------------------  | 
         | 
   539 # configuration options related to the HTML output  | 
         | 
   540 #---------------------------------------------------------------------------  | 
         | 
   541   | 
         | 
   542 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will   | 
         | 
   543 # generate HTML output.  | 
         | 
   544   | 
         | 
   545 GENERATE_HTML          = YES  | 
         | 
   546   | 
         | 
   547 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.   | 
         | 
   548 # If a relative path is entered the value of OUTPUT_DIRECTORY will be   | 
         | 
   549 # put in front of it. If left blank `html' will be used as the default path.  | 
         | 
   550   | 
         | 
   551 HTML_OUTPUT            = html  | 
         | 
   552   | 
         | 
   553 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for   | 
         | 
   554 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank   | 
         | 
   555 # doxygen will generate files with .html extension.  | 
         | 
   556   | 
         | 
   557 HTML_FILE_EXTENSION    = .html  | 
         | 
   558   | 
         | 
   559 # The HTML_HEADER tag can be used to specify a personal HTML header for   | 
         | 
   560 # each generated HTML page. If it is left blank doxygen will generate a   | 
         | 
   561 # standard header.  | 
         | 
   562   | 
         | 
   563 HTML_HEADER            =   | 
         | 
   564   | 
         | 
   565 # The HTML_FOOTER tag can be used to specify a personal HTML footer for   | 
         | 
   566 # each generated HTML page. If it is left blank doxygen will generate a   | 
         | 
   567 # standard footer.  | 
         | 
   568   | 
         | 
   569 HTML_FOOTER            =   | 
         | 
   570   | 
         | 
   571 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading   | 
         | 
   572 # style sheet that is used by each HTML page. It can be used to   | 
         | 
   573 # fine-tune the look of the HTML output. If the tag is left blank doxygen   | 
         | 
   574 # will generate a default style sheet. Note that doxygen will try to copy   | 
         | 
   575 # the style sheet file to the HTML output directory, so don't put your own   | 
         | 
   576 # stylesheet in the HTML output directory as well, or it will be erased!  | 
         | 
   577   | 
         | 
   578 HTML_STYLESHEET        =   | 
         | 
   579   | 
         | 
   580 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,   | 
         | 
   581 # files or namespaces will be aligned in HTML using tables. If set to   | 
         | 
   582 # NO a bullet list will be used.  | 
         | 
   583   | 
         | 
   584 HTML_ALIGN_MEMBERS     = YES  | 
         | 
   585   | 
         | 
   586 # If the GENERATE_HTMLHELP tag is set to YES, additional index files   | 
         | 
   587 # will be generated that can be used as input for tools like the   | 
         | 
   588 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)   | 
         | 
   589 # of the generated HTML documentation.  | 
         | 
   590   | 
         | 
   591 GENERATE_HTMLHELP      = NO  | 
         | 
   592   | 
         | 
   593 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can   | 
         | 
   594 # be used to specify the file name of the resulting .chm file. You   | 
         | 
   595 # can add a path in front of the file if the result should not be   | 
         | 
   596 # written to the html output directory.  | 
         | 
   597   | 
         | 
   598 CHM_FILE               =   | 
         | 
   599   | 
         | 
   600 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can   | 
         | 
   601 # be used to specify the location (absolute path including file name) of   | 
         | 
   602 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run   | 
         | 
   603 # the HTML help compiler on the generated index.hhp.  | 
         | 
   604   | 
         | 
   605 HHC_LOCATION           =   | 
         | 
   606   | 
         | 
   607 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag   | 
         | 
   608 # controls if a separate .chi index file is generated (YES) or that   | 
         | 
   609 # it should be included in the master .chm file (NO).  | 
         | 
   610   | 
         | 
   611 GENERATE_CHI           = NO  | 
         | 
   612   | 
         | 
   613 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag   | 
         | 
   614 # controls whether a binary table of contents is generated (YES) or a   | 
         | 
   615 # normal table of contents (NO) in the .chm file.  | 
         | 
   616   | 
         | 
   617 BINARY_TOC             = NO  | 
         | 
   618   | 
         | 
   619 # The TOC_EXPAND flag can be set to YES to add extra items for group members   | 
         | 
   620 # to the contents of the HTML help documentation and to the tree view.  | 
         | 
   621   | 
         | 
   622 TOC_EXPAND             = NO  | 
         | 
   623   | 
         | 
   624 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at   | 
         | 
   625 # top of each HTML page. The value NO (the default) enables the index and   | 
         | 
   626 # the value YES disables it.  | 
         | 
   627   | 
         | 
   628 DISABLE_INDEX          = NO  | 
         | 
   629   | 
         | 
   630 # This tag can be used to set the number of enum values (range [1..20])   | 
         | 
   631 # that doxygen will group on one line in the generated HTML documentation.  | 
         | 
   632   | 
         | 
   633 ENUM_VALUES_PER_LINE   = 4  | 
         | 
   634   | 
         | 
   635 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be  | 
         | 
   636 # generated containing a tree-like index structure (just like the one that   | 
         | 
   637 # is generated for HTML Help). For this to work a browser that supports   | 
         | 
   638 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,   | 
         | 
   639 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are   | 
         | 
   640 # probably better off using the HTML help feature.  | 
         | 
   641   | 
         | 
   642 GENERATE_TREEVIEW      = YES  | 
         | 
   643   | 
         | 
   644 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be   | 
         | 
   645 # used to set the initial width (in pixels) of the frame in which the tree   | 
         | 
   646 # is shown.  | 
         | 
   647   | 
         | 
   648 TREEVIEW_WIDTH         = 250  | 
         | 
   649   | 
         | 
   650 #---------------------------------------------------------------------------  | 
         | 
   651 # configuration options related to the LaTeX output  | 
         | 
   652 #---------------------------------------------------------------------------  | 
         | 
   653   | 
         | 
   654 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will   | 
         | 
   655 # generate Latex output.  | 
         | 
   656   | 
         | 
   657 GENERATE_LATEX         = NO  | 
         | 
   658   | 
         | 
   659 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.   | 
         | 
   660 # If a relative path is entered the value of OUTPUT_DIRECTORY will be   | 
         | 
   661 # put in front of it. If left blank `latex' will be used as the default path.  | 
         | 
   662   | 
         | 
   663 LATEX_OUTPUT           = latex  | 
         | 
   664   | 
         | 
   665 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be   | 
         | 
   666 # invoked. If left blank `latex' will be used as the default command name.  | 
         | 
   667   | 
         | 
   668 LATEX_CMD_NAME         = latex  | 
         | 
   669   | 
         | 
   670 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to   | 
         | 
   671 # generate index for LaTeX. If left blank `makeindex' will be used as the   | 
         | 
   672 # default command name.  | 
         | 
   673   | 
         | 
   674 MAKEINDEX_CMD_NAME     = makeindex  | 
         | 
   675   | 
         | 
   676 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact   | 
         | 
   677 # LaTeX documents. This may be useful for small projects and may help to   | 
         | 
   678 # save some trees in general.  | 
         | 
   679   | 
         | 
   680 COMPACT_LATEX          = YES  | 
         | 
   681   | 
         | 
   682 # The PAPER_TYPE tag can be used to set the paper type that is used   | 
         | 
   683 # by the printer. Possible values are: a4, a4wide, letter, legal and   | 
         | 
   684 # executive. If left blank a4wide will be used.  | 
         | 
   685   | 
         | 
   686 PAPER_TYPE             = a4wide  | 
         | 
   687   | 
         | 
   688 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX   | 
         | 
   689 # packages that should be included in the LaTeX output.  | 
         | 
   690   | 
         | 
   691 EXTRA_PACKAGES         =   | 
         | 
   692   | 
         | 
   693 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for   | 
         | 
   694 # the generated latex document. The header should contain everything until   | 
         | 
   695 # the first chapter. If it is left blank doxygen will generate a   | 
         | 
   696 # standard header. Notice: only use this tag if you know what you are doing!  | 
         | 
   697   | 
         | 
   698 LATEX_HEADER           =   | 
         | 
   699   | 
         | 
   700 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated   | 
         | 
   701 # is prepared for conversion to pdf (using ps2pdf). The pdf file will   | 
         | 
   702 # contain links (just like the HTML output) instead of page references   | 
         | 
   703 # This makes the output suitable for online browsing using a pdf viewer.  | 
         | 
   704   | 
         | 
   705 PDF_HYPERLINKS         = YES  | 
         | 
   706   | 
         | 
   707 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of   | 
         | 
   708 # plain latex in the generated Makefile. Set this option to YES to get a   | 
         | 
   709 # higher quality PDF documentation.  | 
         | 
   710   | 
         | 
   711 USE_PDFLATEX           = YES  | 
         | 
   712   | 
         | 
   713 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.   | 
         | 
   714 # command to the generated LaTeX files. This will instruct LaTeX to keep   | 
         | 
   715 # running if errors occur, instead of asking the user for help.   | 
         | 
   716 # This option is also used when generating formulas in HTML.  | 
         | 
   717   | 
         | 
   718 LATEX_BATCHMODE        = NO  | 
         | 
   719   | 
         | 
   720 # If LATEX_HIDE_INDICES is set to YES then doxygen will not   | 
         | 
   721 # include the index chapters (such as File Index, Compound Index, etc.)   | 
         | 
   722 # in the output.  | 
         | 
   723   | 
         | 
   724 LATEX_HIDE_INDICES     = NO  | 
         | 
   725   | 
         | 
   726 #---------------------------------------------------------------------------  | 
         | 
   727 # configuration options related to the RTF output  | 
         | 
   728 #---------------------------------------------------------------------------  | 
         | 
   729   | 
         | 
   730 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output   | 
         | 
   731 # The RTF output is optimized for Word 97 and may not look very pretty with   | 
         | 
   732 # other RTF readers or editors.  | 
         | 
   733   | 
         | 
   734 GENERATE_RTF           = NO  | 
         | 
   735   | 
         | 
   736 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.   | 
         | 
   737 # If a relative path is entered the value of OUTPUT_DIRECTORY will be   | 
         | 
   738 # put in front of it. If left blank `rtf' will be used as the default path.  | 
         | 
   739   | 
         | 
   740 RTF_OUTPUT             = rtf  | 
         | 
   741   | 
         | 
   742 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact   | 
         | 
   743 # RTF documents. This may be useful for small projects and may help to   | 
         | 
   744 # save some trees in general.  | 
         | 
   745   | 
         | 
   746 COMPACT_RTF            = NO  | 
         | 
   747   | 
         | 
   748 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated   | 
         | 
   749 # will contain hyperlink fields. The RTF file will   | 
         | 
   750 # contain links (just like the HTML output) instead of page references.   | 
         | 
   751 # This makes the output suitable for online browsing using WORD or other   | 
         | 
   752 # programs which support those fields.   | 
         | 
   753 # Note: wordpad (write) and others do not support links.  | 
         | 
   754   | 
         | 
   755 RTF_HYPERLINKS         = NO  | 
         | 
   756   | 
         | 
   757 # Load stylesheet definitions from file. Syntax is similar to doxygen's   | 
         | 
   758 # config file, i.e. a series of assignments. You only have to provide   | 
         | 
   759 # replacements, missing definitions are set to their default value.  | 
         | 
   760   | 
         | 
   761 RTF_STYLESHEET_FILE    =   | 
         | 
   762   | 
         | 
   763 # Set optional variables used in the generation of an rtf document.   | 
         | 
   764 # Syntax is similar to doxygen's config file.  | 
         | 
   765   | 
         | 
   766 RTF_EXTENSIONS_FILE    =   | 
         | 
   767   | 
         | 
   768 #---------------------------------------------------------------------------  | 
         | 
   769 # configuration options related to the man page output  | 
         | 
   770 #---------------------------------------------------------------------------  | 
         | 
   771   | 
         | 
   772 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will   | 
         | 
   773 # generate man pages  | 
         | 
   774   | 
         | 
   775 GENERATE_MAN           = NO  | 
         | 
   776   | 
         | 
   777 # The MAN_OUTPUT tag is used to specify where the man pages will be put.   | 
         | 
   778 # If a relative path is entered the value of OUTPUT_DIRECTORY will be   | 
         | 
   779 # put in front of it. If left blank `man' will be used as the default path.  | 
         | 
   780   | 
         | 
   781 MAN_OUTPUT             = man  | 
         | 
   782   | 
         | 
   783 # The MAN_EXTENSION tag determines the extension that is added to   | 
         | 
   784 # the generated man pages (default is the subroutine's section .3)  | 
         | 
   785   | 
         | 
   786 MAN_EXTENSION          = .3  | 
         | 
   787   | 
         | 
   788 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,   | 
         | 
   789 # then it will generate one additional man file for each entity   | 
         | 
   790 # documented in the real man page(s). These additional files   | 
         | 
   791 # only source the real man page, but without them the man command   | 
         | 
   792 # would be unable to find the correct page. The default is NO.  | 
         | 
   793   | 
         | 
   794 MAN_LINKS              = NO  | 
         | 
   795   | 
         | 
   796 #---------------------------------------------------------------------------  | 
         | 
   797 # configuration options related to the XML output  | 
         | 
   798 #---------------------------------------------------------------------------  | 
         | 
   799   | 
         | 
   800 # If the GENERATE_XML tag is set to YES Doxygen will   | 
         | 
   801 # generate an XML file that captures the structure of   | 
         | 
   802 # the code including all documentation.  | 
         | 
   803   | 
         | 
   804 GENERATE_XML           = NO  | 
         | 
   805   | 
         | 
   806 # The XML_OUTPUT tag is used to specify where the XML pages will be put.   | 
         | 
   807 # If a relative path is entered the value of OUTPUT_DIRECTORY will be   | 
         | 
   808 # put in front of it. If left blank `xml' will be used as the default path.  | 
         | 
   809   | 
         | 
   810 XML_OUTPUT             = xml  | 
         | 
   811   | 
         | 
   812 # The XML_SCHEMA tag can be used to specify an XML schema,   | 
         | 
   813 # which can be used by a validating XML parser to check the   | 
         | 
   814 # syntax of the XML files.  | 
         | 
   815   | 
         | 
   816 XML_SCHEMA             =   | 
         | 
   817   | 
         | 
   818 # The XML_DTD tag can be used to specify an XML DTD,   | 
         | 
   819 # which can be used by a validating XML parser to check the   | 
         | 
   820 # syntax of the XML files.  | 
         | 
   821   | 
         | 
   822 XML_DTD                =   | 
         | 
   823   | 
         | 
   824 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will   | 
         | 
   825 # dump the program listings (including syntax highlighting   | 
         | 
   826 # and cross-referencing information) to the XML output. Note that   | 
         | 
   827 # enabling this will significantly increase the size of the XML output.  | 
         | 
   828   | 
         | 
   829 XML_PROGRAMLISTING     = YES  | 
         | 
   830   | 
         | 
   831 #---------------------------------------------------------------------------  | 
         | 
   832 # configuration options for the AutoGen Definitions output  | 
         | 
   833 #---------------------------------------------------------------------------  | 
         | 
   834   | 
         | 
   835 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will   | 
         | 
   836 # generate an AutoGen Definitions (see autogen.sf.net) file   | 
         | 
   837 # that captures the structure of the code including all   | 
         | 
   838 # documentation. Note that this feature is still experimental   | 
         | 
   839 # and incomplete at the moment.  | 
         | 
   840   | 
         | 
   841 GENERATE_AUTOGEN_DEF   = NO  | 
         | 
   842   | 
         | 
   843 #---------------------------------------------------------------------------  | 
         | 
   844 # configuration options related to the Perl module output  | 
         | 
   845 #---------------------------------------------------------------------------  | 
         | 
   846   | 
         | 
   847 # If the GENERATE_PERLMOD tag is set to YES Doxygen will   | 
         | 
   848 # generate a Perl module file that captures the structure of   | 
         | 
   849 # the code including all documentation. Note that this   | 
         | 
   850 # feature is still experimental and incomplete at the   | 
         | 
   851 # moment.  | 
         | 
   852   | 
         | 
   853 GENERATE_PERLMOD       = NO  | 
         | 
   854   | 
         | 
   855 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate   | 
         | 
   856 # the necessary Makefile rules, Perl scripts and LaTeX code to be able   | 
         | 
   857 # to generate PDF and DVI output from the Perl module output.  | 
         | 
   858   | 
         | 
   859 PERLMOD_LATEX          = NO  | 
         | 
   860   | 
         | 
   861 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be   | 
         | 
   862 # nicely formatted so it can be parsed by a human reader.  This is useful   | 
         | 
   863 # if you want to understand what is going on.  On the other hand, if this   | 
         | 
   864 # tag is set to NO the size of the Perl module output will be much smaller   | 
         | 
   865 # and Perl will parse it just the same.  | 
         | 
   866   | 
         | 
   867 PERLMOD_PRETTY         = YES  | 
         | 
   868   | 
         | 
   869 # The names of the make variables in the generated doxyrules.make file   | 
         | 
   870 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.   | 
         | 
   871 # This is useful so different doxyrules.make files included by the same   | 
         | 
   872 # Makefile don't overwrite each other's variables.  | 
         | 
   873   | 
         | 
   874 PERLMOD_MAKEVAR_PREFIX =   | 
         | 
   875   | 
         | 
   876 #---------------------------------------------------------------------------  | 
         | 
   877 # Configuration options related to the preprocessor     | 
         | 
   878 #---------------------------------------------------------------------------  | 
         | 
   879   | 
         | 
   880 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will   | 
         | 
   881 # evaluate all C-preprocessor directives found in the sources and include   | 
         | 
   882 # files.  | 
         | 
   883   | 
         | 
   884 ENABLE_PREPROCESSING   = YES  | 
         | 
   885   | 
         | 
   886 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro   | 
         | 
   887 # names in the source code. If set to NO (the default) only conditional   | 
         | 
   888 # compilation will be performed. Macro expansion can be done in a controlled   | 
         | 
   889 # way by setting EXPAND_ONLY_PREDEF to YES.  | 
         | 
   890   | 
         | 
   891 MACRO_EXPANSION        = NO  | 
         | 
   892   | 
         | 
   893 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES   | 
         | 
   894 # then the macro expansion is limited to the macros specified with the   | 
         | 
   895 # PREDEFINED and EXPAND_AS_PREDEFINED tags.  | 
         | 
   896   | 
         | 
   897 EXPAND_ONLY_PREDEF     = NO  | 
         | 
   898   | 
         | 
   899 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files   | 
         | 
   900 # in the INCLUDE_PATH (see below) will be search if a #include is found.  | 
         | 
   901   | 
         | 
   902 SEARCH_INCLUDES        = YES  | 
         | 
   903   | 
         | 
   904 # The INCLUDE_PATH tag can be used to specify one or more directories that   | 
         | 
   905 # contain include files that are not input files but should be processed by   | 
         | 
   906 # the preprocessor.  | 
         | 
   907   | 
         | 
   908 INCLUDE_PATH           =   | 
         | 
   909   | 
         | 
   910 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard   | 
         | 
   911 # patterns (like *.h and *.hpp) to filter out the header-files in the   | 
         | 
   912 # directories. If left blank, the patterns specified with FILE_PATTERNS will   | 
         | 
   913 # be used.  | 
         | 
   914   | 
         | 
   915 INCLUDE_FILE_PATTERNS  =   | 
         | 
   916   | 
         | 
   917 # The PREDEFINED tag can be used to specify one or more macro names that   | 
         | 
   918 # are defined before the preprocessor is started (similar to the -D option of   | 
         | 
   919 # gcc). The argument of the tag is a list of macros of the form: name   | 
         | 
   920 # or name=definition (no spaces). If the definition and the = are   | 
         | 
   921 # omitted =1 is assumed.  | 
         | 
   922   | 
         | 
   923 PREDEFINED             = DOXYGEN  | 
         | 
   924   | 
         | 
   925 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then   | 
         | 
   926 # this tag can be used to specify a list of macro names that should be expanded.   | 
         | 
   927 # The macro definition that is found in the sources will be used.   | 
         | 
   928 # Use the PREDEFINED tag if you want to use a different macro definition.  | 
         | 
   929   | 
         | 
   930 EXPAND_AS_DEFINED      =   | 
         | 
   931   | 
         | 
   932 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then   | 
         | 
   933 # doxygen's preprocessor will remove all function-like macros that are alone   | 
         | 
   934 # on a line, have an all uppercase name, and do not end with a semicolon. Such   | 
         | 
   935 # function macros are typically used for boiler-plate code, and will confuse the   | 
         | 
   936 # parser if not removed.  | 
         | 
   937   | 
         | 
   938 SKIP_FUNCTION_MACROS   = YES  | 
         | 
   939   | 
         | 
   940 #---------------------------------------------------------------------------  | 
         | 
   941 # Configuration::additions related to external references     | 
         | 
   942 #---------------------------------------------------------------------------  | 
         | 
   943   | 
         | 
   944 # The TAGFILES option can be used to specify one or more tagfiles.   | 
         | 
   945 # Optionally an initial location of the external documentation   | 
         | 
   946 # can be added for each tagfile. The format of a tag file without   | 
         | 
   947 # this location is as follows:   | 
         | 
   948 #   TAGFILES = file1 file2 ...   | 
         | 
   949 # Adding location for the tag files is done as follows:   | 
         | 
   950 #   TAGFILES = file1=loc1 "file2 = loc2" ...   | 
         | 
   951 # where "loc1" and "loc2" can be relative or absolute paths or   | 
         | 
   952 # URLs. If a location is present for each tag, the installdox tool   | 
         | 
   953 # does not have to be run to correct the links.  | 
         | 
   954 # Note that each tag file must have a unique name  | 
         | 
   955 # (where the name does NOT include the path)  | 
         | 
   956 # If a tag file is not located in the directory in which doxygen   | 
         | 
   957 # is run, you must also specify the path to the tagfile here.  | 
         | 
   958   | 
         | 
   959 TAGFILES               =   | 
         | 
   960   | 
         | 
   961 # When a file name is specified after GENERATE_TAGFILE, doxygen will create   | 
         | 
   962 # a tag file that is based on the input files it reads.  | 
         | 
   963   | 
         | 
   964 GENERATE_TAGFILE       =   | 
         | 
   965   | 
         | 
   966 # If the ALLEXTERNALS tag is set to YES all external classes will be listed   | 
         | 
   967 # in the class index. If set to NO only the inherited external classes   | 
         | 
   968 # will be listed.  | 
         | 
   969   | 
         | 
   970 ALLEXTERNALS           = NO  | 
         | 
   971   | 
         | 
   972 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed   | 
         | 
   973 # in the modules index. If set to NO, only the current project's groups will   | 
         | 
   974 # be listed.  | 
         | 
   975   | 
         | 
   976 EXTERNAL_GROUPS        = YES  | 
         | 
   977   | 
         | 
   978 # The PERL_PATH should be the absolute path and name of the perl script   | 
         | 
   979 # interpreter (i.e. the result of `which perl').  | 
         | 
   980   | 
         | 
   981 PERL_PATH              = /usr/bin/perl  | 
         | 
   982   | 
         | 
   983 #---------------------------------------------------------------------------  | 
         | 
   984 # Configuration options related to the dot tool     | 
         | 
   985 #---------------------------------------------------------------------------  | 
         | 
   986   | 
         | 
   987 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will   | 
         | 
   988 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or   | 
         | 
   989 # super classes. Setting the tag to NO turns the diagrams off. Note that this   | 
         | 
   990 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is   | 
         | 
   991 # recommended to install and use dot, since it yields more powerful graphs.  | 
         | 
   992   | 
         | 
   993 CLASS_DIAGRAMS         = YES  | 
         | 
   994   | 
         | 
   995 # If set to YES, the inheritance and collaboration graphs will hide   | 
         | 
   996 # inheritance and usage relations if the target is undocumented   | 
         | 
   997 # or is not a class.  | 
         | 
   998   | 
         | 
   999 HIDE_UNDOC_RELATIONS   = NO  | 
         | 
  1000   | 
         | 
  1001 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is   | 
         | 
  1002 # available from the path. This tool is part of Graphviz, a graph visualization   | 
         | 
  1003 # toolkit from AT&T and Lucent Bell Labs. The other options in this section   | 
         | 
  1004 # have no effect if this option is set to NO (the default)  | 
         | 
  1005   | 
         | 
  1006 HAVE_DOT               = YES  | 
         | 
  1007   | 
         | 
  1008 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen   | 
         | 
  1009 # will generate a graph for each documented class showing the direct and   | 
         | 
  1010 # indirect inheritance relations. Setting this tag to YES will force the   | 
         | 
  1011 # the CLASS_DIAGRAMS tag to NO.  | 
         | 
  1012   | 
         | 
  1013 CLASS_GRAPH            = YES  | 
         | 
  1014   | 
         | 
  1015 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen   | 
         | 
  1016 # will generate a graph for each documented class showing the direct and   | 
         | 
  1017 # indirect implementation dependencies (inheritance, containment, and   | 
         | 
  1018 # class references variables) of the class with other documented classes.  | 
         | 
  1019   | 
         | 
  1020 COLLABORATION_GRAPH    = YES  | 
         | 
  1021   | 
         | 
  1022 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and   | 
         | 
  1023 # collaboration diagrams in a style similar to the OMG's Unified Modeling   | 
         | 
  1024 # Language.  | 
         | 
  1025   | 
         | 
  1026 UML_LOOK               = NO  | 
         | 
  1027   | 
         | 
  1028 # If set to YES, the inheritance and collaboration graphs will show the   | 
         | 
  1029 # relations between templates and their instances.  | 
         | 
  1030   | 
         | 
  1031 TEMPLATE_RELATIONS     = YES  | 
         | 
  1032   | 
         | 
  1033 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT   | 
         | 
  1034 # tags are set to YES then doxygen will generate a graph for each documented   | 
         | 
  1035 # file showing the direct and indirect include dependencies of the file with   | 
         | 
  1036 # other documented files.  | 
         | 
  1037   | 
         | 
  1038 INCLUDE_GRAPH          = YES  | 
         | 
  1039   | 
         | 
  1040 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and   | 
         | 
  1041 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each   | 
         | 
  1042 # documented header file showing the documented files that directly or   | 
         | 
  1043 # indirectly include this file.  | 
         | 
  1044   | 
         | 
  1045 INCLUDED_BY_GRAPH      = YES  | 
         | 
  1046   | 
         | 
  1047 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will   | 
         | 
  1048 # generate a call dependency graph for every global function or class method.   | 
         | 
  1049 # Note that enabling this option will significantly increase the time of a run.   | 
         | 
  1050 # So in most cases it will be better to enable call graphs for selected   | 
         | 
  1051 # functions only using the \callgraph command.  | 
         | 
  1052   | 
         | 
  1053 CALL_GRAPH             = YES  | 
         | 
  1054   | 
         | 
  1055 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen   | 
         | 
  1056 # will graphical hierarchy of all classes instead of a textual one.  | 
         | 
  1057   | 
         | 
  1058 GRAPHICAL_HIERARCHY    = YES  | 
         | 
  1059   | 
         | 
  1060 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images   | 
         | 
  1061 # generated by dot. Possible values are png, jpg, or gif  | 
         | 
  1062 # If left blank png will be used.  | 
         | 
  1063   | 
         | 
  1064 DOT_IMAGE_FORMAT       = png  | 
         | 
  1065   | 
         | 
  1066 # The tag DOT_PATH can be used to specify the path where the dot tool can be   | 
         | 
  1067 # found. If left blank, it is assumed the dot tool can be found on the path.  | 
         | 
  1068   | 
         | 
  1069 DOT_PATH               =   | 
         | 
  1070   | 
         | 
  1071 # The DOTFILE_DIRS tag can be used to specify one or more directories that   | 
         | 
  1072 # contain dot files that are included in the documentation (see the   | 
         | 
  1073 # \dotfile command).  | 
         | 
  1074   | 
         | 
  1075 DOTFILE_DIRS           =   | 
         | 
  1076   | 
         | 
  1077 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width   | 
         | 
  1078 # (in pixels) of the graphs generated by dot. If a graph becomes larger than   | 
         | 
  1079 # this value, doxygen will try to truncate the graph, so that it fits within   | 
         | 
  1080 # the specified constraint. Beware that most browsers cannot cope with very   | 
         | 
  1081 # large images.  | 
         | 
  1082   | 
         | 
  1083 MAX_DOT_GRAPH_WIDTH    = 1024  | 
         | 
  1084   | 
         | 
  1085 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height   | 
         | 
  1086 # (in pixels) of the graphs generated by dot. If a graph becomes larger than   | 
         | 
  1087 # this value, doxygen will try to truncate the graph, so that it fits within   | 
         | 
  1088 # the specified constraint. Beware that most browsers cannot cope with very   | 
         | 
  1089 # large images.  | 
         | 
  1090   | 
         | 
  1091 MAX_DOT_GRAPH_HEIGHT   = 1024  | 
         | 
  1092   | 
         | 
  1093 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the   | 
         | 
  1094 # graphs generated by dot. A depth value of 3 means that only nodes reachable   | 
         | 
  1095 # from the root by following a path via at most 3 edges will be shown. Nodes that   | 
         | 
  1096 # lay further from the root node will be omitted. Note that setting this option to   | 
         | 
  1097 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also   | 
         | 
  1098 # note that a graph may be further truncated if the graph's image dimensions are   | 
         | 
  1099 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).   | 
         | 
  1100 # If 0 is used for the depth value (the default), the graph is not depth-constrained.  | 
         | 
  1101   | 
         | 
  1102 MAX_DOT_GRAPH_DEPTH    = 0  | 
         | 
  1103   | 
         | 
  1104 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will   | 
         | 
  1105 # generate a legend page explaining the meaning of the various boxes and   | 
         | 
  1106 # arrows in the dot generated graphs.  | 
         | 
  1107   | 
         | 
  1108 GENERATE_LEGEND        = YES  | 
         | 
  1109   | 
         | 
  1110 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will   | 
         | 
  1111 # remove the intermediate dot files that are used to generate   | 
         | 
  1112 # the various graphs.  | 
         | 
  1113   | 
         | 
  1114 DOT_CLEANUP            = YES  | 
         | 
  1115   | 
         | 
  1116 #---------------------------------------------------------------------------  | 
         | 
  1117 # Configuration::additions related to the search engine     | 
         | 
  1118 #---------------------------------------------------------------------------  | 
         | 
  1119   | 
         | 
  1120 # The SEARCHENGINE tag specifies whether or not a search engine should be   | 
         | 
  1121 # used. If set to NO the values of all tags below this one will be ignored.  | 
         | 
  1122   | 
         | 
  1123 SEARCHENGINE           = YES  |