openbcm

Git mirror of https://github.com/Broadcom-Network-Switching-Software/OpenBCM
git clone git://git.finwo.net/mirror/broadcom/openbcm
Log | Files | Refs | README

merlin16_pcieg3.doxyfile (54038B)


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