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