1# Doxyfile 1.8.9 2 3# This file describes the settings to be used by the documentation system 4# doxygen (www.doxygen.org) for a project. 5# 6# All text after a 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. 10# The format is: 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 (\" \"). 15 16#--------------------------------------------------------------------------- 17# Project related configuration options 18#--------------------------------------------------------------------------- 19 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. 26 27DOXYFILE_ENCODING = UTF-8 28 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. 34 35PROJECT_NAME = @PACKAGE_NAME@ 36 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. 40 41PROJECT_NUMBER = @PACKAGE_VERSION@ 42 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 47PROJECT_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 54PROJECT_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 61OUTPUT_DIRECTORY = doxydoc 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. 70 71CREATE_SUBDIRS = NO 72 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 79ALLOW_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. 93 94OUTPUT_LANGUAGE = English 95 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. 100 101BRIEF_MEMBER_DESC = YES 102 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 107# brief descriptions will be completely suppressed. 108# The default value is: YES. 109 110REPEAT_BRIEF = YES 111 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. 120 121ABBREVIATE_BRIEF = 122 123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124# doxygen will generate a detailed section even if there is only a brief 125# description. 126# The default value is: NO. 127 128ALWAYS_DETAILED_SEC = NO 129 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 133# operators of the base classes will not be shown. 134# The default value is: NO. 135 136INLINE_INHERITED_MEMB = NO 137 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. 142 143FULL_PATH_NAMES = YES 144 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 155STRIP_FROM_PATH = "@abs_top_srcdir@/src" 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 164STRIP_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. 170 171SHORT_NAMES = NO 172 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. 179 180JAVADOC_AUTOBRIEF = YES 181 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. 187 188QT_AUTOBRIEF = YES 189 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. 199 200MULTILINE_CPP_IS_BRIEF = NO 201 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. 205 206INHERIT_DOCS = YES 207 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. 212 213SEPARATE_MEMBER_PAGES = NO 214 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. 218 219TAB_SIZE = 8 220 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 231ALIASES = 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 237TCL_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. 244 245OPTIMIZE_OUTPUT_FOR_C = NO 246 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. 252 253OPTIMIZE_OUTPUT_JAVA = NO 254 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. 258 259OPTIMIZE_FOR_FORTRAN = NO 260 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. 264 265OPTIMIZE_OUTPUT_VHDL = NO 266 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 284EXTENSION_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 294MARKDOWN_SUPPORT = YES 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 302AUTOLINK_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 309# diagrams that involve STL classes more complete and accurate. 310# The default value is: NO. 311 312BUILTIN_STL_SUPPORT = YES 313 314# If you use Microsoft's C++/CLI language, you should set this option to YES to 315# enable parsing support. 316# The default value is: NO. 317 318CPP_CLI_SUPPORT = NO 319 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. 325 326SIP_SUPPORT = NO 327 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. 335 336IDL_PROPERTY_SUPPORT = YES 337 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 341# all members of a group must be documented explicitly. 342# The default value is: NO. 343 344DISTRIBUTE_GROUP_DOC = NO 345 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. 352 353SUBGROUPING = YES 354 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 364INLINE_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 374INLINE_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 382# types are typedef'ed and only the typedef is referenced, never the tag name. 383# The default value is: NO. 384 385TYPEDEF_HIDES_STRUCT = NO 386 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. 397 398LOOKUP_CACHE_SIZE = 0 399 400#--------------------------------------------------------------------------- 401# Build related configuration options 402#--------------------------------------------------------------------------- 403 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. 411 412EXTRACT_ALL = YES 413 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. 417 418EXTRACT_PRIVATE = YES 419 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 424EXTRACT_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. 429 430EXTRACT_STATIC = YES 431 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. 437 438EXTRACT_LOCAL_CLASSES = YES 439 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. 445 446EXTRACT_LOCAL_METHODS = NO 447 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. 454 455EXTRACT_ANON_NSPACES = YES 456 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. 462 463HIDE_UNDOC_MEMBERS = NO 464 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. 470 471HIDE_UNDOC_CLASSES = NO 472 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. 477 478HIDE_FRIEND_COMPOUNDS = NO 479 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. 484 485HIDE_IN_BODY_DOCS = NO 486 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. 491 492INTERNAL_DOCS = NO 493 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 498# and Mac users are advised to set this option to NO. 499# The default value is: system dependent. 500 501CASE_SENSE_NAMES = YES 502 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. 507 508HIDE_SCOPE_NAMES = NO 509 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 515HIDE_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. 520 521SHOW_INCLUDE_FILES = YES 522 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 528SHOW_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 534FORCE_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. 539 540INLINE_INFO = YES 541 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. 546 547SORT_MEMBER_DOCS = NO 548 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. 554 555SORT_BRIEF_DOCS = NO 556 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 567SORT_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. 573 574SORT_GROUP_NAMES = NO 575 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. 583 584SORT_BY_SCOPE_NAME = NO 585 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 594STRICT_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. 599 600GENERATE_TODOLIST = YES 601 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. 605 606GENERATE_TESTLIST = YES 607 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. 611 612GENERATE_BUGLIST = YES 613 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. 618 619GENERATE_DEPRECATEDLIST= YES 620 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 625ENABLED_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. 635 636MAX_INITIALIZER_LINES = 30 637 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 640# list will mention the files that were used to generate the documentation. 641# The default value is: YES. 642 643SHOW_USED_FILES = YES 644 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. 649 650SHOW_FILES = YES 651 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. 656 657SHOW_NAMESPACES = YES 658 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 667FILE_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. 679 680LAYOUT_FILE = 681 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. 689 690CITE_BIB_FILES = 691 692#--------------------------------------------------------------------------- 693# Configuration options related to warning and progress messages 694#--------------------------------------------------------------------------- 695 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. 700 701QUIET = NO 702 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. 709 710WARNINGS = YES 711 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. 716 717WARN_IF_UNDOCUMENTED = YES 718 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. 724 725WARN_IF_DOC_ERROR = YES 726 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. 732 733WARN_NO_PARAMDOC = NO 734 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. 742 743WARN_FORMAT = "$file:$line: $text" 744 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). 748 749WARN_LOGFILE = @coin_doxy_logname@ 750 751#--------------------------------------------------------------------------- 752# Configuration options related to the input files 753#--------------------------------------------------------------------------- 754 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. 760 761INPUT = @abs_top_srcdir@/src 762 763# This tag can be used to specify the character encoding of the source files 764# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 765# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 766# documentation (see: http://www.gnu.org/software/libiconv) for the list of 767# possible encodings. 768# The default value is: UTF-8. 769 770INPUT_ENCODING = UTF-8 771 772# If the value of the INPUT tag contains directories, you can use the 773# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 774# *.h) to filter out the source-files in the directories. If left blank the 775# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 776# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 777# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 778# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 779# *.qsf, *.as and *.js. 780 781FILE_PATTERNS = *.hpp \ 782 *.h 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. 787 788RECURSIVE = YES 789 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 792# subdirectory from a directory tree whose root is specified with the INPUT tag. 793# 794# Note that relative paths are relative to the directory from which doxygen is 795# run. 796 797EXCLUDE = 798 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 801# from the input. 802# The default value is: NO. 803 804EXCLUDE_SYMLINKS = NO 805 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 813EXCLUDE_PATTERNS = */.svn* 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, 819# AClass::ANamespace, ANamespace::*Test 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/* 823 824EXCLUDE_SYMBOLS = 825 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). 829 830EXAMPLE_PATH = 831 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 837EXAMPLE_PATTERNS = 838 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. 843 844EXAMPLE_RECURSIVE = NO 845 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 850IMAGE_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 867INPUT_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 876FILTER_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. 882 883FILTER_SOURCE_FILES = NO 884 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 891FILTER_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 898USE_MDFILE_AS_MAINPAGE = 899 900#--------------------------------------------------------------------------- 901# Configuration options related to source browsing 902#--------------------------------------------------------------------------- 903 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. 910 911SOURCE_BROWSER = YES 912 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. 916 917INLINE_SOURCES = NO 918 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. 923 924STRIP_CODE_COMMENTS = YES 925 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. 929 930REFERENCED_BY_RELATION = NO 931 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. 935 936REFERENCES_RELATION = NO 937 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. 943 944REFERENCES_LINK_SOURCE = YES 945 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 954SOURCE_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. 975 976USE_HTAGS = NO 977 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. 983 984VERBATIM_HEADERS = YES 985 986#--------------------------------------------------------------------------- 987# Configuration options related to the alphabetical class index 988#--------------------------------------------------------------------------- 989 990# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 991# compounds will be generated. Enable this if the project contains a lot of 992# classes, structs, unions or interfaces. 993# The default value is: YES. 994 995ALPHABETICAL_INDEX = YES 996 997# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 998# which the alphabetical index list will be split. 999# Minimum value: 1, maximum value: 20, default value: 5. 1000# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1001 1002COLS_IN_ALPHA_INDEX = 3 1003 1004# In case all classes in a project start with a common prefix, all classes will 1005# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1006# can be used to specify a prefix (or a list of prefixes) that should be ignored 1007# while generating the index headers. 1008# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1009 1010IGNORE_PREFIX = 1011 1012#--------------------------------------------------------------------------- 1013# Configuration options related to the HTML output 1014#--------------------------------------------------------------------------- 1015 1016# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1017# The default value is: YES. 1018 1019GENERATE_HTML = YES 1020 1021# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1022# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1023# it. 1024# The default directory is: html. 1025# This tag requires that the tag GENERATE_HTML is set to YES. 1026 1027HTML_OUTPUT = html 1028 1029# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1030# generated HTML page (for example: .htm, .php, .asp). 1031# The default value is: .html. 1032# This tag requires that the tag GENERATE_HTML is set to YES. 1033 1034HTML_FILE_EXTENSION = .html 1035 1036# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1037# each generated HTML page. If the tag is left blank doxygen will generate a 1038# standard header. 1039# 1040# To get valid HTML the header file that includes any scripts and style sheets 1041# that doxygen needs, which is dependent on the configuration options used (e.g. 1042# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1043# default header using 1044# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1045# YourConfigFile 1046# and then modify the file new_header.html. See also section "Doxygen usage" 1047# for information on how to generate the default header that doxygen normally 1048# uses. 1049# Note: The header is subject to change so you typically have to regenerate the 1050# default header when upgrading to a newer version of doxygen. For a description 1051# of the possible markers and block names see the documentation. 1052# This tag requires that the tag GENERATE_HTML is set to YES. 1053 1054HTML_HEADER = 1055 1056# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1057# generated HTML page. If the tag is left blank doxygen will generate a standard 1058# footer. See HTML_HEADER for more information on how to generate a default 1059# footer and what special commands can be used inside the footer. See also 1060# section "Doxygen usage" for information on how to generate the default footer 1061# that doxygen normally uses. 1062# This tag requires that the tag GENERATE_HTML is set to YES. 1063 1064HTML_FOOTER = 1065 1066# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1067# sheet that is used by each HTML page. It can be used to fine-tune the look of 1068# the HTML output. If left blank doxygen will generate a default style sheet. 1069# See also section "Doxygen usage" for information on how to generate the style 1070# sheet that doxygen normally uses. 1071# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1072# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1073# obsolete. 1074# This tag requires that the tag GENERATE_HTML is set to YES. 1075 1076HTML_STYLESHEET = 1077 1078# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1079# cascading style sheets that are included after the standard style sheets 1080# created by doxygen. Using this option one can overrule certain style aspects. 1081# This is preferred over using HTML_STYLESHEET since it does not replace the 1082# standard style sheet and is therefore more robust against future updates. 1083# Doxygen will copy the style sheet files to the output directory. 1084# Note: The order of the extra style sheet files is of importance (e.g. the last 1085# style sheet in the list overrules the setting of the previous ones in the 1086# list). For an example see the documentation. 1087# This tag requires that the tag GENERATE_HTML is set to YES. 1088 1089HTML_EXTRA_STYLESHEET = 1090 1091# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1092# other source files which should be copied to the HTML output directory. Note 1093# that these files will be copied to the base HTML output directory. Use the 1094# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1095# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1096# files will be copied as-is; there are no commands or markers available. 1097# This tag requires that the tag GENERATE_HTML is set to YES. 1098 1099HTML_EXTRA_FILES = 1100 1101# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1102# will adjust the colors in the style sheet and background images according to 1103# this color. Hue is specified as an angle on a colorwheel, see 1104# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1105# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1106# purple, and 360 is red again. 1107# Minimum value: 0, maximum value: 359, default value: 220. 1108# This tag requires that the tag GENERATE_HTML is set to YES. 1109 1110HTML_COLORSTYLE_HUE = 220 1111 1112# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1113# in the HTML output. For a value of 0 the output will use grayscales only. A 1114# value of 255 will produce the most vivid colors. 1115# Minimum value: 0, maximum value: 255, default value: 100. 1116# This tag requires that the tag GENERATE_HTML is set to YES. 1117 1118HTML_COLORSTYLE_SAT = 100 1119 1120# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1121# luminance component of the colors in the HTML output. Values below 100 1122# gradually make the output lighter, whereas values above 100 make the output 1123# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1124# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1125# change the gamma. 1126# Minimum value: 40, maximum value: 240, default value: 80. 1127# This tag requires that the tag GENERATE_HTML is set to YES. 1128 1129HTML_COLORSTYLE_GAMMA = 80 1130 1131# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1132# page will contain the date and time when the page was generated. Setting this 1133# to NO can help when comparing the output of multiple runs. 1134# The default value is: YES. 1135# This tag requires that the tag GENERATE_HTML is set to YES. 1136 1137HTML_TIMESTAMP = YES 1138 1139# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1140# documentation will contain sections that can be hidden and shown after the 1141# page has loaded. 1142# The default value is: NO. 1143# This tag requires that the tag GENERATE_HTML is set to YES. 1144 1145HTML_DYNAMIC_SECTIONS = YES 1146 1147# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1148# shown in the various tree structured indices initially; the user can expand 1149# and collapse entries dynamically later on. Doxygen will expand the tree to 1150# such a level that at most the specified number of entries are visible (unless 1151# a fully collapsed tree already exceeds this amount). So setting the number of 1152# entries 1 will produce a full collapsed tree by default. 0 is a special value 1153# representing an infinite number of entries and will result in a full expanded 1154# tree by default. 1155# Minimum value: 0, maximum value: 9999, default value: 100. 1156# This tag requires that the tag GENERATE_HTML is set to YES. 1157 1158HTML_INDEX_NUM_ENTRIES = 100 1159 1160# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1161# generated that can be used as input for Apple's Xcode 3 integrated development 1162# environment (see: http://developer.apple.com/tools/xcode/), introduced with 1163# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1164# Makefile in the HTML output directory. Running make will produce the docset in 1165# that directory and running make install will install the docset in 1166# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1167# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1168# for more information. 1169# The default value is: NO. 1170# This tag requires that the tag GENERATE_HTML is set to YES. 1171 1172GENERATE_DOCSET = NO 1173 1174# This tag determines the name of the docset feed. A documentation feed provides 1175# an umbrella under which multiple documentation sets from a single provider 1176# (such as a company or product suite) can be grouped. 1177# The default value is: Doxygen generated docs. 1178# This tag requires that the tag GENERATE_DOCSET is set to YES. 1179 1180DOCSET_FEEDNAME = "Doxygen generated docs" 1181 1182# This tag specifies a string that should uniquely identify the documentation 1183# set bundle. This should be a reverse domain-name style string, e.g. 1184# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1185# The default value is: org.doxygen.Project. 1186# This tag requires that the tag GENERATE_DOCSET is set to YES. 1187 1188DOCSET_BUNDLE_ID = org.doxygen.Project 1189 1190# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1191# the documentation publisher. This should be a reverse domain-name style 1192# string, e.g. com.mycompany.MyDocSet.documentation. 1193# The default value is: org.doxygen.Publisher. 1194# This tag requires that the tag GENERATE_DOCSET is set to YES. 1195 1196DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1197 1198# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1199# The default value is: Publisher. 1200# This tag requires that the tag GENERATE_DOCSET is set to YES. 1201 1202DOCSET_PUBLISHER_NAME = Publisher 1203 1204# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1205# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1206# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1207# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1208# Windows. 1209# 1210# The HTML Help Workshop contains a compiler that can convert all HTML output 1211# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1212# files are now used as the Windows 98 help format, and will replace the old 1213# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1214# HTML files also contain an index, a table of contents, and you can search for 1215# words in the documentation. The HTML workshop also contains a viewer for 1216# compressed HTML files. 1217# The default value is: NO. 1218# This tag requires that the tag GENERATE_HTML is set to YES. 1219 1220GENERATE_HTMLHELP = NO 1221 1222# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1223# file. You can add a path in front of the file if the result should not be 1224# written to the html output directory. 1225# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1226 1227CHM_FILE = 1228 1229# The HHC_LOCATION tag can be used to specify the location (absolute path 1230# including file name) of the HTML help compiler (hhc.exe). If non-empty, 1231# doxygen will try to run the HTML help compiler on the generated index.hhp. 1232# The file has to be specified with full path. 1233# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1234 1235HHC_LOCATION = 1236 1237# The GENERATE_CHI flag controls if a separate .chi index file is generated 1238# (YES) or that it should be included in the master .chm file (NO). 1239# The default value is: NO. 1240# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1241 1242GENERATE_CHI = NO 1243 1244# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1245# and project file content. 1246# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1247 1248CHM_INDEX_ENCODING = 1249 1250# The BINARY_TOC flag controls whether a binary table of contents is generated 1251# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1252# enables the Previous and Next buttons. 1253# The default value is: NO. 1254# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1255 1256BINARY_TOC = NO 1257 1258# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1259# the table of contents of the HTML help documentation and to the tree view. 1260# The default value is: NO. 1261# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1262 1263TOC_EXPAND = NO 1264 1265# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1266# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1267# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1268# (.qch) of the generated HTML documentation. 1269# The default value is: NO. 1270# This tag requires that the tag GENERATE_HTML is set to YES. 1271 1272GENERATE_QHP = NO 1273 1274# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1275# the file name of the resulting .qch file. The path specified is relative to 1276# the HTML output folder. 1277# This tag requires that the tag GENERATE_QHP is set to YES. 1278 1279QCH_FILE = 1280 1281# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1282# Project output. For more information please see Qt Help Project / Namespace 1283# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1284# The default value is: org.doxygen.Project. 1285# This tag requires that the tag GENERATE_QHP is set to YES. 1286 1287QHP_NAMESPACE = 1288 1289# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1290# Help Project output. For more information please see Qt Help Project / Virtual 1291# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1292# folders). 1293# The default value is: doc. 1294# This tag requires that the tag GENERATE_QHP is set to YES. 1295 1296QHP_VIRTUAL_FOLDER = doc 1297 1298# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1299# filter to add. For more information please see Qt Help Project / Custom 1300# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1301# filters). 1302# This tag requires that the tag GENERATE_QHP is set to YES. 1303 1304QHP_CUST_FILTER_NAME = 1305 1306# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1307# custom filter to add. For more information please see Qt Help Project / Custom 1308# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1309# filters). 1310# This tag requires that the tag GENERATE_QHP is set to YES. 1311 1312QHP_CUST_FILTER_ATTRS = 1313 1314# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1315# project's filter section matches. Qt Help Project / Filter Attributes (see: 1316# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1317# This tag requires that the tag GENERATE_QHP is set to YES. 1318 1319QHP_SECT_FILTER_ATTRS = 1320 1321# The QHG_LOCATION tag can be used to specify the location of Qt's 1322# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1323# generated .qhp file. 1324# This tag requires that the tag GENERATE_QHP is set to YES. 1325 1326QHG_LOCATION = 1327 1328# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1329# generated, together with the HTML files, they form an Eclipse help plugin. To 1330# install this plugin and make it available under the help contents menu in 1331# Eclipse, the contents of the directory containing the HTML and XML files needs 1332# to be copied into the plugins directory of eclipse. The name of the directory 1333# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1334# After copying Eclipse needs to be restarted before the help appears. 1335# The default value is: NO. 1336# This tag requires that the tag GENERATE_HTML is set to YES. 1337 1338GENERATE_ECLIPSEHELP = NO 1339 1340# A unique identifier for the Eclipse help plugin. When installing the plugin 1341# the directory name containing the HTML and XML files should also have this 1342# name. Each documentation set should have its own identifier. 1343# The default value is: org.doxygen.Project. 1344# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1345 1346ECLIPSE_DOC_ID = org.doxygen.Project 1347 1348# If you want full control over the layout of the generated HTML pages it might 1349# be necessary to disable the index and replace it with your own. The 1350# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1351# of each HTML page. A value of NO enables the index and the value YES disables 1352# it. Since the tabs in the index contain the same information as the navigation 1353# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1354# The default value is: NO. 1355# This tag requires that the tag GENERATE_HTML is set to YES. 1356 1357DISABLE_INDEX = NO 1358 1359# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1360# structure should be generated to display hierarchical information. If the tag 1361# value is set to YES, a side panel will be generated containing a tree-like 1362# index structure (just like the one that is generated for HTML Help). For this 1363# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1364# (i.e. any modern browser). Windows users are probably better off using the 1365# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1366# further fine-tune the look of the index. As an example, the default style 1367# sheet generated by doxygen has an example that shows how to put an image at 1368# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1369# the same information as the tab index, you could consider setting 1370# DISABLE_INDEX to YES when enabling this option. 1371# The default value is: NO. 1372# This tag requires that the tag GENERATE_HTML is set to YES. 1373 1374GENERATE_TREEVIEW = NO 1375 1376# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1377# doxygen will group on one line in the generated HTML documentation. 1378# 1379# Note that a value of 0 will completely suppress the enum values from appearing 1380# in the overview section. 1381# Minimum value: 0, maximum value: 20, default value: 4. 1382# This tag requires that the tag GENERATE_HTML is set to YES. 1383 1384ENUM_VALUES_PER_LINE = 4 1385 1386# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1387# to set the initial width (in pixels) of the frame in which the tree is shown. 1388# Minimum value: 0, maximum value: 1500, default value: 250. 1389# This tag requires that the tag GENERATE_HTML is set to YES. 1390 1391TREEVIEW_WIDTH = 250 1392 1393# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1394# external symbols imported via tag files in a separate window. 1395# The default value is: NO. 1396# This tag requires that the tag GENERATE_HTML is set to YES. 1397 1398EXT_LINKS_IN_WINDOW = NO 1399 1400# Use this tag to change the font size of LaTeX formulas included as images in 1401# the HTML documentation. When you change the font size after a successful 1402# doxygen run you need to manually remove any form_*.png images from the HTML 1403# output directory to force them to be regenerated. 1404# Minimum value: 8, maximum value: 50, default value: 10. 1405# This tag requires that the tag GENERATE_HTML is set to YES. 1406 1407FORMULA_FONTSIZE = 10 1408 1409# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1410# generated for formulas are transparent PNGs. Transparent PNGs are not 1411# supported properly for IE 6.0, but are supported on all modern browsers. 1412# 1413# Note that when changing this option you need to delete any form_*.png files in 1414# the HTML output directory before the changes have effect. 1415# The default value is: YES. 1416# This tag requires that the tag GENERATE_HTML is set to YES. 1417 1418FORMULA_TRANSPARENT = YES 1419 1420# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1421# http://www.mathjax.org) which uses client side Javascript for the rendering 1422# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1423# installed or if you want to formulas look prettier in the HTML output. When 1424# enabled you may also need to install MathJax separately and configure the path 1425# to it using the MATHJAX_RELPATH option. 1426# The default value is: NO. 1427# This tag requires that the tag GENERATE_HTML is set to YES. 1428 1429USE_MATHJAX = NO 1430 1431# When MathJax is enabled you can set the default output format to be used for 1432# the MathJax output. See the MathJax site (see: 1433# http://docs.mathjax.org/en/latest/output.html) for more details. 1434# Possible values are: HTML-CSS (which is slower, but has the best 1435# compatibility), NativeMML (i.e. MathML) and SVG. 1436# The default value is: HTML-CSS. 1437# This tag requires that the tag USE_MATHJAX is set to YES. 1438 1439MATHJAX_FORMAT = HTML-CSS 1440 1441# When MathJax is enabled you need to specify the location relative to the HTML 1442# output directory using the MATHJAX_RELPATH option. The destination directory 1443# should contain the MathJax.js script. For instance, if the mathjax directory 1444# is located at the same level as the HTML output directory, then 1445# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1446# Content Delivery Network so you can quickly see the result without installing 1447# MathJax. However, it is strongly recommended to install a local copy of 1448# MathJax from http://www.mathjax.org before deployment. 1449# The default value is: http://cdn.mathjax.org/mathjax/latest. 1450# This tag requires that the tag USE_MATHJAX is set to YES. 1451 1452MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1453 1454# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1455# extension names that should be enabled during MathJax rendering. For example 1456# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1457# This tag requires that the tag USE_MATHJAX is set to YES. 1458 1459MATHJAX_EXTENSIONS = 1460 1461# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1462# of code that will be used on startup of the MathJax code. See the MathJax site 1463# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1464# example see the documentation. 1465# This tag requires that the tag USE_MATHJAX is set to YES. 1466 1467MATHJAX_CODEFILE = 1468 1469# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1470# the HTML output. The underlying search engine uses javascript and DHTML and 1471# should work on any modern browser. Note that when using HTML help 1472# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1473# there is already a search function so this one should typically be disabled. 1474# For large projects the javascript based search engine can be slow, then 1475# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1476# search using the keyboard; to jump to the search box use <access key> + S 1477# (what the <access key> is depends on the OS and browser, but it is typically 1478# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1479# key> to jump into the search results window, the results can be navigated 1480# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1481# the search. The filter options can be selected when the cursor is inside the 1482# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1483# to select a filter and <Enter> or <escape> to activate or cancel the filter 1484# option. 1485# The default value is: YES. 1486# This tag requires that the tag GENERATE_HTML is set to YES. 1487 1488SEARCHENGINE = YES 1489 1490# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1491# implemented using a web server instead of a web client using Javascript. There 1492# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1493# setting. When disabled, doxygen will generate a PHP script for searching and 1494# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1495# and searching needs to be provided by external tools. See the section 1496# "External Indexing and Searching" for details. 1497# The default value is: NO. 1498# This tag requires that the tag SEARCHENGINE is set to YES. 1499 1500SERVER_BASED_SEARCH = NO 1501 1502# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1503# script for searching. Instead the search results are written to an XML file 1504# which needs to be processed by an external indexer. Doxygen will invoke an 1505# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1506# search results. 1507# 1508# Doxygen ships with an example indexer (doxyindexer) and search engine 1509# (doxysearch.cgi) which are based on the open source search engine library 1510# Xapian (see: http://xapian.org/). 1511# 1512# See the section "External Indexing and Searching" for details. 1513# The default value is: NO. 1514# This tag requires that the tag SEARCHENGINE is set to YES. 1515 1516EXTERNAL_SEARCH = NO 1517 1518# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1519# which will return the search results when EXTERNAL_SEARCH is enabled. 1520# 1521# Doxygen ships with an example indexer (doxyindexer) and search engine 1522# (doxysearch.cgi) which are based on the open source search engine library 1523# Xapian (see: http://xapian.org/). See the section "External Indexing and 1524# Searching" for details. 1525# This tag requires that the tag SEARCHENGINE is set to YES. 1526 1527SEARCHENGINE_URL = 1528 1529# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1530# search data is written to a file for indexing by an external tool. With the 1531# SEARCHDATA_FILE tag the name of this file can be specified. 1532# The default file is: searchdata.xml. 1533# This tag requires that the tag SEARCHENGINE is set to YES. 1534 1535SEARCHDATA_FILE = searchdata.xml 1536 1537# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1538# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1539# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1540# projects and redirect the results back to the right project. 1541# This tag requires that the tag SEARCHENGINE is set to YES. 1542 1543EXTERNAL_SEARCH_ID = 1544 1545# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1546# projects other than the one defined by this configuration file, but that are 1547# all added to the same external search index. Each project needs to have a 1548# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1549# to a relative location where the documentation can be found. The format is: 1550# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1551# This tag requires that the tag SEARCHENGINE is set to YES. 1552 1553EXTRA_SEARCH_MAPPINGS = 1554 1555#--------------------------------------------------------------------------- 1556# Configuration options related to the LaTeX output 1557#--------------------------------------------------------------------------- 1558 1559# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1560# The default value is: YES. 1561 1562GENERATE_LATEX = NO 1563 1564# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1565# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1566# it. 1567# The default directory is: latex. 1568# This tag requires that the tag GENERATE_LATEX is set to YES. 1569 1570LATEX_OUTPUT = latex 1571 1572# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1573# invoked. 1574# 1575# Note that when enabling USE_PDFLATEX this option is only used for generating 1576# bitmaps for formulas in the HTML output, but not in the Makefile that is 1577# written to the output directory. 1578# The default file is: latex. 1579# This tag requires that the tag GENERATE_LATEX is set to YES. 1580 1581LATEX_CMD_NAME = latex 1582 1583# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1584# index for LaTeX. 1585# The default file is: makeindex. 1586# This tag requires that the tag GENERATE_LATEX is set to YES. 1587 1588MAKEINDEX_CMD_NAME = makeindex 1589 1590# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1591# documents. This may be useful for small projects and may help to save some 1592# trees in general. 1593# The default value is: NO. 1594# This tag requires that the tag GENERATE_LATEX is set to YES. 1595 1596COMPACT_LATEX = YES 1597 1598# The PAPER_TYPE tag can be used to set the paper type that is used by the 1599# printer. 1600# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1601# 14 inches) and executive (7.25 x 10.5 inches). 1602# The default value is: a4. 1603# This tag requires that the tag GENERATE_LATEX is set to YES. 1604 1605PAPER_TYPE = letter 1606 1607# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1608# that should be included in the LaTeX output. To get the times font for 1609# instance you can specify 1610# EXTRA_PACKAGES=times 1611# If left blank no extra packages will be included. 1612# This tag requires that the tag GENERATE_LATEX is set to YES. 1613 1614EXTRA_PACKAGES = 1615 1616# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1617# generated LaTeX document. The header should contain everything until the first 1618# chapter. If it is left blank doxygen will generate a standard header. See 1619# section "Doxygen usage" for information on how to let doxygen write the 1620# default header to a separate file. 1621# 1622# Note: Only use a user-defined header if you know what you are doing! The 1623# following commands have a special meaning inside the header: $title, 1624# $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1625# $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1626# string, for the replacement values of the other commands the user is referred 1627# to HTML_HEADER. 1628# This tag requires that the tag GENERATE_LATEX is set to YES. 1629 1630LATEX_HEADER = 1631 1632# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1633# generated LaTeX document. The footer should contain everything after the last 1634# chapter. If it is left blank doxygen will generate a standard footer. See 1635# LATEX_HEADER for more information on how to generate a default footer and what 1636# special commands can be used inside the footer. 1637# 1638# Note: Only use a user-defined footer if you know what you are doing! 1639# This tag requires that the tag GENERATE_LATEX is set to YES. 1640 1641LATEX_FOOTER = 1642 1643# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1644# LaTeX style sheets that are included after the standard style sheets created 1645# by doxygen. Using this option one can overrule certain style aspects. Doxygen 1646# will copy the style sheet files to the output directory. 1647# Note: The order of the extra style sheet files is of importance (e.g. the last 1648# style sheet in the list overrules the setting of the previous ones in the 1649# list). 1650# This tag requires that the tag GENERATE_LATEX is set to YES. 1651 1652LATEX_EXTRA_STYLESHEET = 1653 1654# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1655# other source files which should be copied to the LATEX_OUTPUT output 1656# directory. Note that the files will be copied as-is; there are no commands or 1657# markers available. 1658# This tag requires that the tag GENERATE_LATEX is set to YES. 1659 1660LATEX_EXTRA_FILES = 1661 1662# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1663# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1664# contain links (just like the HTML output) instead of page references. This 1665# makes the output suitable for online browsing using a PDF viewer. 1666# The default value is: YES. 1667# This tag requires that the tag GENERATE_LATEX is set to YES. 1668 1669PDF_HYPERLINKS = YES 1670 1671# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1672# the PDF file directly from the LaTeX files. Set this option to YES, to get a 1673# higher quality PDF documentation. 1674# The default value is: YES. 1675# This tag requires that the tag GENERATE_LATEX is set to YES. 1676 1677USE_PDFLATEX = YES 1678 1679# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1680# command to the generated LaTeX files. This will instruct LaTeX to keep running 1681# if errors occur, instead of asking the user for help. This option is also used 1682# when generating formulas in HTML. 1683# The default value is: NO. 1684# This tag requires that the tag GENERATE_LATEX is set to YES. 1685 1686LATEX_BATCHMODE = NO 1687 1688# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1689# index chapters (such as File Index, Compound Index, etc.) in the output. 1690# The default value is: NO. 1691# This tag requires that the tag GENERATE_LATEX is set to YES. 1692 1693LATEX_HIDE_INDICES = NO 1694 1695# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1696# code with syntax highlighting in the LaTeX output. 1697# 1698# Note that which sources are shown also depends on other settings such as 1699# SOURCE_BROWSER. 1700# The default value is: NO. 1701# This tag requires that the tag GENERATE_LATEX is set to YES. 1702 1703LATEX_SOURCE_CODE = NO 1704 1705# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1706# bibliography, e.g. plainnat, or ieeetr. See 1707# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1708# The default value is: plain. 1709# This tag requires that the tag GENERATE_LATEX is set to YES. 1710 1711LATEX_BIB_STYLE = plain 1712 1713#--------------------------------------------------------------------------- 1714# Configuration options related to the RTF output 1715#--------------------------------------------------------------------------- 1716 1717# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1718# RTF output is optimized for Word 97 and may not look too pretty with other RTF 1719# readers/editors. 1720# The default value is: NO. 1721 1722GENERATE_RTF = NO 1723 1724# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1725# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1726# it. 1727# The default directory is: rtf. 1728# This tag requires that the tag GENERATE_RTF is set to YES. 1729 1730RTF_OUTPUT = rtf 1731 1732# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 1733# documents. This may be useful for small projects and may help to save some 1734# trees in general. 1735# The default value is: NO. 1736# This tag requires that the tag GENERATE_RTF is set to YES. 1737 1738COMPACT_RTF = NO 1739 1740# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1741# contain hyperlink fields. The RTF file will contain links (just like the HTML 1742# output) instead of page references. This makes the output suitable for online 1743# browsing using Word or some other Word compatible readers that support those 1744# fields. 1745# 1746# Note: WordPad (write) and others do not support links. 1747# The default value is: NO. 1748# This tag requires that the tag GENERATE_RTF is set to YES. 1749 1750RTF_HYPERLINKS = NO 1751 1752# Load stylesheet definitions from file. Syntax is similar to doxygen's config 1753# file, i.e. a series of assignments. You only have to provide replacements, 1754# missing definitions are set to their default value. 1755# 1756# See also section "Doxygen usage" for information on how to generate the 1757# default style sheet that doxygen normally uses. 1758# This tag requires that the tag GENERATE_RTF is set to YES. 1759 1760RTF_STYLESHEET_FILE = 1761 1762# Set optional variables used in the generation of an RTF document. Syntax is 1763# similar to doxygen's config file. A template extensions file can be generated 1764# using doxygen -e rtf extensionFile. 1765# This tag requires that the tag GENERATE_RTF is set to YES. 1766 1767RTF_EXTENSIONS_FILE = 1768 1769# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 1770# with syntax highlighting in the RTF output. 1771# 1772# Note that which sources are shown also depends on other settings such as 1773# SOURCE_BROWSER. 1774# The default value is: NO. 1775# This tag requires that the tag GENERATE_RTF is set to YES. 1776 1777RTF_SOURCE_CODE = NO 1778 1779#--------------------------------------------------------------------------- 1780# Configuration options related to the man page output 1781#--------------------------------------------------------------------------- 1782 1783# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 1784# classes and files. 1785# The default value is: NO. 1786 1787GENERATE_MAN = NO 1788 1789# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1790# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1791# it. A directory man3 will be created inside the directory specified by 1792# MAN_OUTPUT. 1793# The default directory is: man. 1794# This tag requires that the tag GENERATE_MAN is set to YES. 1795 1796MAN_OUTPUT = man 1797 1798# The MAN_EXTENSION tag determines the extension that is added to the generated 1799# man pages. In case the manual section does not start with a number, the number 1800# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1801# optional. 1802# The default value is: .3. 1803# This tag requires that the tag GENERATE_MAN is set to YES. 1804 1805MAN_EXTENSION = .3 1806 1807# The MAN_SUBDIR tag determines the name of the directory created within 1808# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1809# MAN_EXTENSION with the initial . removed. 1810# This tag requires that the tag GENERATE_MAN is set to YES. 1811 1812MAN_SUBDIR = 1813 1814# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1815# will generate one additional man file for each entity documented in the real 1816# man page(s). These additional files only source the real man page, but without 1817# them the man command would be unable to find the correct page. 1818# The default value is: NO. 1819# This tag requires that the tag GENERATE_MAN is set to YES. 1820 1821MAN_LINKS = NO 1822 1823#--------------------------------------------------------------------------- 1824# Configuration options related to the XML output 1825#--------------------------------------------------------------------------- 1826 1827# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 1828# captures the structure of the code including all documentation. 1829# The default value is: NO. 1830 1831GENERATE_XML = NO 1832 1833# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1834# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1835# it. 1836# The default directory is: xml. 1837# This tag requires that the tag GENERATE_XML is set to YES. 1838 1839XML_OUTPUT = xml 1840 1841# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 1842# listings (including syntax highlighting and cross-referencing information) to 1843# the XML output. Note that enabling this will significantly increase the size 1844# of the XML output. 1845# The default value is: YES. 1846# This tag requires that the tag GENERATE_XML is set to YES. 1847 1848XML_PROGRAMLISTING = YES 1849 1850#--------------------------------------------------------------------------- 1851# Configuration options related to the DOCBOOK output 1852#--------------------------------------------------------------------------- 1853 1854# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 1855# that can be used to generate PDF. 1856# The default value is: NO. 1857 1858GENERATE_DOCBOOK = NO 1859 1860# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1861# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1862# front of it. 1863# The default directory is: docbook. 1864# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1865 1866DOCBOOK_OUTPUT = docbook 1867 1868# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 1869# program listings (including syntax highlighting and cross-referencing 1870# information) to the DOCBOOK output. Note that enabling this will significantly 1871# increase the size of the DOCBOOK output. 1872# The default value is: NO. 1873# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1874 1875DOCBOOK_PROGRAMLISTING = NO 1876 1877#--------------------------------------------------------------------------- 1878# Configuration options for the AutoGen Definitions output 1879#--------------------------------------------------------------------------- 1880 1881# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 1882# AutoGen Definitions (see http://autogen.sf.net) file that captures the 1883# structure of the code including all documentation. Note that this feature is 1884# still experimental and incomplete at the moment. 1885# The default value is: NO. 1886 1887GENERATE_AUTOGEN_DEF = NO 1888 1889#--------------------------------------------------------------------------- 1890# Configuration options related to the Perl module output 1891#--------------------------------------------------------------------------- 1892 1893# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 1894# file that captures the structure of the code including all documentation. 1895# 1896# Note that this feature is still experimental and incomplete at the moment. 1897# The default value is: NO. 1898 1899GENERATE_PERLMOD = NO 1900 1901# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 1902# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 1903# output from the Perl module output. 1904# The default value is: NO. 1905# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1906 1907PERLMOD_LATEX = NO 1908 1909# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 1910# formatted so it can be parsed by a human reader. This is useful if you want to 1911# understand what is going on. On the other hand, if this tag is set to NO, the 1912# size of the Perl module output will be much smaller and Perl will parse it 1913# just the same. 1914# The default value is: YES. 1915# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1916 1917PERLMOD_PRETTY = YES 1918 1919# The names of the make variables in the generated doxyrules.make file are 1920# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 1921# so different doxyrules.make files included by the same Makefile don't 1922# overwrite each other's variables. 1923# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1924 1925PERLMOD_MAKEVAR_PREFIX = 1926 1927#--------------------------------------------------------------------------- 1928# Configuration options related to the preprocessor 1929#--------------------------------------------------------------------------- 1930 1931# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 1932# C-preprocessor directives found in the sources and include files. 1933# The default value is: YES. 1934 1935ENABLE_PREPROCESSING = YES 1936 1937# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 1938# in the source code. If set to NO, only conditional compilation will be 1939# performed. Macro expansion can be done in a controlled way by setting 1940# EXPAND_ONLY_PREDEF to YES. 1941# The default value is: NO. 1942# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1943 1944MACRO_EXPANSION = YES 1945 1946# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 1947# the macro expansion is limited to the macros specified with the PREDEFINED and 1948# EXPAND_AS_DEFINED tags. 1949# The default value is: NO. 1950# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1951 1952EXPAND_ONLY_PREDEF = YES 1953 1954# If the SEARCH_INCLUDES tag is set to YES, the include files in the 1955# INCLUDE_PATH will be searched if a #include is found. 1956# The default value is: YES. 1957# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1958 1959SEARCH_INCLUDES = YES 1960 1961# The INCLUDE_PATH tag can be used to specify one or more directories that 1962# contain include files that are not input files but should be processed by the 1963# preprocessor. 1964# This tag requires that the tag SEARCH_INCLUDES is set to YES. 1965 1966INCLUDE_PATH = 1967 1968# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1969# patterns (like *.h and *.hpp) to filter out the header-files in the 1970# directories. If left blank, the patterns specified with FILE_PATTERNS will be 1971# used. 1972# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1973 1974INCLUDE_FILE_PATTERNS = 1975 1976# The PREDEFINED tag can be used to specify one or more macro names that are 1977# defined before the preprocessor is started (similar to the -D option of e.g. 1978# gcc). The argument of the tag is a list of macros of the form: name or 1979# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 1980# is assumed. To prevent a macro definition from being undefined via #undef or 1981# recursively expanded use the := operator instead of the = operator. 1982# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1983 1984PREDEFINED = COIN_HAS_ASL \ 1985 COIN_HAS_BLAS \ 1986 COIN_HAS_HSL \ 1987 COIN_HAS_LAPACK \ 1988 COIN_HAS_MUMPS \ 1989 F77_FUNC(x)=x \ 1990 HAVE_CASSERT \ 1991 HAVE_CCTYPE \ 1992 HAVE_CFLOAT \ 1993 HAVE_CIEEEFP \ 1994 HAVE_CMATH \ 1995 HAVE_CSTDARG \ 1996 HAVE_CSTDDEF \ 1997 HAVE_CSTDIO \ 1998 HAVE_CSTDLIB \ 1999 HAVE_CSTRING \ 2000 HAVE_CTIME \ 2001 HAVE_CTYPE_H \ 2002 HAVE_DLFCN_H \ 2003 HAVE_DRAND48 \ 2004 HAVE_PARDISO \ 2005 HAVE_SNPRINTF \ 2006 HAVE_VA_COPY \ 2007 HAVE_VSNPRINTF \ 2008 HAVE_WSMP \ 2009 __cplusplus 2010 2011# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2012# tag can be used to specify a list of macro names that should be expanded. The 2013# macro definition that is found in the sources will be used. Use the PREDEFINED 2014# tag if you want to use a different macro definition that overrules the 2015# definition found in the source code. 2016# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2017 2018EXPAND_AS_DEFINED = 2019 2020# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2021# remove all references to function-like macros that are alone on a line, have 2022# an all uppercase name, and do not end with a semicolon. Such function macros 2023# are typically used for boiler-plate code, and will confuse the parser if not 2024# removed. 2025# The default value is: YES. 2026# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2027 2028SKIP_FUNCTION_MACROS = YES 2029 2030#--------------------------------------------------------------------------- 2031# Configuration options related to external references 2032#--------------------------------------------------------------------------- 2033 2034# The TAGFILES tag can be used to specify one or more tag files. For each tag 2035# file the location of the external documentation should be added. The format of 2036# a tag file without this location is as follows: 2037# TAGFILES = file1 file2 ... 2038# Adding location for the tag files is done as follows: 2039# TAGFILES = file1=loc1 "file2 = loc2" ... 2040# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2041# section "Linking to external documentation" for more information about the use 2042# of tag files. 2043# Note: Each tag file must have a unique name (where the name does NOT include 2044# the path). If a tag file is not located in the directory in which doxygen is 2045# run, you must also specify the path to the tagfile here. 2046 2047TAGFILES = @coin_doxy_tagfiles@ 2048 2049# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2050# tag file that is based on the input files it reads. See section "Linking to 2051# external documentation" for more information about the usage of tag files. 2052 2053GENERATE_TAGFILE = @coin_doxy_tagname@ 2054 2055# If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2056# the class index. If set to NO, only the inherited external classes will be 2057# listed. 2058# The default value is: NO. 2059 2060ALLEXTERNALS = YES 2061 2062# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2063# in the modules index. If set to NO, only the current project's groups will be 2064# listed. 2065# The default value is: YES. 2066 2067EXTERNAL_GROUPS = YES 2068 2069# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2070# the related pages index. If set to NO, only the current project's pages will 2071# be listed. 2072# The default value is: YES. 2073 2074EXTERNAL_PAGES = YES 2075 2076# The PERL_PATH should be the absolute path and name of the perl script 2077# interpreter (i.e. the result of 'which perl'). 2078# The default file (with absolute path) is: /usr/bin/perl. 2079 2080PERL_PATH = /usr/bin/perl 2081 2082#--------------------------------------------------------------------------- 2083# Configuration options related to the dot tool 2084#--------------------------------------------------------------------------- 2085 2086# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2087# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2088# NO turns the diagrams off. Note that this option also works with HAVE_DOT 2089# disabled, but it is recommended to install and use dot, since it yields more 2090# powerful graphs. 2091# The default value is: YES. 2092 2093CLASS_DIAGRAMS = YES 2094 2095# You can define message sequence charts within doxygen comments using the \msc 2096# command. Doxygen will then run the mscgen tool (see: 2097# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2098# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2099# the mscgen tool resides. If left empty the tool is assumed to be found in the 2100# default search path. 2101 2102MSCGEN_PATH = 2103 2104# You can include diagrams made with dia in doxygen documentation. Doxygen will 2105# then run dia to produce the diagram and insert it in the documentation. The 2106# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2107# If left empty dia is assumed to be found in the default search path. 2108 2109DIA_PATH = 2110 2111# If set to YES the inheritance and collaboration graphs will hide inheritance 2112# and usage relations if the target is undocumented or is not a class. 2113# The default value is: YES. 2114 2115HIDE_UNDOC_RELATIONS = YES 2116 2117# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2118# available from the path. This tool is part of Graphviz (see: 2119# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2120# Bell Labs. The other options in this section have no effect if this option is 2121# set to NO 2122# The default value is: NO. 2123 2124HAVE_DOT = @coin_doxy_usedot@ 2125 2126# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2127# to run in parallel. When set to 0 doxygen will base this on the number of 2128# processors available in the system. You can set it explicitly to a value 2129# larger than 0 to get control over the balance between CPU load and processing 2130# speed. 2131# Minimum value: 0, maximum value: 32, default value: 0. 2132# This tag requires that the tag HAVE_DOT is set to YES. 2133 2134DOT_NUM_THREADS = 0 2135 2136# When you want a differently looking font in the dot files that doxygen 2137# generates you can specify the font name using DOT_FONTNAME. You need to make 2138# sure dot is able to find the font, which can be done by putting it in a 2139# standard location or by setting the DOTFONTPATH environment variable or by 2140# setting DOT_FONTPATH to the directory containing the font. 2141# The default value is: Helvetica. 2142# This tag requires that the tag HAVE_DOT is set to YES. 2143 2144DOT_FONTNAME = FreeSans 2145 2146# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2147# dot graphs. 2148# Minimum value: 4, maximum value: 24, default value: 10. 2149# This tag requires that the tag HAVE_DOT is set to YES. 2150 2151DOT_FONTSIZE = 10 2152 2153# By default doxygen will tell dot to use the default font as specified with 2154# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2155# the path where dot can find it using this tag. 2156# This tag requires that the tag HAVE_DOT is set to YES. 2157 2158DOT_FONTPATH = 2159 2160# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2161# each documented class showing the direct and indirect inheritance relations. 2162# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2163# The default value is: YES. 2164# This tag requires that the tag HAVE_DOT is set to YES. 2165 2166CLASS_GRAPH = YES 2167 2168# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2169# graph for each documented class showing the direct and indirect implementation 2170# dependencies (inheritance, containment, and class references variables) of the 2171# class with other documented classes. 2172# The default value is: YES. 2173# This tag requires that the tag HAVE_DOT is set to YES. 2174 2175COLLABORATION_GRAPH = NO 2176 2177# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2178# groups, showing the direct groups dependencies. 2179# The default value is: YES. 2180# This tag requires that the tag HAVE_DOT is set to YES. 2181 2182GROUP_GRAPHS = YES 2183 2184# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2185# collaboration diagrams in a style similar to the OMG's Unified Modeling 2186# Language. 2187# The default value is: NO. 2188# This tag requires that the tag HAVE_DOT is set to YES. 2189 2190UML_LOOK = NO 2191 2192# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2193# class node. If there are many fields or methods and many nodes the graph may 2194# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2195# number of items for each type to make the size more manageable. Set this to 0 2196# for no limit. Note that the threshold may be exceeded by 50% before the limit 2197# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2198# but if the number exceeds 15, the total amount of fields shown is limited to 2199# 10. 2200# Minimum value: 0, maximum value: 100, default value: 10. 2201# This tag requires that the tag HAVE_DOT is set to YES. 2202 2203UML_LIMIT_NUM_FIELDS = 10 2204 2205# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2206# collaboration graphs will show the relations between templates and their 2207# instances. 2208# The default value is: NO. 2209# This tag requires that the tag HAVE_DOT is set to YES. 2210 2211TEMPLATE_RELATIONS = YES 2212 2213# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2214# YES then doxygen will generate a graph for each documented file showing the 2215# direct and indirect include dependencies of the file with other documented 2216# files. 2217# The default value is: YES. 2218# This tag requires that the tag HAVE_DOT is set to YES. 2219 2220INCLUDE_GRAPH = NO 2221 2222# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2223# set to YES then doxygen will generate a graph for each documented file showing 2224# the direct and indirect include dependencies of the file with other documented 2225# files. 2226# The default value is: YES. 2227# This tag requires that the tag HAVE_DOT is set to YES. 2228 2229INCLUDED_BY_GRAPH = NO 2230 2231# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2232# dependency graph for every global function or class method. 2233# 2234# Note that enabling this option will significantly increase the time of a run. 2235# So in most cases it will be better to enable call graphs for selected 2236# functions only using the \callgraph command. 2237# The default value is: NO. 2238# This tag requires that the tag HAVE_DOT is set to YES. 2239 2240CALL_GRAPH = NO 2241 2242# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2243# dependency graph for every global function or class method. 2244# 2245# Note that enabling this option will significantly increase the time of a run. 2246# So in most cases it will be better to enable caller graphs for selected 2247# functions only using the \callergraph command. 2248# The default value is: NO. 2249# This tag requires that the tag HAVE_DOT is set to YES. 2250 2251CALLER_GRAPH = NO 2252 2253# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2254# hierarchy of all classes instead of a textual one. 2255# The default value is: YES. 2256# This tag requires that the tag HAVE_DOT is set to YES. 2257 2258GRAPHICAL_HIERARCHY = YES 2259 2260# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2261# dependencies a directory has on other directories in a graphical way. The 2262# dependency relations are determined by the #include relations between the 2263# files in the directories. 2264# The default value is: YES. 2265# This tag requires that the tag HAVE_DOT is set to YES. 2266 2267DIRECTORY_GRAPH = YES 2268 2269# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2270# generated by dot. 2271# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2272# to make the SVG files visible in IE 9+ (other browsers do not have this 2273# requirement). 2274# Possible values are: png, jpg, gif and svg. 2275# The default value is: png. 2276# This tag requires that the tag HAVE_DOT is set to YES. 2277 2278DOT_IMAGE_FORMAT = png 2279 2280# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2281# enable generation of interactive SVG images that allow zooming and panning. 2282# 2283# Note that this requires a modern browser other than Internet Explorer. Tested 2284# and working are Firefox, Chrome, Safari, and Opera. 2285# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2286# the SVG files visible. Older versions of IE do not have SVG support. 2287# The default value is: NO. 2288# This tag requires that the tag HAVE_DOT is set to YES. 2289 2290INTERACTIVE_SVG = NO 2291 2292# The DOT_PATH tag can be used to specify the path where the dot tool can be 2293# found. If left blank, it is assumed the dot tool can be found in the path. 2294# This tag requires that the tag HAVE_DOT is set to YES. 2295 2296DOT_PATH = 2297 2298# The DOTFILE_DIRS tag can be used to specify one or more directories that 2299# contain dot files that are included in the documentation (see the \dotfile 2300# command). 2301# This tag requires that the tag HAVE_DOT is set to YES. 2302 2303DOTFILE_DIRS = 2304 2305# The MSCFILE_DIRS tag can be used to specify one or more directories that 2306# contain msc files that are included in the documentation (see the \mscfile 2307# command). 2308 2309MSCFILE_DIRS = 2310 2311# The DIAFILE_DIRS tag can be used to specify one or more directories that 2312# contain dia files that are included in the documentation (see the \diafile 2313# command). 2314 2315DIAFILE_DIRS = 2316 2317# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2318# path where java can find the plantuml.jar file. If left blank, it is assumed 2319# PlantUML is not used or called during a preprocessing step. Doxygen will 2320# generate a warning when it encounters a \startuml command in this case and 2321# will not generate output for the diagram. 2322 2323PLANTUML_JAR_PATH = 2324 2325# When using plantuml, the specified paths are searched for files specified by 2326# the !include statement in a plantuml block. 2327 2328PLANTUML_INCLUDE_PATH = 2329 2330# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2331# that will be shown in the graph. If the number of nodes in a graph becomes 2332# larger than this value, doxygen will truncate the graph, which is visualized 2333# by representing a node as a red box. Note that doxygen if the number of direct 2334# children of the root node in a graph is already larger than 2335# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2336# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2337# Minimum value: 0, maximum value: 10000, default value: 50. 2338# This tag requires that the tag HAVE_DOT is set to YES. 2339 2340DOT_GRAPH_MAX_NODES = 50 2341 2342# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2343# generated by dot. A depth value of 3 means that only nodes reachable from the 2344# root by following a path via at most 3 edges will be shown. Nodes that lay 2345# further from the root node will be omitted. Note that setting this option to 1 2346# or 2 may greatly reduce the computation time needed for large code bases. Also 2347# note that the size of a graph can be further restricted by 2348# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2349# Minimum value: 0, maximum value: 1000, default value: 0. 2350# This tag requires that the tag HAVE_DOT is set to YES. 2351 2352MAX_DOT_GRAPH_DEPTH = 0 2353 2354# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2355# background. This is disabled by default, because dot on Windows does not seem 2356# to support this out of the box. 2357# 2358# Warning: Depending on the platform used, enabling this option may lead to 2359# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2360# read). 2361# The default value is: NO. 2362# This tag requires that the tag HAVE_DOT is set to YES. 2363 2364DOT_TRANSPARENT = NO 2365 2366# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2367# files in one run (i.e. multiple -o and -T options on the command line). This 2368# makes dot run faster, but since only newer versions of dot (>1.8.10) support 2369# this, this feature is disabled by default. 2370# The default value is: NO. 2371# This tag requires that the tag HAVE_DOT is set to YES. 2372 2373DOT_MULTI_TARGETS = YES 2374 2375# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2376# explaining the meaning of the various boxes and arrows in the dot generated 2377# graphs. 2378# The default value is: YES. 2379# This tag requires that the tag HAVE_DOT is set to YES. 2380 2381GENERATE_LEGEND = YES 2382 2383# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot 2384# files that are used to generate the various graphs. 2385# The default value is: YES. 2386# This tag requires that the tag HAVE_DOT is set to YES. 2387 2388DOT_CLEANUP = YES 2389