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