1: # Doxyfile 1.3.4 2: 3: # This file describes the settings to be used by the documentation system 4: # doxygen (www.doxygen.org) for a project 5: # 6: # All text after a hash (#) is considered a comment and will be ignored 7: # The format is: 8: # TAG = value [value, ...] 9: # For lists items can also be appended using: 10: # TAG += value [value, ...] 11: # Values that contain spaces should be placed between quotes (" ") 12: 13: #--------------------------------------------------------------------------- 14: # Project related configuration options 15: #--------------------------------------------------------------------------- 16: 17: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18: # by quotes) that should identify the project. 19: 20: PROJECT_NAME = 21: 22: # The PROJECT_NUMBER tag can be used to enter a project or revision number. 23: # This could be handy for archiving the generated documentation or 24: # if some version control system is used. 25: 26: PROJECT_NUMBER = 27: 28: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 29: # base path where the generated documentation will be put. 30: # If a relative path is entered, it will be relative to the location 31: # where doxygen was started. If left blank the current directory will be used. 32: 33: OUTPUT_DIRECTORY = 34: 35: # The OUTPUT_LANGUAGE tag is used to specify the language in which all 36: # documentation generated by doxygen is written. Doxygen will use this 37: # information to generate all constant output in the proper language. 38: # The default language is English, other supported languages are: 39: # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 40: # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 41: # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 42: # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 43: 44: OUTPUT_LANGUAGE = Japanese 45: 46: # This tag can be used to specify the encoding used in the generated output. 47: # The encoding is not always determined by the language that is chosen, 48: # but also whether or not the output is meant for Windows or non-Windows users. 49: # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 50: # forces the Windows encoding (this is the default for the Windows binary), 51: # whereas setting the tag to NO uses a Unix-style encoding (the default for 52: # all platforms other than Windows). 53: 54: USE_WINDOWS_ENCODING = NO 55: 56: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 57: # include brief member descriptions after the members that are listed in 58: # the file and class documentation (similar to JavaDoc). 59: # Set to NO to disable this. 60: 61: BRIEF_MEMBER_DESC = YES 62: 63: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 64: # the brief description of a member or function before the detailed description. 65: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 66: # brief descriptions will be completely suppressed. 67: 68: REPEAT_BRIEF = YES 69: 70: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 71: # Doxygen will generate a detailed section even if there is only a brief 72: # description. 73: 74: ALWAYS_DETAILED_SEC = NO 75: 76: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 77: # members of a class in the documentation of that class as if those members were 78: # ordinary class members. Constructors, destructors and assignment operators of 79: # the base classes will not be shown. 80: 81: INLINE_INHERITED_MEMB = NO 82: 83: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 84: # path before files name in the file list and in the header files. If set 85: # to NO the shortest path that makes the file name unique will be used. 86: 87: FULL_PATH_NAMES = NO 88: 89: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 90: # can be used to strip a user-defined part of the path. Stripping is 91: # only done if one of the specified strings matches the left-hand part of 92: # the path. It is allowed to use relative paths in the argument list. 93: 94: STRIP_FROM_PATH = 95: 96: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 97: # (but less readable) file names. This can be useful is your file systems 98: # doesn't support long names like on DOS, Mac, or CD-ROM. 99: 100: SHORT_NAMES = NO 101: 102: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 103: # will interpret the first line (until the first dot) of a JavaDoc-style 104: # comment as the brief description. If set to NO, the JavaDoc 105: # comments will behave just like the Qt-style comments (thus requiring an 106: # explict @brief command for a brief description. 107: 108: JAVADOC_AUTOBRIEF = NO 109: 110: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 111: # treat a multi-line C++ special comment block (i.e. a block of //! or /// 112: # comments) as a brief description. This used to be the default behaviour. 113: # The new default is to treat a multi-line C++ comment block as a detailed 114: # description. Set this tag to YES if you prefer the old behaviour instead. 115: 116: MULTILINE_CPP_IS_BRIEF = NO 117: 118: # If the DETAILS_AT_TOP tag is set to YES then Doxygen 119: # will output the detailed description near the top, like JavaDoc. 120: # If set to NO, the detailed description appears after the member 121: # documentation. 122: 123: DETAILS_AT_TOP = NO 124: 125: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 126: # member inherits the documentation from any documented member that it 127: # reimplements. 128: 129: INHERIT_DOCS = YES 130: 131: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 132: # tag is set to YES, then doxygen will reuse the documentation of the first 133: # member in the group (if any) for the other members of the group. By default 134: # all members of a group must be documented explicitly. 135: 136: DISTRIBUTE_GROUP_DOC = NO 137: 138: # The TAB_SIZE tag can be used to set the number of spaces in a tab. 139: # Doxygen uses this value to replace tabs by spaces in code fragments. 140: 141: TAB_SIZE = 8 142: 143: # This tag can be used to specify a number of aliases that acts 144: # as commands in the documentation. An alias has the form "name=value". 145: # For example adding "sideeffect=\par Side Effects:\n" will allow you to 146: # put the command \sideeffect (or @sideeffect) in the documentation, which 147: # will result in a user-defined paragraph with heading "Side Effects:". 148: # You can put \n's in the value part of an alias to insert newlines. 149: 150: ALIASES = 151: 152: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 153: # only. Doxygen will then generate output that is more tailored for C. 154: # For instance, some of the names that are used will be different. The list 155: # of all members will be omitted, etc. 156: 157: OPTIMIZE_OUTPUT_FOR_C = NO 158: 159: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 160: # only. Doxygen will then generate output that is more tailored for Java. 161: # For instance, namespaces will be presented as packages, qualified scopes 162: # will look different, etc. 163: 164: OPTIMIZE_OUTPUT_JAVA = NO 165: 166: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 167: # the same type (for instance a group of public functions) to be put as a 168: # subgroup of that type (e.g. under the Public Functions section). Set it to 169: # NO to prevent subgrouping. Alternatively, this can be done per class using 170: # the \nosubgrouping command. 171: 172: SUBGROUPING = YES 173: 174: #--------------------------------------------------------------------------- 175: # Build related configuration options 176: #--------------------------------------------------------------------------- 177: 178: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 179: # documentation are documented, even if no documentation was available. 180: # Private class members and static file members will be hidden unless 181: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 182: 183: EXTRACT_ALL = YES 184: 185: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 186: # will be included in the documentation. 187: 188: EXTRACT_PRIVATE = NO 189: 190: # If the EXTRACT_STATIC tag is set to YES all static members of a file 191: # will be included in the documentation. 192: 193: EXTRACT_STATIC = NO 194: 195: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 196: # defined locally in source files will be included in the documentation. 197: # If set to NO only classes defined in header files are included. 198: 199: EXTRACT_LOCAL_CLASSES = YES 200: 201: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 202: # undocumented members of documented classes, files or namespaces. 203: # If set to NO (the default) these members will be included in the 204: # various overviews, but no documentation section is generated. 205: # This option has no effect if EXTRACT_ALL is enabled. 206: 207: HIDE_UNDOC_MEMBERS = NO 208: 209: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 210: # undocumented classes that are normally visible in the class hierarchy. 211: # If set to NO (the default) these classes will be included in the various 212: # overviews. This option has no effect if EXTRACT_ALL is enabled. 213: 214: HIDE_UNDOC_CLASSES = NO 215: 216: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 217: # friend (class|struct|union) declarations. 218: # If set to NO (the default) these declarations will be included in the 219: # documentation. 220: 221: HIDE_FRIEND_COMPOUNDS = NO 222: 223: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 224: # documentation blocks found inside the body of a function. 225: # If set to NO (the default) these blocks will be appended to the 226: # function's detailed documentation block. 227: 228: HIDE_IN_BODY_DOCS = NO 229: 230: # The INTERNAL_DOCS tag determines if documentation 231: # that is typed after a \internal command is included. If the tag is set 232: # to NO (the default) then the documentation will be excluded. 233: # Set it to YES to include the internal documentation. 234: 235: INTERNAL_DOCS = NO 236: 237: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 238: # file names in lower-case letters. If set to YES upper-case letters are also 239: # allowed. This is useful if you have classes or files whose names only differ 240: # in case and if your file system supports case sensitive file names. Windows 241: # users are advised to set this option to NO. 242: 243: CASE_SENSE_NAMES = YES 244: 245: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 246: # will show members with their full class and namespace scopes in the 247: # documentation. If set to YES the scope will be hidden. 248: 249: HIDE_SCOPE_NAMES = NO 250: 251: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 252: # will put a list of the files that are included by a file in the documentation 253: # of that file. 254: 255: SHOW_INCLUDE_FILES = YES 256: 257: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 258: # is inserted in the documentation for inline members. 259: 260: INLINE_INFO = YES 261: 262: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 263: # will sort the (detailed) documentation of file and class members 264: # alphabetically by member name. If set to NO the members will appear in 265: # declaration order. 266: 267: SORT_MEMBER_DOCS = YES 268: 269: # The GENERATE_TODOLIST tag can be used to enable (YES) or 270: # disable (NO) the todo list. This list is created by putting \todo 271: # commands in the documentation. 272: 273: GENERATE_TODOLIST = YES 274: 275: # The GENERATE_TESTLIST tag can be used to enable (YES) or 276: # disable (NO) the test list. This list is created by putting \test 277: # commands in the documentation. 278: 279: GENERATE_TESTLIST = YES 280: 281: # The GENERATE_BUGLIST tag can be used to enable (YES) or 282: # disable (NO) the bug list. This list is created by putting \bug 283: # commands in the documentation. 284: 285: GENERATE_BUGLIST = YES 286: 287: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 288: # disable (NO) the deprecated list. This list is created by putting 289: # \deprecated commands in the documentation. 290: 291: GENERATE_DEPRECATEDLIST= YES 292: 293: # The ENABLED_SECTIONS tag can be used to enable conditional 294: # documentation sections, marked by \if sectionname ... \endif. 295: 296: ENABLED_SECTIONS = 297: 298: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 299: # the initial value of a variable or define consists of for it to appear in 300: # the documentation. If the initializer consists of more lines than specified 301: # here it will be hidden. Use a value of 0 to hide initializers completely. 302: # The appearance of the initializer of individual variables and defines in the 303: # documentation can be controlled using \showinitializer or \hideinitializer 304: # command in the documentation regardless of this setting. 305: 306: MAX_INITIALIZER_LINES = 30 307: 308: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 309: # at the bottom of the documentation of classes and structs. If set to YES the 310: # list will mention the files that were used to generate the documentation. 311: 312: SHOW_USED_FILES = YES 313: 314: #--------------------------------------------------------------------------- 315: # configuration options related to warning and progress messages 316: #--------------------------------------------------------------------------- 317: 318: # The QUIET tag can be used to turn on/off the messages that are generated 319: # by doxygen. Possible values are YES and NO. If left blank NO is used. 320: 321: QUIET = NO 322: 323: # The WARNINGS tag can be used to turn on/off the warning messages that are 324: # generated by doxygen. Possible values are YES and NO. If left blank 325: # NO is used. 326: 327: WARNINGS = YES 328: 329: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 330: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 331: # automatically be disabled. 332: 333: WARN_IF_UNDOCUMENTED = YES 334: 335: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 336: # potential errors in the documentation, such as not documenting some 337: # parameters in a documented function, or documenting parameters that 338: # don't exist or using markup commands wrongly. 339: 340: WARN_IF_DOC_ERROR = YES 341: 342: # The WARN_FORMAT tag determines the format of the warning messages that 343: # doxygen can produce. The string should contain the $file, $line, and $text 344: # tags, which will be replaced by the file and line number from which the 345: # warning originated and the warning text. 346: 347: WARN_FORMAT = "$file:$line: $text" 348: 349: # The WARN_LOGFILE tag can be used to specify a file to which warning 350: # and error messages should be written. If left blank the output is written 351: # to stderr. 352: 353: WARN_LOGFILE = 354: 355: #--------------------------------------------------------------------------- 356: # configuration options related to the input files 357: #--------------------------------------------------------------------------- 358: 359: # The INPUT tag can be used to specify the files and/or directories that contain 360: # documented source files. You may enter file names like "myfile.cpp" or 361: # directories like "/usr/src/myproject". Separate the files or directories 362: # with spaces. 363: 364: INPUT = src-diclib/ src-splitter/ src-ordering/ src-main/ src-util/ include/ 365: 366: # If the value of the INPUT tag contains directories, you can use the 367: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 368: # and *.h) to filter out the source-files in the directories. If left 369: # blank the following patterns are tested: 370: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 371: # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc 372: 373: FILE_PATTERNS = *.c *.h 374: 375: # The RECURSIVE tag can be used to turn specify whether or not subdirectories 376: # should be searched for input files as well. Possible values are YES and NO. 377: # If left blank NO is used. 378: 379: RECURSIVE = NO 380: 381: # The EXCLUDE tag can be used to specify files and/or directories that should 382: # excluded from the INPUT source files. This way you can easily exclude a 383: # subdirectory from a directory tree whose root is specified with the INPUT tag. 384: 385: EXCLUDE = 386: 387: # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 388: # that are symbolic links (a Unix filesystem feature) are excluded from the input. 389: 390: EXCLUDE_SYMLINKS = NO 391: 392: # If the value of the INPUT tag contains directories, you can use the 393: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 394: # certain files from those directories. 395: 396: EXCLUDE_PATTERNS = 397: 398: # The EXAMPLE_PATH tag can be used to specify one or more files or 399: # directories that contain example code fragments that are included (see 400: # the \include command). 401: 402: EXAMPLE_PATH = 403: 404: # If the value of the EXAMPLE_PATH tag contains directories, you can use the 405: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 406: # and *.h) to filter out the source-files in the directories. If left 407: # blank all files are included. 408: 409: EXAMPLE_PATTERNS = 410: 411: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 412: # searched for input files to be used with the \include or \dontinclude 413: # commands irrespective of the value of the RECURSIVE tag. 414: # Possible values are YES and NO. If left blank NO is used. 415: 416: EXAMPLE_RECURSIVE = NO 417: 418: # The IMAGE_PATH tag can be used to specify one or more files or 419: # directories that contain image that are included in the documentation (see 420: # the \image command). 421: 422: IMAGE_PATH = 423: 424: # The INPUT_FILTER tag can be used to specify a program that doxygen should 425: # invoke to filter for each input file. Doxygen will invoke the filter program 426: # by executing (via popen()) the command <filter> <input-file>, where <filter> 427: # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 428: # input file. Doxygen will then use the output that the filter program writes 429: # to standard output. 430: 431: INPUT_FILTER = 432: 433: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 434: # INPUT_FILTER) will be used to filter the input files when producing source 435: # files to browse (i.e. when SOURCE_BROWSER is set to YES). 436: 437: FILTER_SOURCE_FILES = NO 438: 439: #--------------------------------------------------------------------------- 440: # configuration options related to source browsing 441: #--------------------------------------------------------------------------- 442: 443: # If the SOURCE_BROWSER tag is set to YES then a list of source files will 444: # be generated. Documented entities will be cross-referenced with these sources. 445: 446: SOURCE_BROWSER = NO 447: 448: # Setting the INLINE_SOURCES tag to YES will include the body 449: # of functions and classes directly in the documentation. 450: 451: INLINE_SOURCES = NO 452: 453: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 454: # doxygen to hide any special comment blocks from generated source code 455: # fragments. Normal C and C++ comments will always remain visible. 456: 457: STRIP_CODE_COMMENTS = YES 458: 459: # If the REFERENCED_BY_RELATION tag is set to YES (the default) 460: # then for each documented function all documented 461: # functions referencing it will be listed. 462: 463: REFERENCED_BY_RELATION = YES 464: 465: # If the REFERENCES_RELATION tag is set to YES (the default) 466: # then for each documented function all documented entities 467: # called/used by that function will be listed. 468: 469: REFERENCES_RELATION = YES 470: 471: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 472: # will generate a verbatim copy of the header file for each class for 473: # which an include is specified. Set to NO to disable this. 474: 475: VERBATIM_HEADERS = YES 476: 477: #--------------------------------------------------------------------------- 478: # configuration options related to the alphabetical class index 479: #--------------------------------------------------------------------------- 480: 481: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 482: # of all compounds will be generated. Enable this if the project 483: # contains a lot of classes, structs, unions or interfaces. 484: 485: ALPHABETICAL_INDEX = NO 486: 487: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 488: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 489: # in which this list will be split (can be a number in the range [1..20]) 490: 491: COLS_IN_ALPHA_INDEX = 5 492: 493: # In case all classes in a project start with a common prefix, all 494: # classes will be put under the same header in the alphabetical index. 495: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 496: # should be ignored while generating the index headers. 497: 498: IGNORE_PREFIX = 499: 500: #--------------------------------------------------------------------------- 501: # configuration options related to the HTML output 502: #--------------------------------------------------------------------------- 503: 504: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 505: # generate HTML output. 506: 507: GENERATE_HTML = YES 508: 509: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 510: # If a relative path is entered the value of OUTPUT_DIRECTORY will be 511: # put in front of it. If left blank `html' will be used as the default path. 512: 513: HTML_OUTPUT = html 514: 515: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 516: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 517: # doxygen will generate files with .html extension. 518: 519: HTML_FILE_EXTENSION = .html 520: 521: # The HTML_HEADER tag can be used to specify a personal HTML header for 522: # each generated HTML page. If it is left blank doxygen will generate a 523: # standard header. 524: 525: HTML_HEADER = 526: 527: # The HTML_FOOTER tag can be used to specify a personal HTML footer for 528: # each generated HTML page. If it is left blank doxygen will generate a 529: # standard footer. 530: 531: HTML_FOOTER = 532: 533: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 534: # style sheet that is used by each HTML page. It can be used to 535: # fine-tune the look of the HTML output. If the tag is left blank doxygen 536: # will generate a default style sheet 537: 538: HTML_STYLESHEET = 539: 540: # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 541: # files or namespaces will be aligned in HTML using tables. If set to 542: # NO a bullet list will be used. 543: 544: HTML_ALIGN_MEMBERS = YES 545: 546: # If the GENERATE_HTMLHELP tag is set to YES, additional index files 547: # will be generated that can be used as input for tools like the 548: # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 549: # of the generated HTML documentation. 550: 551: GENERATE_HTMLHELP = NO 552: 553: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 554: # be used to specify the file name of the resulting .chm file. You 555: # can add a path in front of the file if the result should not be 556: # written to the html output dir. 557: 558: CHM_FILE = 559: 560: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 561: # be used to specify the location (absolute path including file name) of 562: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 563: # the HTML help compiler on the generated index.hhp. 564: 565: HHC_LOCATION = 566: 567: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 568: # controls if a separate .chi index file is generated (YES) or that 569: # it should be included in the master .chm file (NO). 570: 571: GENERATE_CHI = NO 572: 573: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 574: # controls whether a binary table of contents is generated (YES) or a 575: # normal table of contents (NO) in the .chm file. 576: 577: BINARY_TOC = NO 578: 579: # The TOC_EXPAND flag can be set to YES to add extra items for group members 580: # to the contents of the HTML help documentation and to the tree view. 581: 582: TOC_EXPAND = NO 583: 584: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 585: # top of each HTML page. The value NO (the default) enables the index and 586: # the value YES disables it. 587: 588: DISABLE_INDEX = NO 589: 590: # This tag can be used to set the number of enum values (range [1..20]) 591: # that doxygen will group on one line in the generated HTML documentation. 592: 593: ENUM_VALUES_PER_LINE = 4 594: 595: # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 596: # generated containing a tree-like index structure (just like the one that 597: # is generated for HTML Help). For this to work a browser that supports 598: # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 599: # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 600: # probably better off using the HTML help feature. 601: 602: GENERATE_TREEVIEW = NO 603: 604: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 605: # used to set the initial width (in pixels) of the frame in which the tree 606: # is shown. 607: 608: TREEVIEW_WIDTH = 250 609: 610: #--------------------------------------------------------------------------- 611: # configuration options related to the LaTeX output 612: #--------------------------------------------------------------------------- 613: 614: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 615: # generate Latex output. 616: 617: GENERATE_LATEX = YES 618: 619: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 620: # If a relative path is entered the value of OUTPUT_DIRECTORY will be 621: # put in front of it. If left blank `latex' will be used as the default path. 622: 623: LATEX_OUTPUT = latex 624: 625: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 626: # invoked. If left blank `latex' will be used as the default command name. 627: 628: LATEX_CMD_NAME = latex 629: 630: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 631: # generate index for LaTeX. If left blank `makeindex' will be used as the 632: # default command name. 633: 634: MAKEINDEX_CMD_NAME = makeindex 635: 636: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 637: # LaTeX documents. This may be useful for small projects and may help to 638: # save some trees in general. 639: 640: COMPACT_LATEX = NO 641: 642: # The PAPER_TYPE tag can be used to set the paper type that is used 643: # by the printer. Possible values are: a4, a4wide, letter, legal and 644: # executive. If left blank a4wide will be used. 645: 646: PAPER_TYPE = a4wide 647: 648: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 649: # packages that should be included in the LaTeX output. 650: 651: EXTRA_PACKAGES = 652: 653: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 654: # the generated latex document. The header should contain everything until 655: # the first chapter. If it is left blank doxygen will generate a 656: # standard header. Notice: only use this tag if you know what you are doing! 657: 658: LATEX_HEADER = 659: 660: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 661: # is prepared for conversion to pdf (using ps2pdf). The pdf file will 662: # contain links (just like the HTML output) instead of page references 663: # This makes the output suitable for online browsing using a pdf viewer. 664: 665: PDF_HYPERLINKS = NO 666: 667: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 668: # plain latex in the generated Makefile. Set this option to YES to get a 669: # higher quality PDF documentation. 670: 671: USE_PDFLATEX = NO 672: 673: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 674: # command to the generated LaTeX files. This will instruct LaTeX to keep 675: # running if errors occur, instead of asking the user for help. 676: # This option is also used when generating formulas in HTML. 677: 678: LATEX_BATCHMODE = NO 679: 680: # If LATEX_HIDE_INDICES is set to YES then doxygen will not 681: # include the index chapters (such as File Index, Compound Index, etc.) 682: # in the output. 683: 684: LATEX_HIDE_INDICES = NO 685: 686: #--------------------------------------------------------------------------- 687: # configuration options related to the RTF output 688: #--------------------------------------------------------------------------- 689: 690: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 691: # The RTF output is optimised for Word 97 and may not look very pretty with 692: # other RTF readers or editors. 693: 694: GENERATE_RTF = NO 695: 696: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 697: # If a relative path is entered the value of OUTPUT_DIRECTORY will be 698: # put in front of it. If left blank `rtf' will be used as the default path. 699: 700: RTF_OUTPUT = rtf 701: 702: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 703: # RTF documents. This may be useful for small projects and may help to 704: # save some trees in general. 705: 706: COMPACT_RTF = NO 707: 708: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 709: # will contain hyperlink fields. The RTF file will 710: # contain links (just like the HTML output) instead of page references. 711: # This makes the output suitable for online browsing using WORD or other 712: # programs which support those fields. 713: # Note: wordpad (write) and others do not support links. 714: 715: RTF_HYPERLINKS = NO 716: 717: # Load stylesheet definitions from file. Syntax is similar to doxygen's 718: # config file, i.e. a series of assigments. You only have to provide 719: # replacements, missing definitions are set to their default value. 720: 721: RTF_STYLESHEET_FILE = 722: 723: # Set optional variables used in the generation of an rtf document. 724: # Syntax is similar to doxygen's config file. 725: 726: RTF_EXTENSIONS_FILE = 727: 728: #--------------------------------------------------------------------------- 729: # configuration options related to the man page output 730: #--------------------------------------------------------------------------- 731: 732: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 733: # generate man pages 734: 735: GENERATE_MAN = NO 736: 737: # The MAN_OUTPUT tag is used to specify where the man pages will be put. 738: # If a relative path is entered the value of OUTPUT_DIRECTORY will be 739: # put in front of it. If left blank `man' will be used as the default path. 740: 741: MAN_OUTPUT = man 742: 743: # The MAN_EXTENSION tag determines the extension that is added to 744: # the generated man pages (default is the subroutine's section .3) 745: 746: MAN_EXTENSION = .3 747: 748: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 749: # then it will generate one additional man file for each entity 750: # documented in the real man page(s). These additional files 751: # only source the real man page, but without them the man command 752: # would be unable to find the correct page. The default is NO. 753: 754: MAN_LINKS = NO 755: 756: #--------------------------------------------------------------------------- 757: # configuration options related to the XML output 758: #--------------------------------------------------------------------------- 759: 760: # If the GENERATE_XML tag is set to YES Doxygen will 761: # generate an XML file that captures the structure of 762: # the code including all documentation. Note that this 763: # feature is still experimental and incomplete at the 764: # moment. 765: 766: GENERATE_XML = NO 767: 768: # The XML_OUTPUT tag is used to specify where the XML pages will be put. 769: # If a relative path is entered the value of OUTPUT_DIRECTORY will be 770: # put in front of it. If left blank `xml' will be used as the default path. 771: 772: XML_OUTPUT = xml 773: 774: # The XML_SCHEMA tag can be used to specify an XML schema, 775: # which can be used by a validating XML parser to check the 776: # syntax of the XML files. 777: 778: XML_SCHEMA = 779: 780: # The XML_DTD tag can be used to specify an XML DTD, 781: # which can be used by a validating XML parser to check the 782: # syntax of the XML files. 783: 784: XML_DTD = 785: 786: #--------------------------------------------------------------------------- 787: # configuration options for the AutoGen Definitions output 788: