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