Annotation of embedaddon/confuse/doc/Doxyfile.in, revision 1.1.1.2
1.1.1.2 ! misho 1: # Doxyfile 1.8.9.1
1.1 misho 2:
3: # This file describes the settings to be used by the documentation system
1.1.1.2 ! misho 4: # doxygen (www.doxygen.org) for a project.
1.1 misho 5: #
1.1.1.2 ! misho 6: # All text after a double hash (##) is considered a comment and is placed in
! 7: # front of the TAG it is preceding.
! 8: #
! 9: # All text after a single hash (#) is considered a comment and will be ignored.
1.1 misho 10: # The format is:
1.1.1.2 ! misho 11: # TAG = value [value, ...]
! 12: # For lists, items can also be appended using:
! 13: # TAG += value [value, ...]
! 14: # Values that contain spaces should be placed between quotes (\" \").
1.1 misho 15:
16: #---------------------------------------------------------------------------
17: # Project related configuration options
18: #---------------------------------------------------------------------------
19:
1.1.1.2 ! misho 20: # This tag specifies the encoding used for all characters in the config file
! 21: # that follow. The default is UTF-8 which is also the encoding used for all text
! 22: # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
! 23: # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
! 24: # for the list of possible encodings.
! 25: # The default value is: UTF-8.
1.1 misho 26:
27: DOXYFILE_ENCODING = UTF-8
28:
1.1.1.2 ! misho 29: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
! 30: # double-quotes, unless you are using Doxywizard) that should identify the
! 31: # project for which the documentation is generated. This name is used in the
! 32: # title of most generated pages and in a few other places.
! 33: # The default value is: My Project.
1.1 misho 34:
35: PROJECT_NAME = @PACKAGE@
36:
1.1.1.2 ! misho 37: # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
! 38: # could be handy for archiving the generated documentation or if some version
! 39: # control system is used.
1.1 misho 40:
41: PROJECT_NUMBER = @VERSION@
42:
1.1.1.2 ! misho 43: # Using the PROJECT_BRIEF tag one can provide an optional one line description
! 44: # for a project that appears at the top of each page and should give viewer a
! 45: # quick idea about the purpose of the project. Keep the description short.
! 46:
! 47: PROJECT_BRIEF =
! 48:
! 49: # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
! 50: # in the documentation. The maximum height of the logo should not exceed 55
! 51: # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
! 52: # the logo to the output directory.
! 53:
! 54: PROJECT_LOGO =
! 55:
! 56: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
! 57: # into which the generated documentation will be written. If a relative path is
! 58: # entered, it will be relative to the location where doxygen was started. If
! 59: # left blank the current directory will be used.
! 60:
! 61: OUTPUT_DIRECTORY =
! 62:
! 63: # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
! 64: # directories (in 2 levels) under the output directory of each output format and
! 65: # will distribute the generated files over these directories. Enabling this
! 66: # option can be useful when feeding doxygen a huge amount of source files, where
! 67: # putting all generated files in the same directory would otherwise causes
! 68: # performance problems for the file system.
! 69: # The default value is: NO.
1.1 misho 70:
71: CREATE_SUBDIRS = NO
72:
1.1.1.2 ! misho 73: # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
! 74: # characters to appear in the names of generated files. If set to NO, non-ASCII
! 75: # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
! 76: # U+3044.
! 77: # The default value is: NO.
! 78:
! 79: ALLOW_UNICODE_NAMES = NO
! 80:
! 81: # The OUTPUT_LANGUAGE tag is used to specify the language in which all
! 82: # documentation generated by doxygen is written. Doxygen will use this
! 83: # information to generate all constant output in the proper language.
! 84: # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
! 85: # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
! 86: # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
! 87: # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
! 88: # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
! 89: # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
! 90: # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
! 91: # Ukrainian and Vietnamese.
! 92: # The default value is: English.
1.1 misho 93:
94: OUTPUT_LANGUAGE = English
95:
1.1.1.2 ! misho 96: # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
! 97: # descriptions after the members that are listed in the file and class
! 98: # documentation (similar to Javadoc). Set to NO to disable this.
! 99: # The default value is: YES.
1.1 misho 100:
101: BRIEF_MEMBER_DESC = YES
102:
1.1.1.2 ! misho 103: # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
! 104: # description of a member or function before the detailed description
! 105: #
! 106: # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
1.1 misho 107: # brief descriptions will be completely suppressed.
1.1.1.2 ! misho 108: # The default value is: YES.
1.1 misho 109:
110: REPEAT_BRIEF = YES
111:
1.1.1.2 ! misho 112: # This tag implements a quasi-intelligent brief description abbreviator that is
! 113: # used to form the text in various listings. Each string in this list, if found
! 114: # as the leading text of the brief description, will be stripped from the text
! 115: # and the result, after processing the whole list, is used as the annotated
! 116: # text. Otherwise, the brief description is used as-is. If left blank, the
! 117: # following values are used ($name is automatically replaced with the name of
! 118: # the entity):The $name class, The $name widget, The $name file, is, provides,
! 119: # specifies, contains, represents, a, an and the.
1.1 misho 120:
1.1.1.2 ! misho 121: ABBREVIATE_BRIEF =
1.1 misho 122:
1.1.1.2 ! misho 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
1.1 misho 125: # description.
1.1.1.2 ! misho 126: # The default value is: NO.
1.1 misho 127:
128: ALWAYS_DETAILED_SEC = NO
129:
1.1.1.2 ! misho 130: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
! 131: # inherited members of a class in the documentation of that class as if those
! 132: # members were ordinary class members. Constructors, destructors and assignment
1.1 misho 133: # operators of the base classes will not be shown.
1.1.1.2 ! misho 134: # The default value is: NO.
1.1 misho 135:
136: INLINE_INHERITED_MEMB = YES
137:
1.1.1.2 ! misho 138: # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
! 139: # before files name in the file list and in the header files. If set to NO the
! 140: # shortest path that makes the file name unique will be used
! 141: # The default value is: YES.
1.1 misho 142:
143: FULL_PATH_NAMES = NO
144:
1.1.1.2 ! misho 145: # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
! 146: # Stripping is only done if one of the specified strings matches the left-hand
! 147: # part of the path. The tag can be used to show relative paths in the file list.
! 148: # If left blank the directory from which doxygen is run is used as the path to
! 149: # strip.
! 150: #
! 151: # Note that you can specify absolute paths here, but also relative paths, which
! 152: # will be relative from the directory where doxygen is started.
! 153: # This tag requires that the tag FULL_PATH_NAMES is set to YES.
! 154:
! 155: STRIP_FROM_PATH =
! 156:
! 157: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
! 158: # path mentioned in the documentation of a class, which tells the reader which
! 159: # header file to include in order to use a class. If left blank only the name of
! 160: # the header file containing the class definition is used. Otherwise one should
! 161: # specify the list of include paths that are normally passed to the compiler
! 162: # using the -I flag.
! 163:
! 164: STRIP_FROM_INC_PATH =
! 165:
! 166: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
! 167: # less readable) file names. This can be useful is your file systems doesn't
! 168: # support long names like on DOS, Mac, or CD-ROM.
! 169: # The default value is: NO.
1.1 misho 170:
171: SHORT_NAMES = NO
172:
1.1.1.2 ! misho 173: # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
! 174: # first line (until the first dot) of a Javadoc-style comment as the brief
! 175: # description. If set to NO, the Javadoc-style will behave just like regular Qt-
! 176: # style comments (thus requiring an explicit @brief command for a brief
! 177: # description.)
! 178: # The default value is: NO.
1.1 misho 179:
180: JAVADOC_AUTOBRIEF = YES
181:
1.1.1.2 ! misho 182: # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
! 183: # line (until the first dot) of a Qt-style comment as the brief description. If
! 184: # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
! 185: # requiring an explicit \brief command for a brief description.)
! 186: # The default value is: NO.
1.1 misho 187:
188: QT_AUTOBRIEF = NO
189:
1.1.1.2 ! misho 190: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
! 191: # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
! 192: # a brief description. This used to be the default behavior. The new default is
! 193: # to treat a multi-line C++ comment block as a detailed description. Set this
! 194: # tag to YES if you prefer the old behavior instead.
! 195: #
! 196: # Note that setting this tag to YES also means that rational rose comments are
! 197: # not recognized any more.
! 198: # The default value is: NO.
1.1 misho 199:
200: MULTILINE_CPP_IS_BRIEF = NO
201:
1.1.1.2 ! misho 202: # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
! 203: # documentation from any documented member that it re-implements.
! 204: # The default value is: YES.
1.1 misho 205:
206: INHERIT_DOCS = YES
207:
1.1.1.2 ! misho 208: # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
! 209: # page for each member. If set to NO, the documentation of a member will be part
! 210: # of the file/class/namespace that contains it.
! 211: # The default value is: NO.
1.1 misho 212:
213: SEPARATE_MEMBER_PAGES = NO
214:
1.1.1.2 ! misho 215: # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
! 216: # uses this value to replace tabs by spaces in code fragments.
! 217: # Minimum value: 1, maximum value: 16, default value: 4.
1.1 misho 218:
219: TAB_SIZE = 4
220:
1.1.1.2 ! misho 221: # This tag can be used to specify a number of aliases that act as commands in
! 222: # the documentation. An alias has the form:
! 223: # name=value
! 224: # For example adding
! 225: # "sideeffect=@par Side Effects:\n"
! 226: # will allow you to put the command \sideeffect (or @sideeffect) in the
! 227: # documentation, which will result in a user-defined paragraph with heading
! 228: # "Side Effects:". You can put \n's in the value part of an alias to insert
! 229: # newlines.
! 230:
! 231: ALIASES =
! 232:
! 233: # This tag can be used to specify a number of word-keyword mappings (TCL only).
! 234: # A mapping has the form "name=value". For example adding "class=itcl::class"
! 235: # will allow you to use the command class in the itcl::class meaning.
! 236:
! 237: TCL_SUBST =
! 238:
! 239: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
! 240: # only. Doxygen will then generate output that is more tailored for C. For
! 241: # instance, some of the names that are used will be different. The list of all
! 242: # members will be omitted, etc.
! 243: # The default value is: NO.
1.1 misho 244:
245: OPTIMIZE_OUTPUT_FOR_C = YES
246:
1.1.1.2 ! misho 247: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
! 248: # Python sources only. Doxygen will then generate output that is more tailored
! 249: # for that language. For instance, namespaces will be presented as packages,
! 250: # qualified scopes will look different, etc.
! 251: # The default value is: NO.
1.1 misho 252:
253: OPTIMIZE_OUTPUT_JAVA = NO
254:
1.1.1.2 ! misho 255: # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
! 256: # sources. Doxygen will then generate output that is tailored for Fortran.
! 257: # The default value is: NO.
1.1 misho 258:
259: OPTIMIZE_FOR_FORTRAN = NO
260:
1.1.1.2 ! misho 261: # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
! 262: # sources. Doxygen will then generate output that is tailored for VHDL.
! 263: # The default value is: NO.
1.1 misho 264:
265: OPTIMIZE_OUTPUT_VHDL = NO
266:
1.1.1.2 ! misho 267: # Doxygen selects the parser to use depending on the extension of the files it
! 268: # parses. With this tag you can assign which parser to use for a given
! 269: # extension. Doxygen has a built-in mapping, but you can override or extend it
! 270: # using this tag. The format is ext=language, where ext is a file extension, and
! 271: # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
! 272: # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
! 273: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
! 274: # Fortran. In the later case the parser tries to guess whether the code is fixed
! 275: # or free formatted code, this is the default for Fortran type files), VHDL. For
! 276: # instance to make doxygen treat .inc files as Fortran files (default is PHP),
! 277: # and .f files as C (default is Fortran), use: inc=Fortran f=C.
! 278: #
! 279: # Note: For files without extension you can use no_extension as a placeholder.
! 280: #
! 281: # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
! 282: # the files are not read by doxygen.
! 283:
! 284: EXTENSION_MAPPING =
! 285:
! 286: # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
! 287: # according to the Markdown format, which allows for more readable
! 288: # documentation. See http://daringfireball.net/projects/markdown/ for details.
! 289: # The output of markdown processing is further processed by doxygen, so you can
! 290: # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
! 291: # case of backward compatibilities issues.
! 292: # The default value is: YES.
! 293:
! 294: MARKDOWN_SUPPORT = NO
! 295:
! 296: # When enabled doxygen tries to link words that correspond to documented
! 297: # classes, or namespaces to their corresponding documentation. Such a link can
! 298: # be prevented in individual cases by putting a % sign in front of the word or
! 299: # globally by setting AUTOLINK_SUPPORT to NO.
! 300: # The default value is: YES.
! 301:
! 302: AUTOLINK_SUPPORT = YES
! 303:
! 304: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
! 305: # to include (a tag file for) the STL sources as input, then you should set this
! 306: # tag to YES in order to let doxygen match functions declarations and
! 307: # definitions whose arguments contain STL classes (e.g. func(std::string);
! 308: # versus func(std::string) {}). This also make the inheritance and collaboration
1.1 misho 309: # diagrams that involve STL classes more complete and accurate.
1.1.1.2 ! misho 310: # The default value is: NO.
1.1 misho 311:
312: BUILTIN_STL_SUPPORT = NO
313:
1.1.1.2 ! misho 314: # If you use Microsoft's C++/CLI language, you should set this option to YES to
1.1 misho 315: # enable parsing support.
1.1.1.2 ! misho 316: # The default value is: NO.
1.1 misho 317:
318: CPP_CLI_SUPPORT = NO
319:
1.1.1.2 ! misho 320: # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
! 321: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
! 322: # will parse them like normal C++ but will assume all classes use public instead
! 323: # of private inheritance when no explicit protection keyword is present.
! 324: # The default value is: NO.
1.1 misho 325:
326: SIP_SUPPORT = NO
327:
1.1.1.2 ! misho 328: # For Microsoft's IDL there are propget and propput attributes to indicate
! 329: # getter and setter methods for a property. Setting this option to YES will make
! 330: # doxygen to replace the get and set methods by a property in the documentation.
! 331: # This will only work if the methods are indeed getting or setting a simple
! 332: # type. If this is not the case, or you want to show the methods anyway, you
! 333: # should set this option to NO.
! 334: # The default value is: YES.
1.1 misho 335:
336: IDL_PROPERTY_SUPPORT = YES
337:
1.1.1.2 ! misho 338: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
! 339: # tag is set to YES then doxygen will reuse the documentation of the first
! 340: # member in the group (if any) for the other members of the group. By default
1.1 misho 341: # all members of a group must be documented explicitly.
1.1.1.2 ! misho 342: # The default value is: NO.
1.1 misho 343:
344: DISTRIBUTE_GROUP_DOC = NO
345:
1.1.1.2 ! misho 346: # Set the SUBGROUPING tag to YES to allow class member groups of the same type
! 347: # (for instance a group of public functions) to be put as a subgroup of that
! 348: # type (e.g. under the Public Functions section). Set it to NO to prevent
! 349: # subgrouping. Alternatively, this can be done per class using the
! 350: # \nosubgrouping command.
! 351: # The default value is: YES.
1.1 misho 352:
353: SUBGROUPING = YES
354:
1.1.1.2 ! misho 355: # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
! 356: # are shown inside the group in which they are included (e.g. using \ingroup)
! 357: # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
! 358: # and RTF).
! 359: #
! 360: # Note that this feature does not work in combination with
! 361: # SEPARATE_MEMBER_PAGES.
! 362: # The default value is: NO.
! 363:
! 364: INLINE_GROUPED_CLASSES = NO
! 365:
! 366: # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
! 367: # with only public data fields or simple typedef fields will be shown inline in
! 368: # the documentation of the scope in which they are defined (i.e. file,
! 369: # namespace, or group documentation), provided this scope is documented. If set
! 370: # to NO, structs, classes, and unions are shown on a separate page (for HTML and
! 371: # Man pages) or section (for LaTeX and RTF).
! 372: # The default value is: NO.
! 373:
! 374: INLINE_SIMPLE_STRUCTS = NO
! 375:
! 376: # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
! 377: # enum is documented as struct, union, or enum with the name of the typedef. So
! 378: # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
! 379: # with name TypeT. When disabled the typedef will appear as a member of a file,
! 380: # namespace, or class. And the struct will be named TypeS. This can typically be
! 381: # useful for C code in case the coding convention dictates that all compound
1.1 misho 382: # types are typedef'ed and only the typedef is referenced, never the tag name.
1.1.1.2 ! misho 383: # The default value is: NO.
1.1 misho 384:
385: TYPEDEF_HIDES_STRUCT = NO
386:
1.1.1.2 ! misho 387: # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
! 388: # cache is used to resolve symbols given their name and scope. Since this can be
! 389: # an expensive process and often the same symbol appears multiple times in the
! 390: # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
! 391: # doxygen will become slower. If the cache is too large, memory is wasted. The
! 392: # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
! 393: # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
! 394: # symbols. At the end of a run doxygen will report the cache usage and suggest
! 395: # the optimal cache size from a speed point of view.
! 396: # Minimum value: 0, maximum value: 9, default value: 0.
1.1 misho 397:
1.1.1.2 ! misho 398: LOOKUP_CACHE_SIZE = 0
1.1 misho 399:
400: #---------------------------------------------------------------------------
401: # Build related configuration options
402: #---------------------------------------------------------------------------
403:
1.1.1.2 ! misho 404: # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
! 405: # documentation are documented, even if no documentation was available. Private
! 406: # class members and static file members will be hidden unless the
! 407: # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
! 408: # Note: This will also disable the warnings about undocumented members that are
! 409: # normally produced when WARNINGS is set to YES.
! 410: # The default value is: NO.
1.1 misho 411:
412: EXTRACT_ALL = NO
413:
1.1.1.2 ! misho 414: # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
! 415: # be included in the documentation.
! 416: # The default value is: NO.
1.1 misho 417:
418: EXTRACT_PRIVATE = NO
419:
1.1.1.2 ! misho 420: # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
! 421: # scope will be included in the documentation.
! 422: # The default value is: NO.
! 423:
! 424: EXTRACT_PACKAGE = NO
! 425:
! 426: # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
! 427: # included in the documentation.
! 428: # The default value is: NO.
1.1 misho 429:
430: EXTRACT_STATIC = NO
431:
1.1.1.2 ! misho 432: # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
! 433: # locally in source files will be included in the documentation. If set to NO,
! 434: # only classes defined in header files are included. Does not have any effect
! 435: # for Java sources.
! 436: # The default value is: YES.
1.1 misho 437:
438: EXTRACT_LOCAL_CLASSES = NO
439:
1.1.1.2 ! misho 440: # This flag is only useful for Objective-C code. If set to YES, local methods,
! 441: # which are defined in the implementation section but not in the interface are
! 442: # included in the documentation. If set to NO, only methods in the interface are
! 443: # included.
! 444: # The default value is: NO.
1.1 misho 445:
446: EXTRACT_LOCAL_METHODS = NO
447:
1.1.1.2 ! misho 448: # If this flag is set to YES, the members of anonymous namespaces will be
! 449: # extracted and appear in the documentation as a namespace called
! 450: # 'anonymous_namespace{file}', where file will be replaced with the base name of
! 451: # the file that contains the anonymous namespace. By default anonymous namespace
! 452: # are hidden.
! 453: # The default value is: NO.
1.1 misho 454:
455: EXTRACT_ANON_NSPACES = NO
456:
1.1.1.2 ! misho 457: # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
! 458: # undocumented members inside documented classes or files. If set to NO these
! 459: # members will be included in the various overviews, but no documentation
! 460: # section is generated. This option has no effect if EXTRACT_ALL is enabled.
! 461: # The default value is: NO.
1.1 misho 462:
463: HIDE_UNDOC_MEMBERS = YES
464:
1.1.1.2 ! misho 465: # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
! 466: # undocumented classes that are normally visible in the class hierarchy. If set
! 467: # to NO, these classes will be included in the various overviews. This option
! 468: # has no effect if EXTRACT_ALL is enabled.
! 469: # The default value is: NO.
1.1 misho 470:
471: HIDE_UNDOC_CLASSES = YES
472:
1.1.1.2 ! misho 473: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
! 474: # (class|struct|union) declarations. If set to NO, these declarations will be
! 475: # included in the documentation.
! 476: # The default value is: NO.
1.1 misho 477:
478: HIDE_FRIEND_COMPOUNDS = NO
479:
1.1.1.2 ! misho 480: # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
! 481: # documentation blocks found inside the body of a function. If set to NO, these
! 482: # blocks will be appended to the function's detailed documentation block.
! 483: # The default value is: NO.
1.1 misho 484:
485: HIDE_IN_BODY_DOCS = NO
486:
1.1.1.2 ! misho 487: # The INTERNAL_DOCS tag determines if documentation that is typed after a
! 488: # \internal command is included. If the tag is set to NO then the documentation
! 489: # will be excluded. Set it to YES to include the internal documentation.
! 490: # The default value is: NO.
1.1 misho 491:
492: INTERNAL_DOCS = NO
493:
1.1.1.2 ! misho 494: # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
! 495: # names in lower-case letters. If set to YES, upper-case letters are also
! 496: # allowed. This is useful if you have classes or files whose names only differ
! 497: # in case and if your file system supports case sensitive file names. Windows
1.1 misho 498: # and Mac users are advised to set this option to NO.
1.1.1.2 ! misho 499: # The default value is: system dependent.
1.1 misho 500:
501: CASE_SENSE_NAMES = YES
502:
1.1.1.2 ! misho 503: # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
! 504: # their full class and namespace scopes in the documentation. If set to YES, the
! 505: # scope will be hidden.
! 506: # The default value is: NO.
1.1 misho 507:
508: HIDE_SCOPE_NAMES = NO
509:
1.1.1.2 ! misho 510: # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
! 511: # append additional text to a page's title, such as Class Reference. If set to
! 512: # YES the compound reference will be hidden.
! 513: # The default value is: NO.
! 514:
! 515: HIDE_COMPOUND_REFERENCE= NO
! 516:
! 517: # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
! 518: # the files that are included by a file in the documentation of that file.
! 519: # The default value is: YES.
1.1 misho 520:
521: SHOW_INCLUDE_FILES = YES
522:
1.1.1.2 ! misho 523: # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
! 524: # grouped member an include statement to the documentation, telling the reader
! 525: # which file to include in order to use the member.
! 526: # The default value is: NO.
! 527:
! 528: SHOW_GROUPED_MEMB_INC = NO
! 529:
! 530: # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
! 531: # files with double quotes in the documentation rather than with sharp brackets.
! 532: # The default value is: NO.
! 533:
! 534: FORCE_LOCAL_INCLUDES = NO
! 535:
! 536: # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
! 537: # documentation for inline members.
! 538: # The default value is: YES.
1.1 misho 539:
540: INLINE_INFO = YES
541:
1.1.1.2 ! misho 542: # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
! 543: # (detailed) documentation of file and class members alphabetically by member
! 544: # name. If set to NO, the members will appear in declaration order.
! 545: # The default value is: YES.
1.1 misho 546:
547: SORT_MEMBER_DOCS = YES
548:
1.1.1.2 ! misho 549: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
! 550: # descriptions of file, namespace and class members alphabetically by member
! 551: # name. If set to NO, the members will appear in declaration order. Note that
! 552: # this will also influence the order of the classes in the class list.
! 553: # The default value is: NO.
1.1 misho 554:
555: SORT_BRIEF_DOCS = NO
556:
1.1.1.2 ! misho 557: # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
! 558: # (brief and detailed) documentation of class members so that constructors and
! 559: # destructors are listed first. If set to NO the constructors will appear in the
! 560: # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
! 561: # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
! 562: # member documentation.
! 563: # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
! 564: # detailed member documentation.
! 565: # The default value is: NO.
! 566:
! 567: SORT_MEMBERS_CTORS_1ST = NO
! 568:
! 569: # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
! 570: # of group names into alphabetical order. If set to NO the group names will
! 571: # appear in their defined order.
! 572: # The default value is: NO.
1.1 misho 573:
574: SORT_GROUP_NAMES = NO
575:
1.1.1.2 ! misho 576: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
! 577: # fully-qualified names, including namespaces. If set to NO, the class list will
! 578: # be sorted only by class name, not including the namespace part.
! 579: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
! 580: # Note: This option applies only to the class list, not to the alphabetical
! 581: # list.
! 582: # The default value is: NO.
1.1 misho 583:
584: SORT_BY_SCOPE_NAME = NO
585:
1.1.1.2 ! misho 586: # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
! 587: # type resolution of all parameters of a function it will reject a match between
! 588: # the prototype and the implementation of a member function even if there is
! 589: # only one candidate or it is obvious which candidate to choose by doing a
! 590: # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
! 591: # accept a match between prototype and implementation in such cases.
! 592: # The default value is: NO.
! 593:
! 594: STRICT_PROTO_MATCHING = NO
! 595:
! 596: # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
! 597: # list. This list is created by putting \todo commands in the documentation.
! 598: # The default value is: YES.
1.1 misho 599:
600: GENERATE_TODOLIST = YES
601:
1.1.1.2 ! misho 602: # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
! 603: # list. This list is created by putting \test commands in the documentation.
! 604: # The default value is: YES.
1.1 misho 605:
606: GENERATE_TESTLIST = YES
607:
1.1.1.2 ! misho 608: # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
! 609: # list. This list is created by putting \bug commands in the documentation.
! 610: # The default value is: YES.
1.1 misho 611:
612: GENERATE_BUGLIST = YES
613:
1.1.1.2 ! misho 614: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
! 615: # the deprecated list. This list is created by putting \deprecated commands in
! 616: # the documentation.
! 617: # The default value is: YES.
1.1 misho 618:
619: GENERATE_DEPRECATEDLIST= YES
620:
1.1.1.2 ! misho 621: # The ENABLED_SECTIONS tag can be used to enable conditional documentation
! 622: # sections, marked by \if <section_label> ... \endif and \cond <section_label>
! 623: # ... \endcond blocks.
! 624:
! 625: ENABLED_SECTIONS =
! 626:
! 627: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
! 628: # initial value of a variable or macro / define can have for it to appear in the
! 629: # documentation. If the initializer consists of more lines than specified here
! 630: # it will be hidden. Use a value of 0 to hide initializers completely. The
! 631: # appearance of the value of individual variables and macros / defines can be
! 632: # controlled using \showinitializer or \hideinitializer command in the
! 633: # documentation regardless of this setting.
! 634: # Minimum value: 0, maximum value: 10000, default value: 30.
1.1 misho 635:
636: MAX_INITIALIZER_LINES = 30
637:
1.1.1.2 ! misho 638: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
! 639: # the bottom of the documentation of classes and structs. If set to YES, the
1.1 misho 640: # list will mention the files that were used to generate the documentation.
1.1.1.2 ! misho 641: # The default value is: YES.
1.1 misho 642:
643: SHOW_USED_FILES = NO
644:
1.1.1.2 ! misho 645: # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
! 646: # will remove the Files entry from the Quick Index and from the Folder Tree View
! 647: # (if specified).
! 648: # The default value is: YES.
1.1 misho 649:
650: SHOW_FILES = YES
651:
1.1.1.2 ! misho 652: # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
! 653: # page. This will remove the Namespaces entry from the Quick Index and from the
! 654: # Folder Tree View (if specified).
! 655: # The default value is: YES.
1.1 misho 656:
657: SHOW_NAMESPACES = NO
658:
1.1.1.2 ! misho 659: # The FILE_VERSION_FILTER tag can be used to specify a program or script that
! 660: # doxygen should invoke to get the current version for each file (typically from
! 661: # the version control system). Doxygen will invoke the program by executing (via
! 662: # popen()) the command command input-file, where command is the value of the
! 663: # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
! 664: # by doxygen. Whatever the program writes to standard output is used as the file
! 665: # version. For an example see the documentation.
! 666:
! 667: FILE_VERSION_FILTER =
! 668:
! 669: # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
! 670: # by doxygen. The layout file controls the global structure of the generated
! 671: # output files in an output format independent way. To create the layout file
! 672: # that represents doxygen's defaults, run doxygen with the -l option. You can
! 673: # optionally specify a file name after the option, if omitted DoxygenLayout.xml
! 674: # will be used as the name of the layout file.
! 675: #
! 676: # Note that if you run doxygen from a directory containing a file called
! 677: # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
! 678: # tag is left empty.
1.1 misho 679:
1.1.1.2 ! misho 680: LAYOUT_FILE =
1.1 misho 681:
1.1.1.2 ! misho 682: # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
! 683: # the reference definitions. This must be a list of .bib files. The .bib
! 684: # extension is automatically appended if omitted. This requires the bibtex tool
! 685: # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
! 686: # For LaTeX the style of the bibliography can be controlled using
! 687: # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
! 688: # search path. See also \cite for info how to create references.
1.1 misho 689:
1.1.1.2 ! misho 690: CITE_BIB_FILES =
1.1 misho 691:
692: #---------------------------------------------------------------------------
1.1.1.2 ! misho 693: # Configuration options related to warning and progress messages
1.1 misho 694: #---------------------------------------------------------------------------
695:
1.1.1.2 ! misho 696: # The QUIET tag can be used to turn on/off the messages that are generated to
! 697: # standard output by doxygen. If QUIET is set to YES this implies that the
! 698: # messages are off.
! 699: # The default value is: NO.
1.1 misho 700:
701: QUIET = YES
702:
1.1.1.2 ! misho 703: # The WARNINGS tag can be used to turn on/off the warning messages that are
! 704: # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
! 705: # this implies that the warnings are on.
! 706: #
! 707: # Tip: Turn warnings on while writing the documentation.
! 708: # The default value is: YES.
1.1 misho 709:
710: WARNINGS = YES
711:
1.1.1.2 ! misho 712: # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
! 713: # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
! 714: # will automatically be disabled.
! 715: # The default value is: YES.
1.1 misho 716:
717: WARN_IF_UNDOCUMENTED = YES
718:
1.1.1.2 ! misho 719: # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
! 720: # potential errors in the documentation, such as not documenting some parameters
! 721: # in a documented function, or documenting parameters that don't exist or using
! 722: # markup commands wrongly.
! 723: # The default value is: YES.
1.1 misho 724:
725: WARN_IF_DOC_ERROR = YES
726:
1.1.1.2 ! misho 727: # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
! 728: # are documented, but have no documentation for their parameters or return
! 729: # value. If set to NO, doxygen will only warn about wrong or incomplete
! 730: # parameter documentation, but not about the absence of documentation.
! 731: # The default value is: NO.
1.1 misho 732:
733: WARN_NO_PARAMDOC = NO
734:
1.1.1.2 ! misho 735: # The WARN_FORMAT tag determines the format of the warning messages that doxygen
! 736: # can produce. The string should contain the $file, $line, and $text tags, which
! 737: # will be replaced by the file and line number from which the warning originated
! 738: # and the warning text. Optionally the format may contain $version, which will
! 739: # be replaced by the version of the file (if it could be obtained via
! 740: # FILE_VERSION_FILTER)
! 741: # The default value is: $file:$line: $text.
1.1 misho 742:
743: WARN_FORMAT = "$file:$line: $text"
744:
1.1.1.2 ! misho 745: # The WARN_LOGFILE tag can be used to specify a file to which warning and error
! 746: # messages should be written. If left blank the output is written to standard
! 747: # error (stderr).
1.1 misho 748:
1.1.1.2 ! misho 749: WARN_LOGFILE =
1.1 misho 750:
751: #---------------------------------------------------------------------------
1.1.1.2 ! misho 752: # Configuration options related to the input files
1.1 misho 753: #---------------------------------------------------------------------------
754:
1.1.1.2 ! misho 755: # The INPUT tag is used to specify the files and/or directories that contain
! 756: # documented source files. You may enter file names like myfile.cpp or
! 757: # directories like /usr/src/myproject. Separate the files or directories with
! 758: # spaces.
! 759: # Note: If this tag is empty the current directory is searched.
1.1 misho 760:
761: INPUT = @top_srcdir@/src/confuse.c \
762: @top_srcdir@/src/confuse.h
763:
1.1.1.2 ! misho 764: # This tag can be used to specify the character encoding of the source files
! 765: # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
! 766: # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
! 767: # documentation (see: http://www.gnu.org/software/libiconv) for the list of
! 768: # possible encodings.
! 769: # The default value is: UTF-8.
1.1 misho 770:
771: INPUT_ENCODING = UTF-8
772:
1.1.1.2 ! misho 773: # If the value of the INPUT tag contains directories, you can use the
! 774: # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
! 775: # *.h) to filter out the source-files in the directories. If left blank the
! 776: # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
! 777: # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
! 778: # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
! 779: # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
! 780: # *.qsf, *.as and *.js.
! 781:
! 782: FILE_PATTERNS =
! 783:
! 784: # The RECURSIVE tag can be used to specify whether or not subdirectories should
! 785: # be searched for input files as well.
! 786: # The default value is: NO.
1.1 misho 787:
788: RECURSIVE = NO
789:
1.1.1.2 ! misho 790: # The EXCLUDE tag can be used to specify files and/or directories that should be
! 791: # excluded from the INPUT source files. This way you can easily exclude a
1.1 misho 792: # subdirectory from a directory tree whose root is specified with the INPUT tag.
1.1.1.2 ! misho 793: #
! 794: # Note that relative paths are relative to the directory from which doxygen is
! 795: # run.
1.1 misho 796:
1.1.1.2 ! misho 797: EXCLUDE =
1.1 misho 798:
1.1.1.2 ! misho 799: # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
! 800: # directories that are symbolic links (a Unix file system feature) are excluded
1.1 misho 801: # from the input.
1.1.1.2 ! misho 802: # The default value is: NO.
1.1 misho 803:
804: EXCLUDE_SYMLINKS = NO
805:
1.1.1.2 ! misho 806: # If the value of the INPUT tag contains directories, you can use the
! 807: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
! 808: # certain files from those directories.
! 809: #
! 810: # Note that the wildcards are matched against the file with absolute path, so to
! 811: # exclude all test directories for example use the pattern */test/*
! 812:
! 813: EXCLUDE_PATTERNS =
! 814:
! 815: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
! 816: # (namespaces, classes, functions, etc.) that should be excluded from the
! 817: # output. The symbol name can be a fully qualified name, a word, or if the
! 818: # wildcard * is used, a substring. Examples: ANamespace, AClass,
1.1 misho 819: # AClass::ANamespace, ANamespace::*Test
1.1.1.2 ! misho 820: #
! 821: # Note that the wildcards are matched against the file with absolute path, so to
! 822: # exclude all test directories use the pattern */test/*
1.1 misho 823:
1.1.1.2 ! misho 824: EXCLUDE_SYMBOLS =
1.1 misho 825:
1.1.1.2 ! misho 826: # The EXAMPLE_PATH tag can be used to specify one or more files or directories
! 827: # that contain example code fragments that are included (see the \include
! 828: # command).
1.1 misho 829:
830: EXAMPLE_PATH = @top_srcdir@/examples
831:
1.1.1.2 ! misho 832: # If the value of the EXAMPLE_PATH tag contains directories, you can use the
! 833: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
! 834: # *.h) to filter out the source-files in the directories. If left blank all
! 835: # files are included.
! 836:
1.1 misho 837: EXAMPLE_PATTERNS = *.c
838:
1.1.1.2 ! misho 839: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
! 840: # searched for input files to be used with the \include or \dontinclude commands
! 841: # irrespective of the value of the RECURSIVE tag.
! 842: # The default value is: NO.
1.1 misho 843:
844: EXAMPLE_RECURSIVE = NO
845:
1.1.1.2 ! misho 846: # The IMAGE_PATH tag can be used to specify one or more files or directories
! 847: # that contain images that are to be included in the documentation (see the
! 848: # \image command).
! 849:
! 850: IMAGE_PATH =
! 851:
! 852: # The INPUT_FILTER tag can be used to specify a program that doxygen should
! 853: # invoke to filter for each input file. Doxygen will invoke the filter program
! 854: # by executing (via popen()) the command:
! 855: #
! 856: # <filter> <input-file>
! 857: #
! 858: # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
! 859: # name of an input file. Doxygen will then use the output that the filter
! 860: # program writes to standard output. If FILTER_PATTERNS is specified, this tag
! 861: # will be ignored.
! 862: #
! 863: # Note that the filter must not add or remove lines; it is applied before the
! 864: # code is scanned, but not when the output code is generated. If lines are added
! 865: # or removed, the anchors will not be placed correctly.
! 866:
! 867: INPUT_FILTER =
! 868:
! 869: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
! 870: # basis. Doxygen will compare the file name with each pattern and apply the
! 871: # filter if there is a match. The filters are a list of the form: pattern=filter
! 872: # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
! 873: # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
! 874: # patterns match the file name, INPUT_FILTER is applied.
! 875:
! 876: FILTER_PATTERNS =
! 877:
! 878: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
! 879: # INPUT_FILTER) will also be used to filter the input files that are used for
! 880: # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
! 881: # The default value is: NO.
1.1 misho 882:
883: FILTER_SOURCE_FILES = NO
884:
1.1.1.2 ! misho 885: # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
! 886: # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
! 887: # it is also possible to disable source filtering for a specific pattern using
! 888: # *.ext= (so without naming a filter).
! 889: # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
! 890:
! 891: FILTER_SOURCE_PATTERNS =
! 892:
! 893: # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
! 894: # is part of the input, its contents will be placed on the main page
! 895: # (index.html). This can be useful if you have a project on for instance GitHub
! 896: # and want to reuse the introduction page also for the doxygen output.
! 897:
! 898: USE_MDFILE_AS_MAINPAGE =
! 899:
1.1 misho 900: #---------------------------------------------------------------------------
1.1.1.2 ! misho 901: # Configuration options related to source browsing
1.1 misho 902: #---------------------------------------------------------------------------
903:
1.1.1.2 ! misho 904: # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
! 905: # generated. Documented entities will be cross-referenced with these sources.
! 906: #
! 907: # Note: To get rid of all source code in the generated output, make sure that
! 908: # also VERBATIM_HEADERS is set to NO.
! 909: # The default value is: NO.
1.1 misho 910:
911: SOURCE_BROWSER = NO
912:
1.1.1.2 ! misho 913: # Setting the INLINE_SOURCES tag to YES will include the body of functions,
! 914: # classes and enums directly into the documentation.
! 915: # The default value is: NO.
1.1 misho 916:
917: INLINE_SOURCES = NO
918:
1.1.1.2 ! misho 919: # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
! 920: # special comment blocks from generated source code fragments. Normal C, C++ and
! 921: # Fortran comments will always remain visible.
! 922: # The default value is: YES.
1.1 misho 923:
924: STRIP_CODE_COMMENTS = YES
925:
1.1.1.2 ! misho 926: # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
! 927: # function all documented functions referencing it will be listed.
! 928: # The default value is: NO.
1.1 misho 929:
930: REFERENCED_BY_RELATION = YES
931:
1.1.1.2 ! misho 932: # If the REFERENCES_RELATION tag is set to YES then for each documented function
! 933: # all documented entities called/used by that function will be listed.
! 934: # The default value is: NO.
1.1 misho 935:
936: REFERENCES_RELATION = YES
937:
1.1.1.2 ! misho 938: # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
! 939: # to YES then the hyperlinks from functions in REFERENCES_RELATION and
! 940: # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
! 941: # link to the documentation.
! 942: # The default value is: YES.
1.1 misho 943:
944: REFERENCES_LINK_SOURCE = YES
945:
1.1.1.2 ! misho 946: # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
! 947: # source code will show a tooltip with additional information such as prototype,
! 948: # brief description and links to the definition and documentation. Since this
! 949: # will make the HTML file larger and loading of large files a bit slower, you
! 950: # can opt to disable this feature.
! 951: # The default value is: YES.
! 952: # This tag requires that the tag SOURCE_BROWSER is set to YES.
! 953:
! 954: SOURCE_TOOLTIPS = YES
! 955:
! 956: # If the USE_HTAGS tag is set to YES then the references to source code will
! 957: # point to the HTML generated by the htags(1) tool instead of doxygen built-in
! 958: # source browser. The htags tool is part of GNU's global source tagging system
! 959: # (see http://www.gnu.org/software/global/global.html). You will need version
! 960: # 4.8.6 or higher.
! 961: #
! 962: # To use it do the following:
! 963: # - Install the latest version of global
! 964: # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
! 965: # - Make sure the INPUT points to the root of the source tree
! 966: # - Run doxygen as normal
! 967: #
! 968: # Doxygen will invoke htags (and that will in turn invoke gtags), so these
! 969: # tools must be available from the command line (i.e. in the search path).
! 970: #
! 971: # The result: instead of the source browser generated by doxygen, the links to
! 972: # source code will now point to the output of htags.
! 973: # The default value is: NO.
! 974: # This tag requires that the tag SOURCE_BROWSER is set to YES.
1.1 misho 975:
976: USE_HTAGS = NO
977:
1.1.1.2 ! misho 978: # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
! 979: # verbatim copy of the header file for each class for which an include is
! 980: # specified. Set to NO to disable this.
! 981: # See also: Section \class.
! 982: # The default value is: YES.
1.1 misho 983:
984: VERBATIM_HEADERS = YES
985:
1.1.1.2 ! misho 986: # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
! 987: # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
! 988: # cost of reduced performance. This can be particularly helpful with template
! 989: # rich C++ code for which doxygen's built-in parser lacks the necessary type
! 990: # information.
! 991: # Note: The availability of this option depends on whether or not doxygen was
! 992: # compiled with the --with-libclang option.
! 993: # The default value is: NO.
! 994:
! 995: CLANG_ASSISTED_PARSING = NO
! 996:
! 997: # If clang assisted parsing is enabled you can provide the compiler with command
! 998: # line options that you would normally use when invoking the compiler. Note that
! 999: # the include paths will already be set by doxygen for the files and directories
! 1000: # specified with INPUT and INCLUDE_PATH.
! 1001: # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
! 1002:
! 1003: CLANG_OPTIONS =
! 1004:
1.1 misho 1005: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1006: # Configuration options related to the alphabetical class index
1.1 misho 1007: #---------------------------------------------------------------------------
1008:
1.1.1.2 ! misho 1009: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
! 1010: # compounds will be generated. Enable this if the project contains a lot of
! 1011: # classes, structs, unions or interfaces.
! 1012: # The default value is: YES.
1.1 misho 1013:
1014: ALPHABETICAL_INDEX = NO
1015:
1.1.1.2 ! misho 1016: # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
! 1017: # which the alphabetical index list will be split.
! 1018: # Minimum value: 1, maximum value: 20, default value: 5.
! 1019: # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1.1 misho 1020:
1021: COLS_IN_ALPHA_INDEX = 5
1022:
1.1.1.2 ! misho 1023: # In case all classes in a project start with a common prefix, all classes will
! 1024: # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
! 1025: # can be used to specify a prefix (or a list of prefixes) that should be ignored
! 1026: # while generating the index headers.
! 1027: # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1.1 misho 1028:
1.1.1.2 ! misho 1029: IGNORE_PREFIX =
1.1 misho 1030:
1031: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1032: # Configuration options related to the HTML output
1.1 misho 1033: #---------------------------------------------------------------------------
1034:
1.1.1.2 ! misho 1035: # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
! 1036: # The default value is: YES.
1.1 misho 1037:
1038: GENERATE_HTML = YES
1039:
1.1.1.2 ! misho 1040: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
! 1041: # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
! 1042: # it.
! 1043: # The default directory is: html.
! 1044: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1045:
1046: HTML_OUTPUT = html
1047:
1.1.1.2 ! misho 1048: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
! 1049: # generated HTML page (for example: .htm, .php, .asp).
! 1050: # The default value is: .html.
! 1051: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1052:
1053: HTML_FILE_EXTENSION = .html
1054:
1.1.1.2 ! misho 1055: # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
! 1056: # each generated HTML page. If the tag is left blank doxygen will generate a
1.1 misho 1057: # standard header.
1.1.1.2 ! misho 1058: #
! 1059: # To get valid HTML the header file that includes any scripts and style sheets
! 1060: # that doxygen needs, which is dependent on the configuration options used (e.g.
! 1061: # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
! 1062: # default header using
! 1063: # doxygen -w html new_header.html new_footer.html new_stylesheet.css
! 1064: # YourConfigFile
! 1065: # and then modify the file new_header.html. See also section "Doxygen usage"
! 1066: # for information on how to generate the default header that doxygen normally
! 1067: # uses.
! 1068: # Note: The header is subject to change so you typically have to regenerate the
! 1069: # default header when upgrading to a newer version of doxygen. For a description
! 1070: # of the possible markers and block names see the documentation.
! 1071: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1072:
! 1073: HTML_HEADER = @top_srcdir@/doc/doxygen-header.html
! 1074:
! 1075: # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
! 1076: # generated HTML page. If the tag is left blank doxygen will generate a standard
! 1077: # footer. See HTML_HEADER for more information on how to generate a default
! 1078: # footer and what special commands can be used inside the footer. See also
! 1079: # section "Doxygen usage" for information on how to generate the default footer
! 1080: # that doxygen normally uses.
! 1081: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1082:
! 1083: HTML_FOOTER = @top_srcdir@/doc/doxygen-footer.html
! 1084:
! 1085: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
! 1086: # sheet that is used by each HTML page. It can be used to fine-tune the look of
! 1087: # the HTML output. If left blank doxygen will generate a default style sheet.
! 1088: # See also section "Doxygen usage" for information on how to generate the style
! 1089: # sheet that doxygen normally uses.
! 1090: # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
! 1091: # it is more robust and this tag (HTML_STYLESHEET) will in the future become
! 1092: # obsolete.
! 1093: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1094:
! 1095: HTML_STYLESHEET = doxygen.css
! 1096:
! 1097: # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
! 1098: # cascading style sheets that are included after the standard style sheets
! 1099: # created by doxygen. Using this option one can overrule certain style aspects.
! 1100: # This is preferred over using HTML_STYLESHEET since it does not replace the
! 1101: # standard style sheet and is therefore more robust against future updates.
! 1102: # Doxygen will copy the style sheet files to the output directory.
! 1103: # Note: The order of the extra style sheet files is of importance (e.g. the last
! 1104: # style sheet in the list overrules the setting of the previous ones in the
! 1105: # list). For an example see the documentation.
! 1106: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1107:
! 1108: HTML_EXTRA_STYLESHEET =
! 1109:
! 1110: # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
! 1111: # other source files which should be copied to the HTML output directory. Note
! 1112: # that these files will be copied to the base HTML output directory. Use the
! 1113: # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
! 1114: # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
! 1115: # files will be copied as-is; there are no commands or markers available.
! 1116: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1117:
! 1118: HTML_EXTRA_FILES =
! 1119:
! 1120: # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
! 1121: # will adjust the colors in the style sheet and background images according to
! 1122: # this color. Hue is specified as an angle on a colorwheel, see
! 1123: # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
! 1124: # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
! 1125: # purple, and 360 is red again.
! 1126: # Minimum value: 0, maximum value: 359, default value: 220.
! 1127: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1128:
! 1129: HTML_COLORSTYLE_HUE = 220
! 1130:
! 1131: # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
! 1132: # in the HTML output. For a value of 0 the output will use grayscales only. A
! 1133: # value of 255 will produce the most vivid colors.
! 1134: # Minimum value: 0, maximum value: 255, default value: 100.
! 1135: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1136:
! 1137: HTML_COLORSTYLE_SAT = 100
! 1138:
! 1139: # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
! 1140: # luminance component of the colors in the HTML output. Values below 100
! 1141: # gradually make the output lighter, whereas values above 100 make the output
! 1142: # darker. The value divided by 100 is the actual gamma applied, so 80 represents
! 1143: # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
! 1144: # change the gamma.
! 1145: # Minimum value: 40, maximum value: 240, default value: 80.
! 1146: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1147:
! 1148: HTML_COLORSTYLE_GAMMA = 80
! 1149:
! 1150: # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
! 1151: # page will contain the date and time when the page was generated. Setting this
! 1152: # to YES can help to show when doxygen was last run and thus if the
! 1153: # documentation is up to date.
! 1154: # The default value is: NO.
! 1155: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1156:
! 1157: HTML_TIMESTAMP = NO
! 1158:
! 1159: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
! 1160: # documentation will contain sections that can be hidden and shown after the
! 1161: # page has loaded.
! 1162: # The default value is: NO.
! 1163: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1164:
1165: HTML_DYNAMIC_SECTIONS = NO
1166:
1.1.1.2 ! misho 1167: # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
! 1168: # shown in the various tree structured indices initially; the user can expand
! 1169: # and collapse entries dynamically later on. Doxygen will expand the tree to
! 1170: # such a level that at most the specified number of entries are visible (unless
! 1171: # a fully collapsed tree already exceeds this amount). So setting the number of
! 1172: # entries 1 will produce a full collapsed tree by default. 0 is a special value
! 1173: # representing an infinite number of entries and will result in a full expanded
! 1174: # tree by default.
! 1175: # Minimum value: 0, maximum value: 9999, default value: 100.
! 1176: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1177:
! 1178: HTML_INDEX_NUM_ENTRIES = 100
! 1179:
! 1180: # If the GENERATE_DOCSET tag is set to YES, additional index files will be
! 1181: # generated that can be used as input for Apple's Xcode 3 integrated development
! 1182: # environment (see: http://developer.apple.com/tools/xcode/), introduced with
! 1183: # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
! 1184: # Makefile in the HTML output directory. Running make will produce the docset in
! 1185: # that directory and running make install will install the docset in
! 1186: # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
! 1187: # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
! 1188: # for more information.
! 1189: # The default value is: NO.
! 1190: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1191:
1192: GENERATE_DOCSET = NO
1193:
1.1.1.2 ! misho 1194: # This tag determines the name of the docset feed. A documentation feed provides
! 1195: # an umbrella under which multiple documentation sets from a single provider
! 1196: # (such as a company or product suite) can be grouped.
! 1197: # The default value is: Doxygen generated docs.
! 1198: # This tag requires that the tag GENERATE_DOCSET is set to YES.
1.1 misho 1199:
1200: DOCSET_FEEDNAME = "Doxygen generated docs"
1201:
1.1.1.2 ! misho 1202: # This tag specifies a string that should uniquely identify the documentation
! 1203: # set bundle. This should be a reverse domain-name style string, e.g.
! 1204: # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
! 1205: # The default value is: org.doxygen.Project.
! 1206: # This tag requires that the tag GENERATE_DOCSET is set to YES.
1.1 misho 1207:
1208: DOCSET_BUNDLE_ID = org.doxygen.Project
1209:
1.1.1.2 ! misho 1210: # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
! 1211: # the documentation publisher. This should be a reverse domain-name style
! 1212: # string, e.g. com.mycompany.MyDocSet.documentation.
! 1213: # The default value is: org.doxygen.Publisher.
! 1214: # This tag requires that the tag GENERATE_DOCSET is set to YES.
! 1215:
! 1216: DOCSET_PUBLISHER_ID = org.doxygen.Confuse
! 1217:
! 1218: # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
! 1219: # The default value is: Publisher.
! 1220: # This tag requires that the tag GENERATE_DOCSET is set to YES.
! 1221:
! 1222: DOCSET_PUBLISHER_NAME = Confuse
! 1223:
! 1224: # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
! 1225: # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
! 1226: # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
! 1227: # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
! 1228: # Windows.
! 1229: #
! 1230: # The HTML Help Workshop contains a compiler that can convert all HTML output
! 1231: # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
! 1232: # files are now used as the Windows 98 help format, and will replace the old
! 1233: # Windows help format (.hlp) on all Windows platforms in the future. Compressed
! 1234: # HTML files also contain an index, a table of contents, and you can search for
! 1235: # words in the documentation. The HTML workshop also contains a viewer for
! 1236: # compressed HTML files.
! 1237: # The default value is: NO.
! 1238: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1239:
1240: GENERATE_HTMLHELP = NO
1241:
1.1.1.2 ! misho 1242: # The CHM_FILE tag can be used to specify the file name of the resulting .chm
! 1243: # file. You can add a path in front of the file if the result should not be
1.1 misho 1244: # written to the html output directory.
1.1.1.2 ! misho 1245: # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1 misho 1246:
1.1.1.2 ! misho 1247: CHM_FILE =
1.1 misho 1248:
1.1.1.2 ! misho 1249: # The HHC_LOCATION tag can be used to specify the location (absolute path
! 1250: # including file name) of the HTML help compiler (hhc.exe). If non-empty,
! 1251: # doxygen will try to run the HTML help compiler on the generated index.hhp.
! 1252: # The file has to be specified with full path.
! 1253: # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
! 1254:
! 1255: HHC_LOCATION =
! 1256:
! 1257: # The GENERATE_CHI flag controls if a separate .chi index file is generated
! 1258: # (YES) or that it should be included in the master .chm file (NO).
! 1259: # The default value is: NO.
! 1260: # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1 misho 1261:
1262: GENERATE_CHI = NO
1263:
1.1.1.2 ! misho 1264: # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
! 1265: # and project file content.
! 1266: # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
! 1267:
! 1268: CHM_INDEX_ENCODING =
! 1269:
! 1270: # The BINARY_TOC flag controls whether a binary table of contents is generated
! 1271: # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
! 1272: # enables the Previous and Next buttons.
! 1273: # The default value is: NO.
! 1274: # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1 misho 1275:
1276: BINARY_TOC = NO
1277:
1.1.1.2 ! misho 1278: # The TOC_EXPAND flag can be set to YES to add extra items for group members to
! 1279: # the table of contents of the HTML help documentation and to the tree view.
! 1280: # The default value is: NO.
! 1281: # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1 misho 1282:
1283: TOC_EXPAND = NO
1284:
1.1.1.2 ! misho 1285: # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
! 1286: # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
! 1287: # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
! 1288: # (.qch) of the generated HTML documentation.
! 1289: # The default value is: NO.
! 1290: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1291:
1292: GENERATE_QHP = NO
1293:
1.1.1.2 ! misho 1294: # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
! 1295: # the file name of the resulting .qch file. The path specified is relative to
! 1296: # the HTML output folder.
! 1297: # This tag requires that the tag GENERATE_QHP is set to YES.
! 1298:
! 1299: QCH_FILE =
! 1300:
! 1301: # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
! 1302: # Project output. For more information please see Qt Help Project / Namespace
! 1303: # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
! 1304: # The default value is: org.doxygen.Project.
! 1305: # This tag requires that the tag GENERATE_QHP is set to YES.
! 1306:
! 1307: QHP_NAMESPACE = org.doxygen.Project
! 1308:
! 1309: # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
! 1310: # Help Project output. For more information please see Qt Help Project / Virtual
! 1311: # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
! 1312: # folders).
! 1313: # The default value is: doc.
! 1314: # This tag requires that the tag GENERATE_QHP is set to YES.
1.1 misho 1315:
1.1.1.2 ! misho 1316: QHP_VIRTUAL_FOLDER = doc
1.1 misho 1317:
1.1.1.2 ! misho 1318: # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
! 1319: # filter to add. For more information please see Qt Help Project / Custom
! 1320: # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
! 1321: # filters).
! 1322: # This tag requires that the tag GENERATE_QHP is set to YES.
! 1323:
! 1324: QHP_CUST_FILTER_NAME =
! 1325:
! 1326: # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
! 1327: # custom filter to add. For more information please see Qt Help Project / Custom
! 1328: # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
! 1329: # filters).
! 1330: # This tag requires that the tag GENERATE_QHP is set to YES.
! 1331:
! 1332: QHP_CUST_FILTER_ATTRS =
! 1333:
! 1334: # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
! 1335: # project's filter section matches. Qt Help Project / Filter Attributes (see:
! 1336: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
! 1337: # This tag requires that the tag GENERATE_QHP is set to YES.
! 1338:
! 1339: QHP_SECT_FILTER_ATTRS =
! 1340:
! 1341: # The QHG_LOCATION tag can be used to specify the location of Qt's
! 1342: # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
! 1343: # generated .qhp file.
! 1344: # This tag requires that the tag GENERATE_QHP is set to YES.
! 1345:
! 1346: QHG_LOCATION =
! 1347:
! 1348: # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
! 1349: # generated, together with the HTML files, they form an Eclipse help plugin. To
! 1350: # install this plugin and make it available under the help contents menu in
! 1351: # Eclipse, the contents of the directory containing the HTML and XML files needs
! 1352: # to be copied into the plugins directory of eclipse. The name of the directory
! 1353: # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
! 1354: # After copying Eclipse needs to be restarted before the help appears.
! 1355: # The default value is: NO.
! 1356: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1357:
! 1358: GENERATE_ECLIPSEHELP = NO
! 1359:
! 1360: # A unique identifier for the Eclipse help plugin. When installing the plugin
! 1361: # the directory name containing the HTML and XML files should also have this
! 1362: # name. Each documentation set should have its own identifier.
! 1363: # The default value is: org.doxygen.Project.
! 1364: # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
! 1365:
! 1366: ECLIPSE_DOC_ID = org.doxygen.Project
! 1367:
! 1368: # If you want full control over the layout of the generated HTML pages it might
! 1369: # be necessary to disable the index and replace it with your own. The
! 1370: # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
! 1371: # of each HTML page. A value of NO enables the index and the value YES disables
! 1372: # it. Since the tabs in the index contain the same information as the navigation
! 1373: # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
! 1374: # The default value is: NO.
! 1375: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1376:
1.1.1.2 ! misho 1377: DISABLE_INDEX = NO
1.1 misho 1378:
1.1.1.2 ! misho 1379: # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
! 1380: # structure should be generated to display hierarchical information. If the tag
! 1381: # value is set to YES, a side panel will be generated containing a tree-like
! 1382: # index structure (just like the one that is generated for HTML Help). For this
! 1383: # to work a browser that supports JavaScript, DHTML, CSS and frames is required
! 1384: # (i.e. any modern browser). Windows users are probably better off using the
! 1385: # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
! 1386: # further fine-tune the look of the index. As an example, the default style
! 1387: # sheet generated by doxygen has an example that shows how to put an image at
! 1388: # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
! 1389: # the same information as the tab index, you could consider setting
! 1390: # DISABLE_INDEX to YES when enabling this option.
! 1391: # The default value is: NO.
! 1392: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1393:
1.1.1.2 ! misho 1394: GENERATE_TREEVIEW = NO
1.1 misho 1395:
1.1.1.2 ! misho 1396: # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
! 1397: # doxygen will group on one line in the generated HTML documentation.
! 1398: #
! 1399: # Note that a value of 0 will completely suppress the enum values from appearing
! 1400: # in the overview section.
! 1401: # Minimum value: 0, maximum value: 20, default value: 4.
! 1402: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1403:
1.1.1.2 ! misho 1404: ENUM_VALUES_PER_LINE = 4
1.1 misho 1405:
1.1.1.2 ! misho 1406: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
! 1407: # to set the initial width (in pixels) of the frame in which the tree is shown.
! 1408: # Minimum value: 0, maximum value: 1500, default value: 250.
! 1409: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1410:
1.1.1.2 ! misho 1411: TREEVIEW_WIDTH = 250
1.1 misho 1412:
1.1.1.2 ! misho 1413: # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
! 1414: # external symbols imported via tag files in a separate window.
! 1415: # The default value is: NO.
! 1416: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1417:
! 1418: EXT_LINKS_IN_WINDOW = NO
! 1419:
! 1420: # Use this tag to change the font size of LaTeX formulas included as images in
! 1421: # the HTML documentation. When you change the font size after a successful
! 1422: # doxygen run you need to manually remove any form_*.png images from the HTML
! 1423: # output directory to force them to be regenerated.
! 1424: # Minimum value: 8, maximum value: 50, default value: 10.
! 1425: # This tag requires that the tag GENERATE_HTML is set to YES.
1.1 misho 1426:
1.1.1.2 ! misho 1427: FORMULA_FONTSIZE = 10
1.1 misho 1428:
1.1.1.2 ! misho 1429: # Use the FORMULA_TRANPARENT tag to determine whether or not the images
! 1430: # generated for formulas are transparent PNGs. Transparent PNGs are not
! 1431: # supported properly for IE 6.0, but are supported on all modern browsers.
! 1432: #
! 1433: # Note that when changing this option you need to delete any form_*.png files in
! 1434: # the HTML output directory before the changes have effect.
! 1435: # The default value is: YES.
! 1436: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1437:
! 1438: FORMULA_TRANSPARENT = YES
! 1439:
! 1440: # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
! 1441: # http://www.mathjax.org) which uses client side Javascript for the rendering
! 1442: # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
! 1443: # installed or if you want to formulas look prettier in the HTML output. When
! 1444: # enabled you may also need to install MathJax separately and configure the path
! 1445: # to it using the MATHJAX_RELPATH option.
! 1446: # The default value is: NO.
! 1447: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1448:
! 1449: USE_MATHJAX = NO
! 1450:
! 1451: # When MathJax is enabled you can set the default output format to be used for
! 1452: # the MathJax output. See the MathJax site (see:
! 1453: # http://docs.mathjax.org/en/latest/output.html) for more details.
! 1454: # Possible values are: HTML-CSS (which is slower, but has the best
! 1455: # compatibility), NativeMML (i.e. MathML) and SVG.
! 1456: # The default value is: HTML-CSS.
! 1457: # This tag requires that the tag USE_MATHJAX is set to YES.
! 1458:
! 1459: MATHJAX_FORMAT = HTML-CSS
! 1460:
! 1461: # When MathJax is enabled you need to specify the location relative to the HTML
! 1462: # output directory using the MATHJAX_RELPATH option. The destination directory
! 1463: # should contain the MathJax.js script. For instance, if the mathjax directory
! 1464: # is located at the same level as the HTML output directory, then
! 1465: # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
! 1466: # Content Delivery Network so you can quickly see the result without installing
! 1467: # MathJax. However, it is strongly recommended to install a local copy of
! 1468: # MathJax from http://www.mathjax.org before deployment.
! 1469: # The default value is: http://cdn.mathjax.org/mathjax/latest.
! 1470: # This tag requires that the tag USE_MATHJAX is set to YES.
! 1471:
! 1472: MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
! 1473:
! 1474: # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
! 1475: # extension names that should be enabled during MathJax rendering. For example
! 1476: # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
! 1477: # This tag requires that the tag USE_MATHJAX is set to YES.
! 1478:
! 1479: MATHJAX_EXTENSIONS =
! 1480:
! 1481: # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
! 1482: # of code that will be used on startup of the MathJax code. See the MathJax site
! 1483: # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
! 1484: # example see the documentation.
! 1485: # This tag requires that the tag USE_MATHJAX is set to YES.
! 1486:
! 1487: MATHJAX_CODEFILE =
! 1488:
! 1489: # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
! 1490: # the HTML output. The underlying search engine uses javascript and DHTML and
! 1491: # should work on any modern browser. Note that when using HTML help
! 1492: # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
! 1493: # there is already a search function so this one should typically be disabled.
! 1494: # For large projects the javascript based search engine can be slow, then
! 1495: # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
! 1496: # search using the keyboard; to jump to the search box use <access key> + S
! 1497: # (what the <access key> is depends on the OS and browser, but it is typically
! 1498: # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
! 1499: # key> to jump into the search results window, the results can be navigated
! 1500: # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
! 1501: # the search. The filter options can be selected when the cursor is inside the
! 1502: # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
! 1503: # to select a filter and <Enter> or <escape> to activate or cancel the filter
! 1504: # option.
! 1505: # The default value is: YES.
! 1506: # This tag requires that the tag GENERATE_HTML is set to YES.
! 1507:
! 1508: SEARCHENGINE = YES
! 1509:
! 1510: # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
! 1511: # implemented using a web server instead of a web client using Javascript. There
! 1512: # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
! 1513: # setting. When disabled, doxygen will generate a PHP script for searching and
! 1514: # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
! 1515: # and searching needs to be provided by external tools. See the section
! 1516: # "External Indexing and Searching" for details.
! 1517: # The default value is: NO.
! 1518: # This tag requires that the tag SEARCHENGINE is set to YES.
! 1519:
! 1520: SERVER_BASED_SEARCH = NO
! 1521:
! 1522: # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
! 1523: # script for searching. Instead the search results are written to an XML file
! 1524: # which needs to be processed by an external indexer. Doxygen will invoke an
! 1525: # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
! 1526: # search results.
! 1527: #
! 1528: # Doxygen ships with an example indexer (doxyindexer) and search engine
! 1529: # (doxysearch.cgi) which are based on the open source search engine library
! 1530: # Xapian (see: http://xapian.org/).
! 1531: #
! 1532: # See the section "External Indexing and Searching" for details.
! 1533: # The default value is: NO.
! 1534: # This tag requires that the tag SEARCHENGINE is set to YES.
1.1 misho 1535:
1.1.1.2 ! misho 1536: EXTERNAL_SEARCH = NO
1.1 misho 1537:
1.1.1.2 ! misho 1538: # The SEARCHENGINE_URL should point to a search engine hosted by a web server
! 1539: # which will return the search results when EXTERNAL_SEARCH is enabled.
! 1540: #
! 1541: # Doxygen ships with an example indexer (doxyindexer) and search engine
! 1542: # (doxysearch.cgi) which are based on the open source search engine library
! 1543: # Xapian (see: http://xapian.org/). See the section "External Indexing and
! 1544: # Searching" for details.
! 1545: # This tag requires that the tag SEARCHENGINE is set to YES.
1.1 misho 1546:
1.1.1.2 ! misho 1547: SEARCHENGINE_URL =
1.1 misho 1548:
1.1.1.2 ! misho 1549: # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
! 1550: # search data is written to a file for indexing by an external tool. With the
! 1551: # SEARCHDATA_FILE tag the name of this file can be specified.
! 1552: # The default file is: searchdata.xml.
! 1553: # This tag requires that the tag SEARCHENGINE is set to YES.
1.1 misho 1554:
1.1.1.2 ! misho 1555: SEARCHDATA_FILE = searchdata.xml
1.1 misho 1556:
1.1.1.2 ! misho 1557: # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
! 1558: # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
! 1559: # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
! 1560: # projects and redirect the results back to the right project.
! 1561: # This tag requires that the tag SEARCHENGINE is set to YES.
1.1 misho 1562:
1.1.1.2 ! misho 1563: EXTERNAL_SEARCH_ID =
1.1 misho 1564:
1.1.1.2 ! misho 1565: # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
! 1566: # projects other than the one defined by this configuration file, but that are
! 1567: # all added to the same external search index. Each project needs to have a
! 1568: # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
! 1569: # to a relative location where the documentation can be found. The format is:
! 1570: # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
! 1571: # This tag requires that the tag SEARCHENGINE is set to YES.
1.1 misho 1572:
1.1.1.2 ! misho 1573: EXTRA_SEARCH_MAPPINGS =
1.1 misho 1574:
1575: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1576: # Configuration options related to the LaTeX output
1.1 misho 1577: #---------------------------------------------------------------------------
1578:
1.1.1.2 ! misho 1579: # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
! 1580: # The default value is: YES.
1.1 misho 1581:
1582: GENERATE_LATEX = NO
1583:
1.1.1.2 ! misho 1584: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
! 1585: # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
! 1586: # it.
! 1587: # The default directory is: latex.
! 1588: # This tag requires that the tag GENERATE_LATEX is set to YES.
1.1 misho 1589:
1590: LATEX_OUTPUT = latex
1591:
1.1.1.2 ! misho 1592: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
! 1593: # invoked.
! 1594: #
! 1595: # Note that when enabling USE_PDFLATEX this option is only used for generating
! 1596: # bitmaps for formulas in the HTML output, but not in the Makefile that is
! 1597: # written to the output directory.
! 1598: # The default file is: latex.
! 1599: # This tag requires that the tag GENERATE_LATEX is set to YES.
1.1 misho 1600:
1601: LATEX_CMD_NAME = latex
1602:
1.1.1.2 ! misho 1603: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
! 1604: # index for LaTeX.
! 1605: # The default file is: makeindex.
! 1606: # This tag requires that the tag GENERATE_LATEX is set to YES.
1.1 misho 1607:
1608: MAKEINDEX_CMD_NAME = makeindex
1609:
1.1.1.2 ! misho 1610: # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
! 1611: # documents. This may be useful for small projects and may help to save some
! 1612: # trees in general.
! 1613: # The default value is: NO.
! 1614: # This tag requires that the tag GENERATE_LATEX is set to YES.
! 1615:
! 1616: COMPACT_LATEX = YES
! 1617:
! 1618: # The PAPER_TYPE tag can be used to set the paper type that is used by the
! 1619: # printer.
! 1620: # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
! 1621: # 14 inches) and executive (7.25 x 10.5 inches).
! 1622: # The default value is: a4.
! 1623: # This tag requires that the tag GENERATE_LATEX is set to YES.
1.1 misho 1624:
1625: PAPER_TYPE = a4
1626:
1.1.1.2 ! misho 1627: # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
! 1628: # that should be included in the LaTeX output. To get the times font for
! 1629: # instance you can specify
! 1630: # EXTRA_PACKAGES=times
! 1631: # If left blank no extra packages will be included.
! 1632: # This tag requires that the tag GENERATE_LATEX is set to YES.
! 1633:
! 1634: EXTRA_PACKAGES =
! 1635:
! 1636: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
! 1637: # generated LaTeX document. The header should contain everything until the first
! 1638: # chapter. If it is left blank doxygen will generate a standard header. See
! 1639: # section "Doxygen usage" for information on how to let doxygen write the
! 1640: # default header to a separate file.
! 1641: #
! 1642: # Note: Only use a user-defined header if you know what you are doing! The
! 1643: # following commands have a special meaning inside the header: $title,
! 1644: # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
! 1645: # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
! 1646: # string, for the replacement values of the other commands the user is referred
! 1647: # to HTML_HEADER.
! 1648: # This tag requires that the tag GENERATE_LATEX is set to YES.
! 1649:
! 1650: LATEX_HEADER =
! 1651:
! 1652: # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
! 1653: # generated LaTeX document. The footer should contain everything after the last
! 1654: # chapter. If it is left blank doxygen will generate a standard footer. See
! 1655: # LATEX_HEADER for more information on how to generate a default footer and what
! 1656: # special commands can be used inside the footer.
! 1657: #
! 1658: # Note: Only use a user-defined footer if you know what you are doing!
! 1659: # This tag requires that the tag GENERATE_LATEX is set to YES.
1.1 misho 1660:
1.1.1.2 ! misho 1661: LATEX_FOOTER =
1.1 misho 1662:
1.1.1.2 ! misho 1663: # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
! 1664: # LaTeX style sheets that are included after the standard style sheets created
! 1665: # by doxygen. Using this option one can overrule certain style aspects. Doxygen
! 1666: # will copy the style sheet files to the output directory.
! 1667: # Note: The order of the extra style sheet files is of importance (e.g. the last
! 1668: # style sheet in the list overrules the setting of the previous ones in the
! 1669: # list).
! 1670: # This tag requires that the tag GENERATE_LATEX is set to YES.
! 1671:
! 1672: LATEX_EXTRA_STYLESHEET =
! 1673:
! 1674: # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
! 1675: # other source files which should be copied to the LATEX_OUTPUT output
! 1676: # directory. Note that the files will be copied as-is; there are no commands or
! 1677: # markers available.
! 1678: # This tag requires that the tag GENERATE_LATEX is set to YES.
! 1679:
! 1680: LATEX_EXTRA_FILES =
! 1681:
! 1682: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
! 1683: # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
! 1684: # contain links (just like the HTML output) instead of page references. This
! 1685: # makes the output suitable for online browsing using a PDF viewer.
! 1686: # The default value is: YES.
! 1687: # This tag requires that the tag GENERATE_LATEX is set to YES.
1.1 misho 1688:
1.1.1.2 ! misho 1689: PDF_HYPERLINKS = YES
1.1 misho 1690:
1.1.1.2 ! misho 1691: # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
! 1692: # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1.1 misho 1693: # higher quality PDF documentation.
1.1.1.2 ! misho 1694: # The default value is: YES.
! 1695: # This tag requires that the tag GENERATE_LATEX is set to YES.
1.1 misho 1696:
1.1.1.2 ! misho 1697: USE_PDFLATEX = YES
1.1 misho 1698:
1.1.1.2 ! misho 1699: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
! 1700: # command to the generated LaTeX files. This will instruct LaTeX to keep running
! 1701: # if errors occur, instead of asking the user for help. This option is also used
! 1702: # when generating formulas in HTML.
! 1703: # The default value is: NO.
! 1704: # This tag requires that the tag GENERATE_LATEX is set to YES.
! 1705:
! 1706: LATEX_BATCHMODE = YES
! 1707:
! 1708: # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
! 1709: # index chapters (such as File Index, Compound Index, etc.) in the output.
! 1710: # The default value is: NO.
! 1711: # This tag requires that the tag GENERATE_LATEX is set to YES.
1.1 misho 1712:
1713: LATEX_HIDE_INDICES = NO
1714:
1.1.1.2 ! misho 1715: # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
! 1716: # code with syntax highlighting in the LaTeX output.
! 1717: #
! 1718: # Note that which sources are shown also depends on other settings such as
! 1719: # SOURCE_BROWSER.
! 1720: # The default value is: NO.
! 1721: # This tag requires that the tag GENERATE_LATEX is set to YES.
! 1722:
! 1723: LATEX_SOURCE_CODE = NO
! 1724:
! 1725: # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
! 1726: # bibliography, e.g. plainnat, or ieeetr. See
! 1727: # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
! 1728: # The default value is: plain.
! 1729: # This tag requires that the tag GENERATE_LATEX is set to YES.
! 1730:
! 1731: LATEX_BIB_STYLE = plain
! 1732:
1.1 misho 1733: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1734: # Configuration options related to the RTF output
1.1 misho 1735: #---------------------------------------------------------------------------
1736:
1.1.1.2 ! misho 1737: # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
! 1738: # RTF output is optimized for Word 97 and may not look too pretty with other RTF
! 1739: # readers/editors.
! 1740: # The default value is: NO.
1.1 misho 1741:
1742: GENERATE_RTF = NO
1743:
1.1.1.2 ! misho 1744: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
! 1745: # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
! 1746: # it.
! 1747: # The default directory is: rtf.
! 1748: # This tag requires that the tag GENERATE_RTF is set to YES.
1.1 misho 1749:
1750: RTF_OUTPUT = rtf
1751:
1.1.1.2 ! misho 1752: # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
! 1753: # documents. This may be useful for small projects and may help to save some
! 1754: # trees in general.
! 1755: # The default value is: NO.
! 1756: # This tag requires that the tag GENERATE_RTF is set to YES.
1.1 misho 1757:
1758: COMPACT_RTF = NO
1759:
1.1.1.2 ! misho 1760: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
! 1761: # contain hyperlink fields. The RTF file will contain links (just like the HTML
! 1762: # output) instead of page references. This makes the output suitable for online
! 1763: # browsing using Word or some other Word compatible readers that support those
! 1764: # fields.
! 1765: #
! 1766: # Note: WordPad (write) and others do not support links.
! 1767: # The default value is: NO.
! 1768: # This tag requires that the tag GENERATE_RTF is set to YES.
1.1 misho 1769:
1770: RTF_HYPERLINKS = NO
1771:
1.1.1.2 ! misho 1772: # Load stylesheet definitions from file. Syntax is similar to doxygen's config
! 1773: # file, i.e. a series of assignments. You only have to provide replacements,
! 1774: # missing definitions are set to their default value.
! 1775: #
! 1776: # See also section "Doxygen usage" for information on how to generate the
! 1777: # default style sheet that doxygen normally uses.
! 1778: # This tag requires that the tag GENERATE_RTF is set to YES.
! 1779:
! 1780: RTF_STYLESHEET_FILE =
1.1 misho 1781:
1.1.1.2 ! misho 1782: # Set optional variables used in the generation of an RTF document. Syntax is
! 1783: # similar to doxygen's config file. A template extensions file can be generated
! 1784: # using doxygen -e rtf extensionFile.
! 1785: # This tag requires that the tag GENERATE_RTF is set to YES.
1.1 misho 1786:
1.1.1.2 ! misho 1787: RTF_EXTENSIONS_FILE =
1.1 misho 1788:
1.1.1.2 ! misho 1789: # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
! 1790: # with syntax highlighting in the RTF output.
! 1791: #
! 1792: # Note that which sources are shown also depends on other settings such as
! 1793: # SOURCE_BROWSER.
! 1794: # The default value is: NO.
! 1795: # This tag requires that the tag GENERATE_RTF is set to YES.
! 1796:
! 1797: RTF_SOURCE_CODE = NO
1.1 misho 1798:
1799: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1800: # Configuration options related to the man page output
1.1 misho 1801: #---------------------------------------------------------------------------
1802:
1.1.1.2 ! misho 1803: # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
! 1804: # classes and files.
! 1805: # The default value is: NO.
1.1 misho 1806:
1807: GENERATE_MAN = YES
1808:
1.1.1.2 ! misho 1809: # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
! 1810: # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
! 1811: # it. A directory man3 will be created inside the directory specified by
! 1812: # MAN_OUTPUT.
! 1813: # The default directory is: man.
! 1814: # This tag requires that the tag GENERATE_MAN is set to YES.
1.1 misho 1815:
1816: MAN_OUTPUT = man
1817:
1.1.1.2 ! misho 1818: # The MAN_EXTENSION tag determines the extension that is added to the generated
! 1819: # man pages. In case the manual section does not start with a number, the number
! 1820: # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
! 1821: # optional.
! 1822: # The default value is: .3.
! 1823: # This tag requires that the tag GENERATE_MAN is set to YES.
1.1 misho 1824:
1825: MAN_EXTENSION = .3
1826:
1.1.1.2 ! misho 1827: # The MAN_SUBDIR tag determines the name of the directory created within
! 1828: # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
! 1829: # MAN_EXTENSION with the initial . removed.
! 1830: # This tag requires that the tag GENERATE_MAN is set to YES.
! 1831:
! 1832: MAN_SUBDIR =
! 1833:
! 1834: # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
! 1835: # will generate one additional man file for each entity documented in the real
! 1836: # man page(s). These additional files only source the real man page, but without
! 1837: # them the man command would be unable to find the correct page.
! 1838: # The default value is: NO.
! 1839: # This tag requires that the tag GENERATE_MAN is set to YES.
1.1 misho 1840:
1841: MAN_LINKS = NO
1842:
1843: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1844: # Configuration options related to the XML output
1.1 misho 1845: #---------------------------------------------------------------------------
1846:
1.1.1.2 ! misho 1847: # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
! 1848: # captures the structure of the code including all documentation.
! 1849: # The default value is: NO.
1.1 misho 1850:
1851: GENERATE_XML = NO
1852:
1.1.1.2 ! misho 1853: # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
! 1854: # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
! 1855: # it.
! 1856: # The default directory is: xml.
! 1857: # This tag requires that the tag GENERATE_XML is set to YES.
1.1 misho 1858:
1859: XML_OUTPUT = xml
1860:
1.1.1.2 ! misho 1861: # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
! 1862: # listings (including syntax highlighting and cross-referencing information) to
! 1863: # the XML output. Note that enabling this will significantly increase the size
! 1864: # of the XML output.
! 1865: # The default value is: YES.
! 1866: # This tag requires that the tag GENERATE_XML is set to YES.
1.1 misho 1867:
1868: XML_PROGRAMLISTING = YES
1869:
1870: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1871: # Configuration options related to the DOCBOOK output
! 1872: #---------------------------------------------------------------------------
! 1873:
! 1874: # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
! 1875: # that can be used to generate PDF.
! 1876: # The default value is: NO.
! 1877:
! 1878: GENERATE_DOCBOOK = NO
! 1879:
! 1880: # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
! 1881: # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
! 1882: # front of it.
! 1883: # The default directory is: docbook.
! 1884: # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
! 1885:
! 1886: DOCBOOK_OUTPUT = docbook
! 1887:
! 1888: # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
! 1889: # program listings (including syntax highlighting and cross-referencing
! 1890: # information) to the DOCBOOK output. Note that enabling this will significantly
! 1891: # increase the size of the DOCBOOK output.
! 1892: # The default value is: NO.
! 1893: # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
! 1894:
! 1895: DOCBOOK_PROGRAMLISTING = NO
! 1896:
! 1897: #---------------------------------------------------------------------------
! 1898: # Configuration options for the AutoGen Definitions output
1.1 misho 1899: #---------------------------------------------------------------------------
1900:
1.1.1.2 ! misho 1901: # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
! 1902: # AutoGen Definitions (see http://autogen.sf.net) file that captures the
! 1903: # structure of the code including all documentation. Note that this feature is
! 1904: # still experimental and incomplete at the moment.
! 1905: # The default value is: NO.
1.1 misho 1906:
1907: GENERATE_AUTOGEN_DEF = NO
1908:
1909: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1910: # Configuration options related to the Perl module output
1.1 misho 1911: #---------------------------------------------------------------------------
1912:
1.1.1.2 ! misho 1913: # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
! 1914: # file that captures the structure of the code including all documentation.
! 1915: #
! 1916: # Note that this feature is still experimental and incomplete at the moment.
! 1917: # The default value is: NO.
1.1 misho 1918:
1919: GENERATE_PERLMOD = NO
1920:
1.1.1.2 ! misho 1921: # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
! 1922: # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
! 1923: # output from the Perl module output.
! 1924: # The default value is: NO.
! 1925: # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1.1 misho 1926:
1927: PERLMOD_LATEX = NO
1928:
1.1.1.2 ! misho 1929: # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
! 1930: # formatted so it can be parsed by a human reader. This is useful if you want to
! 1931: # understand what is going on. On the other hand, if this tag is set to NO, the
! 1932: # size of the Perl module output will be much smaller and Perl will parse it
! 1933: # just the same.
! 1934: # The default value is: YES.
! 1935: # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1.1 misho 1936:
1937: PERLMOD_PRETTY = YES
1938:
1.1.1.2 ! misho 1939: # The names of the make variables in the generated doxyrules.make file are
! 1940: # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
! 1941: # so different doxyrules.make files included by the same Makefile don't
! 1942: # overwrite each other's variables.
! 1943: # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1.1 misho 1944:
1.1.1.2 ! misho 1945: PERLMOD_MAKEVAR_PREFIX =
1.1 misho 1946:
1947: #---------------------------------------------------------------------------
1.1.1.2 ! misho 1948: # Configuration options related to the preprocessor
1.1 misho 1949: #---------------------------------------------------------------------------
1950:
1.1.1.2 ! misho 1951: # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
! 1952: # C-preprocessor directives found in the sources and include files.
! 1953: # The default value is: YES.
1.1 misho 1954:
1955: ENABLE_PREPROCESSING = YES
1956:
1.1.1.2 ! misho 1957: # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
! 1958: # in the source code. If set to NO, only conditional compilation will be
! 1959: # performed. Macro expansion can be done in a controlled way by setting
! 1960: # EXPAND_ONLY_PREDEF to YES.
! 1961: # The default value is: NO.
! 1962: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1 misho 1963:
1964: MACRO_EXPANSION = NO
1965:
1.1.1.2 ! misho 1966: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
! 1967: # the macro expansion is limited to the macros specified with the PREDEFINED and
! 1968: # EXPAND_AS_DEFINED tags.
! 1969: # The default value is: NO.
! 1970: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1 misho 1971:
1972: EXPAND_ONLY_PREDEF = NO
1973:
1.1.1.2 ! misho 1974: # If the SEARCH_INCLUDES tag is set to YES, the include files in the
! 1975: # INCLUDE_PATH will be searched if a #include is found.
! 1976: # The default value is: YES.
! 1977: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1 misho 1978:
1979: SEARCH_INCLUDES = YES
1980:
1.1.1.2 ! misho 1981: # The INCLUDE_PATH tag can be used to specify one or more directories that
! 1982: # contain include files that are not input files but should be processed by the
! 1983: # preprocessor.
! 1984: # This tag requires that the tag SEARCH_INCLUDES is set to YES.
! 1985:
! 1986: INCLUDE_PATH =
! 1987:
! 1988: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
! 1989: # patterns (like *.h and *.hpp) to filter out the header-files in the
! 1990: # directories. If left blank, the patterns specified with FILE_PATTERNS will be
! 1991: # used.
! 1992: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
! 1993:
! 1994: INCLUDE_FILE_PATTERNS =
! 1995:
! 1996: # The PREDEFINED tag can be used to specify one or more macro names that are
! 1997: # defined before the preprocessor is started (similar to the -D option of e.g.
! 1998: # gcc). The argument of the tag is a list of macros of the form: name or
! 1999: # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
! 2000: # is assumed. To prevent a macro definition from being undefined via #undef or
! 2001: # recursively expanded use the := operator instead of the = operator.
! 2002: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
! 2003:
! 2004: PREDEFINED =
! 2005:
! 2006: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
! 2007: # tag can be used to specify a list of macro names that should be expanded. The
! 2008: # macro definition that is found in the sources will be used. Use the PREDEFINED
! 2009: # tag if you want to use a different macro definition that overrules the
! 2010: # definition found in the source code.
! 2011: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
! 2012:
! 2013: EXPAND_AS_DEFINED =
! 2014:
! 2015: # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
! 2016: # remove all references to function-like macros that are alone on a line, have
! 2017: # an all uppercase name, and do not end with a semicolon. Such function macros
! 2018: # are typically used for boiler-plate code, and will confuse the parser if not
! 2019: # removed.
! 2020: # The default value is: YES.
! 2021: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1 misho 2022:
2023: SKIP_FUNCTION_MACROS = YES
2024:
2025: #---------------------------------------------------------------------------
1.1.1.2 ! misho 2026: # Configuration options related to external references
1.1 misho 2027: #---------------------------------------------------------------------------
2028:
1.1.1.2 ! misho 2029: # The TAGFILES tag can be used to specify one or more tag files. For each tag
! 2030: # file the location of the external documentation should be added. The format of
! 2031: # a tag file without this location is as follows:
! 2032: # TAGFILES = file1 file2 ...
! 2033: # Adding location for the tag files is done as follows:
! 2034: # TAGFILES = file1=loc1 "file2 = loc2" ...
! 2035: # where loc1 and loc2 can be relative or absolute paths or URLs. See the
! 2036: # section "Linking to external documentation" for more information about the use
! 2037: # of tag files.
! 2038: # Note: Each tag file must have a unique name (where the name does NOT include
! 2039: # the path). If a tag file is not located in the directory in which doxygen is
! 2040: # run, you must also specify the path to the tagfile here.
! 2041:
! 2042: TAGFILES =
! 2043:
! 2044: # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
! 2045: # tag file that is based on the input files it reads. See section "Linking to
! 2046: # external documentation" for more information about the usage of tag files.
! 2047:
! 2048: GENERATE_TAGFILE =
! 2049:
! 2050: # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
! 2051: # the class index. If set to NO, only the inherited external classes will be
! 2052: # listed.
! 2053: # The default value is: NO.
1.1 misho 2054:
2055: ALLEXTERNALS = NO
2056:
1.1.1.2 ! misho 2057: # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
! 2058: # in the modules index. If set to NO, only the current project's groups will be
! 2059: # listed.
! 2060: # The default value is: YES.
1.1 misho 2061:
2062: EXTERNAL_GROUPS = YES
2063:
1.1.1.2 ! misho 2064: # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
! 2065: # the related pages index. If set to NO, only the current project's pages will
! 2066: # be listed.
! 2067: # The default value is: YES.
1.1 misho 2068:
1.1.1.2 ! misho 2069: EXTERNAL_PAGES = YES
1.1 misho 2070:
2071: #---------------------------------------------------------------------------
1.1.1.2 ! misho 2072: # Configuration options related to the dot tool
1.1 misho 2073: #---------------------------------------------------------------------------
2074:
1.1.1.2 ! misho 2075: # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
! 2076: # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
! 2077: # NO turns the diagrams off. Note that this option also works with HAVE_DOT
! 2078: # disabled, but it is recommended to install and use dot, since it yields more
1.1 misho 2079: # powerful graphs.
1.1.1.2 ! misho 2080: # The default value is: YES.
1.1 misho 2081:
1.1.1.2 ! misho 2082: CLASS_DIAGRAMS = NO
1.1 misho 2083:
1.1.1.2 ! misho 2084: # You can include diagrams made with dia in doxygen documentation. Doxygen will
! 2085: # then run dia to produce the diagram and insert it in the documentation. The
! 2086: # DIA_PATH tag allows you to specify the directory where the dia binary resides.
! 2087: # If left empty dia is assumed to be found in the default search path.
1.1 misho 2088:
1.1.1.2 ! misho 2089: DIA_PATH =
1.1 misho 2090:
1.1.1.2 ! misho 2091: # If set to YES the inheritance and collaboration graphs will hide inheritance
! 2092: # and usage relations if the target is undocumented or is not a class.
! 2093: # The default value is: YES.
1.1 misho 2094:
1.1.1.2 ! misho 2095: HIDE_UNDOC_RELATIONS = YES
1.1 misho 2096:
1.1.1.2 ! misho 2097: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
! 2098: # available from the path. This tool is part of Graphviz (see:
! 2099: # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
! 2100: # Bell Labs. The other options in this section have no effect if this option is
! 2101: # set to NO
! 2102: # The default value is: YES.
1.1 misho 2103:
1.1.1.2 ! misho 2104: HAVE_DOT = NO
1.1 misho 2105:
1.1.1.2 ! misho 2106: # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
! 2107: # to run in parallel. When set to 0 doxygen will base this on the number of
! 2108: # processors available in the system. You can set it explicitly to a value
! 2109: # larger than 0 to get control over the balance between CPU load and processing
! 2110: # speed.
! 2111: # Minimum value: 0, maximum value: 32, default value: 0.
! 2112: # This tag requires that the tag HAVE_DOT is set to YES.
! 2113:
! 2114: DOT_NUM_THREADS = 0
! 2115:
! 2116: # When you want a differently looking font in the dot files that doxygen
! 2117: # generates you can specify the font name using DOT_FONTNAME. You need to make
! 2118: # sure dot is able to find the font, which can be done by putting it in a
! 2119: # standard location or by setting the DOTFONTPATH environment variable or by
! 2120: # setting DOT_FONTPATH to the directory containing the font.
! 2121: # The default value is: Helvetica.
! 2122: # This tag requires that the tag HAVE_DOT is set to YES.
! 2123:
! 2124: DOT_FONTNAME = Helvetica
! 2125:
! 2126: # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
! 2127: # dot graphs.
! 2128: # Minimum value: 4, maximum value: 24, default value: 10.
! 2129: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2130:
2131: DOT_FONTSIZE = 10
2132:
1.1.1.2 ! misho 2133: # By default doxygen will tell dot to use the default font as specified with
! 2134: # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
! 2135: # the path where dot can find it using this tag.
! 2136: # This tag requires that the tag HAVE_DOT is set to YES.
! 2137:
! 2138: DOT_FONTPATH =
! 2139:
! 2140: # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
! 2141: # each documented class showing the direct and indirect inheritance relations.
! 2142: # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
! 2143: # The default value is: YES.
! 2144: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2145:
2146: CLASS_GRAPH = YES
2147:
1.1.1.2 ! misho 2148: # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
! 2149: # graph for each documented class showing the direct and indirect implementation
! 2150: # dependencies (inheritance, containment, and class references variables) of the
! 2151: # class with other documented classes.
! 2152: # The default value is: YES.
! 2153: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2154:
2155: COLLABORATION_GRAPH = YES
2156:
1.1.1.2 ! misho 2157: # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
! 2158: # groups, showing the direct groups dependencies.
! 2159: # The default value is: YES.
! 2160: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2161:
2162: GROUP_GRAPHS = YES
2163:
1.1.1.2 ! misho 2164: # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
! 2165: # collaboration diagrams in a style similar to the OMG's Unified Modeling
1.1 misho 2166: # Language.
1.1.1.2 ! misho 2167: # The default value is: NO.
! 2168: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2169:
2170: UML_LOOK = NO
2171:
1.1.1.2 ! misho 2172: # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
! 2173: # class node. If there are many fields or methods and many nodes the graph may
! 2174: # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
! 2175: # number of items for each type to make the size more manageable. Set this to 0
! 2176: # for no limit. Note that the threshold may be exceeded by 50% before the limit
! 2177: # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
! 2178: # but if the number exceeds 15, the total amount of fields shown is limited to
! 2179: # 10.
! 2180: # Minimum value: 0, maximum value: 100, default value: 10.
! 2181: # This tag requires that the tag HAVE_DOT is set to YES.
! 2182:
! 2183: UML_LIMIT_NUM_FIELDS = 10
! 2184:
! 2185: # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
! 2186: # collaboration graphs will show the relations between templates and their
! 2187: # instances.
! 2188: # The default value is: NO.
! 2189: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2190:
2191: TEMPLATE_RELATIONS = YES
2192:
1.1.1.2 ! misho 2193: # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
! 2194: # YES then doxygen will generate a graph for each documented file showing the
! 2195: # direct and indirect include dependencies of the file with other documented
! 2196: # files.
! 2197: # The default value is: YES.
! 2198: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2199:
2200: INCLUDE_GRAPH = YES
2201:
1.1.1.2 ! misho 2202: # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
! 2203: # set to YES then doxygen will generate a graph for each documented file showing
! 2204: # the direct and indirect include dependencies of the file with other documented
! 2205: # files.
! 2206: # The default value is: YES.
! 2207: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2208:
2209: INCLUDED_BY_GRAPH = YES
2210:
1.1.1.2 ! misho 2211: # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
! 2212: # dependency graph for every global function or class method.
! 2213: #
! 2214: # Note that enabling this option will significantly increase the time of a run.
! 2215: # So in most cases it will be better to enable call graphs for selected
! 2216: # functions only using the \callgraph command.
! 2217: # The default value is: NO.
! 2218: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2219:
2220: CALL_GRAPH = NO
2221:
1.1.1.2 ! misho 2222: # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
! 2223: # dependency graph for every global function or class method.
! 2224: #
! 2225: # Note that enabling this option will significantly increase the time of a run.
! 2226: # So in most cases it will be better to enable caller graphs for selected
! 2227: # functions only using the \callergraph command.
! 2228: # The default value is: NO.
! 2229: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2230:
2231: CALLER_GRAPH = NO
2232:
1.1.1.2 ! misho 2233: # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
! 2234: # hierarchy of all classes instead of a textual one.
! 2235: # The default value is: YES.
! 2236: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2237:
2238: GRAPHICAL_HIERARCHY = YES
2239:
1.1.1.2 ! misho 2240: # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
! 2241: # dependencies a directory has on other directories in a graphical way. The
! 2242: # dependency relations are determined by the #include relations between the
! 2243: # files in the directories.
! 2244: # The default value is: YES.
! 2245: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2246:
2247: DIRECTORY_GRAPH = YES
2248:
1.1.1.2 ! misho 2249: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
! 2250: # generated by dot.
! 2251: # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
! 2252: # to make the SVG files visible in IE 9+ (other browsers do not have this
! 2253: # requirement).
! 2254: # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
! 2255: # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
! 2256: # gif:cairo:gd, gif:gd, gif:gd:gd and svg.
! 2257: # The default value is: png.
! 2258: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2259:
2260: DOT_IMAGE_FORMAT = png
2261:
1.1.1.2 ! misho 2262: # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
! 2263: # enable generation of interactive SVG images that allow zooming and panning.
! 2264: #
! 2265: # Note that this requires a modern browser other than Internet Explorer. Tested
! 2266: # and working are Firefox, Chrome, Safari, and Opera.
! 2267: # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
! 2268: # the SVG files visible. Older versions of IE do not have SVG support.
! 2269: # The default value is: NO.
! 2270: # This tag requires that the tag HAVE_DOT is set to YES.
! 2271:
! 2272: INTERACTIVE_SVG = NO
! 2273:
! 2274: # The DOT_PATH tag can be used to specify the path where the dot tool can be
1.1 misho 2275: # found. If left blank, it is assumed the dot tool can be found in the path.
1.1.1.2 ! misho 2276: # This tag requires that the tag HAVE_DOT is set to YES.
! 2277:
! 2278: DOT_PATH =
! 2279:
! 2280: # The DOTFILE_DIRS tag can be used to specify one or more directories that
! 2281: # contain dot files that are included in the documentation (see the \dotfile
! 2282: # command).
! 2283: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2284:
1.1.1.2 ! misho 2285: DOTFILE_DIRS =
1.1 misho 2286:
1.1.1.2 ! misho 2287: # The MSCFILE_DIRS tag can be used to specify one or more directories that
! 2288: # contain msc files that are included in the documentation (see the \mscfile
! 2289: # command).
! 2290:
! 2291: MSCFILE_DIRS =
! 2292:
! 2293: # The DIAFILE_DIRS tag can be used to specify one or more directories that
! 2294: # contain dia files that are included in the documentation (see the \diafile
! 2295: # command).
! 2296:
! 2297: DIAFILE_DIRS =
! 2298:
! 2299: # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
! 2300: # path where java can find the plantuml.jar file. If left blank, it is assumed
! 2301: # PlantUML is not used or called during a preprocessing step. Doxygen will
! 2302: # generate a warning when it encounters a \startuml command in this case and
! 2303: # will not generate output for the diagram.
! 2304:
! 2305: PLANTUML_JAR_PATH =
! 2306:
! 2307: # When using plantuml, the specified paths are searched for files specified by
! 2308: # the !include statement in a plantuml block.
! 2309:
! 2310: PLANTUML_INCLUDE_PATH =
! 2311:
! 2312: # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
! 2313: # that will be shown in the graph. If the number of nodes in a graph becomes
! 2314: # larger than this value, doxygen will truncate the graph, which is visualized
! 2315: # by representing a node as a red box. Note that doxygen if the number of direct
! 2316: # children of the root node in a graph is already larger than
! 2317: # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
! 2318: # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
! 2319: # Minimum value: 0, maximum value: 10000, default value: 50.
! 2320: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2321:
2322: DOT_GRAPH_MAX_NODES = 50
2323:
1.1.1.2 ! misho 2324: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
! 2325: # generated by dot. A depth value of 3 means that only nodes reachable from the
! 2326: # root by following a path via at most 3 edges will be shown. Nodes that lay
! 2327: # further from the root node will be omitted. Note that setting this option to 1
! 2328: # or 2 may greatly reduce the computation time needed for large code bases. Also
! 2329: # note that the size of a graph can be further restricted by
1.1 misho 2330: # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1.1.1.2 ! misho 2331: # Minimum value: 0, maximum value: 1000, default value: 0.
! 2332: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2333:
2334: MAX_DOT_GRAPH_DEPTH = 0
2335:
1.1.1.2 ! misho 2336: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
! 2337: # background. This is disabled by default, because dot on Windows does not seem
! 2338: # to support this out of the box.
! 2339: #
! 2340: # Warning: Depending on the platform used, enabling this option may lead to
! 2341: # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
! 2342: # read).
! 2343: # The default value is: NO.
! 2344: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2345:
2346: DOT_TRANSPARENT = NO
2347:
1.1.1.2 ! misho 2348: # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
! 2349: # files in one run (i.e. multiple -o and -T options on the command line). This
! 2350: # makes dot run faster, but since only newer versions of dot (>1.8.10) support
! 2351: # this, this feature is disabled by default.
! 2352: # The default value is: NO.
! 2353: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2354:
2355: DOT_MULTI_TARGETS = NO
2356:
1.1.1.2 ! misho 2357: # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
! 2358: # explaining the meaning of the various boxes and arrows in the dot generated
! 2359: # graphs.
! 2360: # The default value is: YES.
! 2361: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2362:
2363: GENERATE_LEGEND = YES
2364:
1.1.1.2 ! misho 2365: # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
! 2366: # files that are used to generate the various graphs.
! 2367: # The default value is: YES.
! 2368: # This tag requires that the tag HAVE_DOT is set to YES.
1.1 misho 2369:
2370: DOT_CLEANUP = YES
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to Doxyfile.in CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / confuse / doc