1# Doxyfile 1.7.3 2 3# 4# Copyright 2016, Data61 5# Commonwealth Scientific and Industrial Research Organisation (CSIRO) 6# ABN 41 687 119 230. 7# 8# This software may be distributed and modified according to the terms of 9# the BSD 2-Clause license. Note that NO WARRANTY is provided. 10# See "LICENSE_BSD2.txt" for details. 11# 12# @TAG(D61_BSD) 13# 14 15# This file describes the settings to be used by the documentation system 16# doxygen (www.doxygen.org) for a project 17# 18# All text after a hash (#) is considered a comment and will be ignored 19# The format is: 20# TAG = value [value, ...] 21# For lists items can also be appended using: 22# TAG += value [value, ...] 23# Values that contain spaces should be placed between quotes (" ") 24 25#--------------------------------------------------------------------------- 26# Project related configuration options 27#--------------------------------------------------------------------------- 28 29# This tag specifies the encoding used for all characters in the config file 30# that follow. The default is UTF-8 which is also the encoding used for all 31# text before the first occurrence of this tag. Doxygen uses libiconv (or the 32# iconv built into libc) for the transcoding. See 33# http://www.gnu.org/software/libiconv for the list of possible encodings. 34 35DOXYFILE_ENCODING = UTF-8 36 37# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 38# by quotes) that should identify the project. 39 40PROJECT_NAME = RefOS 41 42# The PROJECT_NUMBER tag can be used to enter a project or revision number. 43# This could be handy for archiving the generated documentation or 44# if some version control system is used. 45 46PROJECT_NUMBER = 2.0 47 48# Using the PROJECT_BRIEF tag one can provide an optional one line description 49# for a project that appears at the top of each page and should give viewer 50# a quick idea about the purpose of the project. Keep the description short. 51 52PROJECT_BRIEF = "Small multi-server reference OS on seL4" 53 54# With the PROJECT_LOGO tag one can specify an logo or icon that is 55# included in the documentation. The maximum height of the logo should not 56# exceed 55 pixels and the maximum width should not exceed 200 pixels. 57# Doxygen will copy the logo to the output directory. 58 59PROJECT_LOGO = ./doxygen/header-logo.png 60 61# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 62# base path where the generated documentation will be put. 63# If a relative path is entered, it will be relative to the location 64# where doxygen was started. If left blank the current directory will be used. 65 66OUTPUT_DIRECTORY = 67 68# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 69# 4096 sub-directories (in 2 levels) under the output directory of each output 70# format and will distribute the generated files over these directories. 71# Enabling this option can be useful when feeding doxygen a huge amount of 72# source files, where putting all generated files in the same directory would 73# otherwise cause performance problems for the file system. 74 75CREATE_SUBDIRS = NO 76 77# The OUTPUT_LANGUAGE tag is used to specify the language in which all 78# documentation generated by doxygen is written. Doxygen will use this 79# information to generate all constant output in the proper language. 80# The default language is English, other supported languages are: 81# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 82# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 83# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 84# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 85# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 86# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 87 88OUTPUT_LANGUAGE = English 89 90# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 91# include brief member descriptions after the members that are listed in 92# the file and class documentation (similar to JavaDoc). 93# Set to NO to disable this. 94 95BRIEF_MEMBER_DESC = YES 96 97# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 98# the brief description of a member or function before the detailed description. 99# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 100# brief descriptions will be completely suppressed. 101 102REPEAT_BRIEF = YES 103 104# This tag implements a quasi-intelligent brief description abbreviator 105# that is used to form the text in various listings. Each string 106# in this list, if found as the leading text of the brief description, will be 107# stripped from the text and the result after processing the whole list, is 108# used as the annotated text. Otherwise, the brief description is used as-is. 109# If left blank, the following values are used ("$name" is automatically 110# replaced with the name of the entity): "The $name class" "The $name widget" 111# "The $name file" "is" "provides" "specifies" "contains" 112# "represents" "a" "an" "the" 113 114ABBREVIATE_BRIEF = 115 116# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 117# Doxygen will generate a detailed section even if there is only a brief 118# description. 119 120ALWAYS_DETAILED_SEC = YES 121 122# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 123# inherited members of a class in the documentation of that class as if those 124# members were ordinary class members. Constructors, destructors and assignment 125# operators of the base classes will not be shown. 126 127INLINE_INHERITED_MEMB = NO 128 129# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 130# path before files name in the file list and in the header files. If set 131# to NO the shortest path that makes the file name unique will be used. 132 133FULL_PATH_NAMES = YES 134 135# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 136# can be used to strip a user-defined part of the path. Stripping is 137# only done if one of the specified strings matches the left-hand part of 138# the path. The tag can be used to show relative paths in the file list. 139# If left blank the directory from which doxygen is run is used as the 140# path to strip. 141 142STRIP_FROM_PATH = ../ 143 144# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 145# the path mentioned in the documentation of a class, which tells 146# the reader which header file to include in order to use a class. 147# If left blank only the name of the header file containing the class 148# definition is used. Otherwise one should specify the include paths that 149# are normally passed to the compiler using the -I flag. 150 151STRIP_FROM_INC_PATH = 152 153# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 154# (but less readable) file names. This can be useful if your file system 155# doesn't support long names like on DOS, Mac, or CD-ROM. 156 157SHORT_NAMES = NO 158 159# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 160# will interpret the first line (until the first dot) of a JavaDoc-style 161# comment as the brief description. If set to NO, the JavaDoc 162# comments will behave just like regular Qt-style comments 163# (thus requiring an explicit @brief command for a brief description.) 164 165JAVADOC_AUTOBRIEF = NO 166 167# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 168# interpret the first line (until the first dot) of a Qt-style 169# comment as the brief description. If set to NO, the comments 170# will behave just like regular Qt-style comments (thus requiring 171# an explicit \brief command for a brief description.) 172 173QT_AUTOBRIEF = NO 174 175# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 176# treat a multi-line C++ special comment block (i.e. a block of //! or /// 177# comments) as a brief description. This used to be the default behaviour. 178# The new default is to treat a multi-line C++ comment block as a detailed 179# description. Set this tag to YES if you prefer the old behaviour instead. 180 181MULTILINE_CPP_IS_BRIEF = NO 182 183# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 184# member inherits the documentation from any documented member that it 185# re-implements. 186 187INHERIT_DOCS = YES 188 189# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 190# a new page for each member. If set to NO, the documentation of a member will 191# be part of the file/class/namespace that contains it. 192 193SEPARATE_MEMBER_PAGES = NO 194 195# The TAB_SIZE tag can be used to set the number of spaces in a tab. 196# Doxygen uses this value to replace tabs by spaces in code fragments. 197 198TAB_SIZE = 4 199 200# This tag can be used to specify a number of aliases that acts 201# as commands in the documentation. An alias has the form "name=value". 202# For example adding "sideeffect=\par Side Effects:\n" will allow you to 203# put the command \sideeffect (or @sideeffect) in the documentation, which 204# will result in a user-defined paragraph with heading "Side Effects:". 205# You can put \n's in the value part of an alias to insert newlines. 206 207ALIASES = 208 209# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 210# sources only. Doxygen will then generate output that is more tailored for C. 211# For instance, some of the names that are used will be different. The list 212# of all members will be omitted, etc. 213 214OPTIMIZE_OUTPUT_FOR_C = YES 215 216# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 217# sources only. Doxygen will then generate output that is more tailored for 218# Java. For instance, namespaces will be presented as packages, qualified 219# scopes will look different, etc. 220 221OPTIMIZE_OUTPUT_JAVA = NO 222 223# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 224# sources only. Doxygen will then generate output that is more tailored for 225# Fortran. 226 227OPTIMIZE_FOR_FORTRAN = NO 228 229# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 230# sources. Doxygen will then generate output that is tailored for 231# VHDL. 232 233OPTIMIZE_OUTPUT_VHDL = NO 234 235# Doxygen selects the parser to use depending on the extension of the files it 236# parses. With this tag you can assign which parser to use for a given extension. 237# Doxygen has a built-in mapping, but you can override or extend it using this 238# tag. The format is ext=language, where ext is a file extension, and language 239# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 240# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 241# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 242# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 243# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 244 245EXTENSION_MAPPING = 246 247# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 248# to include (a tag file for) the STL sources as input, then you should 249# set this tag to YES in order to let doxygen match functions declarations and 250# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 251# func(std::string) {}). This also makes the inheritance and collaboration 252# diagrams that involve STL classes more complete and accurate. 253 254BUILTIN_STL_SUPPORT = NO 255 256# If you use Microsoft's C++/CLI language, you should set this option to YES to 257# enable parsing support. 258 259CPP_CLI_SUPPORT = NO 260 261# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 262# Doxygen will parse them like normal C++ but will assume all classes use public 263# instead of private inheritance when no explicit protection keyword is present. 264 265SIP_SUPPORT = NO 266 267# For Microsoft's IDL there are propget and propput attributes to indicate getter 268# and setter methods for a property. Setting this option to YES (the default) 269# will make doxygen replace the get and set methods by a property in the 270# documentation. This will only work if the methods are indeed getting or 271# setting a simple type. If this is not the case, or you want to show the 272# methods anyway, you should set this option to NO. 273 274IDL_PROPERTY_SUPPORT = YES 275 276# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 277# tag is set to YES, then doxygen will reuse the documentation of the first 278# member in the group (if any) for the other members of the group. By default 279# all members of a group must be documented explicitly. 280 281DISTRIBUTE_GROUP_DOC = NO 282 283# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 284# the same type (for instance a group of public functions) to be put as a 285# subgroup of that type (e.g. under the Public Functions section). Set it to 286# NO to prevent subgrouping. Alternatively, this can be done per class using 287# the \nosubgrouping command. 288 289SUBGROUPING = YES 290 291# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 292# is documented as struct, union, or enum with the name of the typedef. So 293# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 294# with name TypeT. When disabled the typedef will appear as a member of a file, 295# namespace, or class. And the struct will be named TypeS. This can typically 296# be useful for C code in case the coding convention dictates that all compound 297# types are typedef'ed and only the typedef is referenced, never the tag name. 298 299TYPEDEF_HIDES_STRUCT = NO 300 301#--------------------------------------------------------------------------- 302# Build related configuration options 303#--------------------------------------------------------------------------- 304 305# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 306# documentation are documented, even if no documentation was available. 307# Private class members and static file members will be hidden unless 308# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 309 310EXTRACT_ALL = YES 311 312# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 313# will be included in the documentation. 314 315EXTRACT_PRIVATE = YES 316 317# If the EXTRACT_STATIC tag is set to YES all static members of a file 318# will be included in the documentation. 319 320EXTRACT_STATIC = YES 321 322# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 323# defined locally in source files will be included in the documentation. 324# If set to NO only classes defined in header files are included. 325 326EXTRACT_LOCAL_CLASSES = YES 327 328# This flag is only useful for Objective-C code. When set to YES local 329# methods, which are defined in the implementation section but not in 330# the interface are included in the documentation. 331# If set to NO (the default) only methods in the interface are included. 332 333EXTRACT_LOCAL_METHODS = NO 334 335# If this flag is set to YES, the members of anonymous namespaces will be 336# extracted and appear in the documentation as a namespace called 337# 'anonymous_namespace{file}', where file will be replaced with the base 338# name of the file that contains the anonymous namespace. By default 339# anonymous namespaces are hidden. 340 341EXTRACT_ANON_NSPACES = NO 342 343# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 344# undocumented members of documented classes, files or namespaces. 345# If set to NO (the default) these members will be included in the 346# various overviews, but no documentation section is generated. 347# This option has no effect if EXTRACT_ALL is enabled. 348 349HIDE_UNDOC_MEMBERS = NO 350 351# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 352# undocumented classes that are normally visible in the class hierarchy. 353# If set to NO (the default) these classes will be included in the various 354# overviews. This option has no effect if EXTRACT_ALL is enabled. 355 356HIDE_UNDOC_CLASSES = NO 357 358# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 359# friend (class|struct|union) declarations. 360# If set to NO (the default) these declarations will be included in the 361# documentation. 362 363HIDE_FRIEND_COMPOUNDS = NO 364 365# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 366# documentation blocks found inside the body of a function. 367# If set to NO (the default) these blocks will be appended to the 368# function's detailed documentation block. 369 370HIDE_IN_BODY_DOCS = NO 371 372# The INTERNAL_DOCS tag determines if documentation 373# that is typed after a \internal command is included. If the tag is set 374# to NO (the default) then the documentation will be excluded. 375# Set it to YES to include the internal documentation. 376 377INTERNAL_DOCS = NO 378 379# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 380# file names in lower-case letters. If set to YES upper-case letters are also 381# allowed. This is useful if you have classes or files whose names only differ 382# in case and if your file system supports case sensitive file names. Windows 383# and Mac users are advised to set this option to NO. 384 385CASE_SENSE_NAMES = YES 386 387# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 388# will show members with their full class and namespace scopes in the 389# documentation. If set to YES the scope will be hidden. 390 391HIDE_SCOPE_NAMES = NO 392 393# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 394# will put a list of the files that are included by a file in the documentation 395# of that file. 396 397SHOW_INCLUDE_FILES = YES 398 399# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 400# will list include files with double quotes in the documentation 401# rather than with sharp brackets. 402 403FORCE_LOCAL_INCLUDES = NO 404 405# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 406# is inserted in the documentation for inline members. 407 408INLINE_INFO = YES 409 410# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 411# will sort the (detailed) documentation of file and class members 412# alphabetically by member name. If set to NO the members will appear in 413# declaration order. 414 415SORT_MEMBER_DOCS = YES 416 417# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 418# brief documentation of file, namespace and class members alphabetically 419# by member name. If set to NO (the default) the members will appear in 420# declaration order. 421 422SORT_BRIEF_DOCS = NO 423 424# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 425# will sort the (brief and detailed) documentation of class members so that 426# constructors and destructors are listed first. If set to NO (the default) 427# the constructors will appear in the respective orders defined by 428# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 429# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 430# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 431 432SORT_MEMBERS_CTORS_1ST = NO 433 434# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 435# hierarchy of group names into alphabetical order. If set to NO (the default) 436# the group names will appear in their defined order. 437 438SORT_GROUP_NAMES = NO 439 440# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 441# sorted by fully-qualified names, including namespaces. If set to 442# NO (the default), the class list will be sorted only by class name, 443# not including the namespace part. 444# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 445# Note: This option applies only to the class list, not to the 446# alphabetical list. 447 448SORT_BY_SCOPE_NAME = NO 449 450# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 451# do proper type resolution of all parameters of a function it will reject a 452# match between the prototype and the implementation of a member function even 453# if there is only one candidate or it is obvious which candidate to choose 454# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 455# will still accept a match between prototype and implementation in such cases. 456 457STRICT_PROTO_MATCHING = NO 458 459# The GENERATE_TODOLIST tag can be used to enable (YES) or 460# disable (NO) the todo list. This list is created by putting \todo 461# commands in the documentation. 462 463GENERATE_TODOLIST = YES 464 465# The GENERATE_TESTLIST tag can be used to enable (YES) or 466# disable (NO) the test list. This list is created by putting \test 467# commands in the documentation. 468 469GENERATE_TESTLIST = YES 470 471# The GENERATE_BUGLIST tag can be used to enable (YES) or 472# disable (NO) the bug list. This list is created by putting \bug 473# commands in the documentation. 474 475GENERATE_BUGLIST = YES 476 477# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 478# disable (NO) the deprecated list. This list is created by putting 479# \deprecated commands in the documentation. 480 481GENERATE_DEPRECATEDLIST= YES 482 483# The ENABLED_SECTIONS tag can be used to enable conditional 484# documentation sections, marked by \if sectionname ... \endif. 485 486ENABLED_SECTIONS = 487 488# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 489# the initial value of a variable or macro consists of for it to appear in 490# the documentation. If the initializer consists of more lines than specified 491# here it will be hidden. Use a value of 0 to hide initializers completely. 492# The appearance of the initializer of individual variables and macros in the 493# documentation can be controlled using \showinitializer or \hideinitializer 494# command in the documentation regardless of this setting. 495 496MAX_INITIALIZER_LINES = 30 497 498# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 499# at the bottom of the documentation of classes and structs. If set to YES the 500# list will mention the files that were used to generate the documentation. 501 502SHOW_USED_FILES = NO 503 504# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 505# This will remove the Files entry from the Quick Index and from the 506# Folder Tree View (if specified). The default is YES. 507 508SHOW_FILES = YES 509 510# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 511# Namespaces page. This will remove the Namespaces entry from the Quick Index 512# and from the Folder Tree View (if specified). The default is YES. 513 514SHOW_NAMESPACES = NO 515 516# The FILE_VERSION_FILTER tag can be used to specify a program or script that 517# doxygen should invoke to get the current version for each file (typically from 518# the version control system). Doxygen will invoke the program by executing (via 519# popen()) the command <command> <input-file>, where <command> is the value of 520# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 521# provided by doxygen. Whatever the program writes to standard output 522# is used as the file version. See the manual for examples. 523 524FILE_VERSION_FILTER = 525 526# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 527# by doxygen. The layout file controls the global structure of the generated 528# output files in an output format independent way. The create the layout file 529# that represents doxygen's defaults, run doxygen with the -l option. 530# You can optionally specify a file name after the option, if omitted 531# DoxygenLayout.xml will be used as the name of the layout file. 532 533LAYOUT_FILE = 534 535#--------------------------------------------------------------------------- 536# configuration options related to warning and progress messages 537#--------------------------------------------------------------------------- 538 539# The QUIET tag can be used to turn on/off the messages that are generated 540# by doxygen. Possible values are YES and NO. If left blank NO is used. 541 542QUIET = NO 543 544# The WARNINGS tag can be used to turn on/off the warning messages that are 545# generated by doxygen. Possible values are YES and NO. If left blank 546# NO is used. 547 548WARNINGS = YES 549 550# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 551# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 552# automatically be disabled. 553 554WARN_IF_UNDOCUMENTED = YES 555 556# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 557# potential errors in the documentation, such as not documenting some 558# parameters in a documented function, or documenting parameters that 559# don't exist or using markup commands wrongly. 560 561WARN_IF_DOC_ERROR = YES 562 563# The WARN_NO_PARAMDOC option can be enabled to get warnings for 564# functions that are documented, but have no documentation for their parameters 565# or return value. If set to NO (the default) doxygen will only warn about 566# wrong or incomplete parameter documentation, but not about the absence of 567# documentation. 568 569WARN_NO_PARAMDOC = YES 570 571# The WARN_FORMAT tag determines the format of the warning messages that 572# doxygen can produce. The string should contain the $file, $line, and $text 573# tags, which will be replaced by the file and line number from which the 574# warning originated and the warning text. Optionally the format may contain 575# $version, which will be replaced by the version of the file (if it could 576# be obtained via FILE_VERSION_FILTER) 577 578WARN_FORMAT = "$file:$line: $text" 579 580# The WARN_LOGFILE tag can be used to specify a file to which warning 581# and error messages should be written. If left blank the output is written 582# to stderr. 583 584WARN_LOGFILE = 585 586#--------------------------------------------------------------------------- 587# configuration options related to the input files 588#--------------------------------------------------------------------------- 589 590# The INPUT tag can be used to specify the files and/or directories that contain 591# documented source files. You may enter file names like "myfile.cpp" or 592# directories like "/usr/src/myproject". Separate the files or directories 593# with spaces. 594 595INPUT = "../apps" \ 596 "../libs/librefos" \ 597 "../libs/librefossys" \ 598 "../libs/libdatastruct" \ 599 "../docs/extra_pages" 600 601# This tag can be used to specify the character encoding of the source files 602# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 603# also the default input encoding. Doxygen uses libiconv (or the iconv built 604# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 605# the list of possible encodings. 606 607INPUT_ENCODING = UTF-8 608 609# If the value of the INPUT tag contains directories, you can use the 610# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 611# and *.h) to filter out the source-files in the directories. If left 612# blank the following patterns are tested: 613# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 614# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 615# *.f90 *.f *.for *.vhd *.vhdl 616 617FILE_PATTERNS = 618 619# The RECURSIVE tag can be used to turn specify whether or not subdirectories 620# should be searched for input files as well. Possible values are YES and NO. 621# If left blank NO is used. 622 623RECURSIVE = YES 624 625# The EXCLUDE tag can be used to specify files and/or directories that should 626# excluded from the INPUT source files. This way you can easily exclude a 627# subdirectory from a directory tree whose root is specified with the INPUT tag. 628 629EXCLUDE = 630 631# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 632# directories that are symbolic links (a Unix file system feature) are excluded 633# from the input. 634 635EXCLUDE_SYMLINKS = YES 636 637# If the value of the INPUT tag contains directories, you can use the 638# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 639# certain files from those directories. Note that the wildcards are matched 640# against the file with absolute path, so to exclude all test directories 641# for example use the pattern */test/* 642 643EXCLUDE_PATTERNS = 644 645# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 646# (namespaces, classes, functions, etc.) that should be excluded from the 647# output. The symbol name can be a fully qualified name, a word, or if the 648# wildcard * is used, a substring. Examples: ANamespace, AClass, 649# AClass::ANamespace, ANamespace::*Test 650 651EXCLUDE_SYMBOLS = 652 653# The EXAMPLE_PATH tag can be used to specify one or more files or 654# directories that contain example code fragments that are included (see 655# the \include command). 656 657EXAMPLE_PATH = 658 659# If the value of the EXAMPLE_PATH tag contains directories, you can use the 660# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 661# and *.h) to filter out the source-files in the directories. If left 662# blank all files are included. 663 664EXAMPLE_PATTERNS = 665 666# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 667# searched for input files to be used with the \include or \dontinclude 668# commands irrespective of the value of the RECURSIVE tag. 669# Possible values are YES and NO. If left blank NO is used. 670 671EXAMPLE_RECURSIVE = NO 672 673# The IMAGE_PATH tag can be used to specify one or more files or 674# directories that contain image that are included in the documentation (see 675# the \image command). 676 677IMAGE_PATH = doxygen 678 679# The INPUT_FILTER tag can be used to specify a program that doxygen should 680# invoke to filter for each input file. Doxygen will invoke the filter program 681# by executing (via popen()) the command <filter> <input-file>, where <filter> 682# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 683# input file. Doxygen will then use the output that the filter program writes 684# to standard output. If FILTER_PATTERNS is specified, this tag will be 685# ignored. 686 687INPUT_FILTER = 688 689# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 690# basis. Doxygen will compare the file name with each pattern and apply the 691# filter if there is a match. The filters are a list of the form: 692# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 693# info on how filters are used. If FILTER_PATTERNS is empty or if 694# non of the patterns match the file name, INPUT_FILTER is applied. 695 696FILTER_PATTERNS = 697 698# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 699# INPUT_FILTER) will be used to filter the input files when producing source 700# files to browse (i.e. when SOURCE_BROWSER is set to YES). 701 702FILTER_SOURCE_FILES = NO 703 704# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 705# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 706# and it is also possible to disable source filtering for a specific pattern 707# using *.ext= (so without naming a filter). This option only has effect when 708# FILTER_SOURCE_FILES is enabled. 709 710FILTER_SOURCE_PATTERNS = 711 712#--------------------------------------------------------------------------- 713# configuration options related to source browsing 714#--------------------------------------------------------------------------- 715 716# If the SOURCE_BROWSER tag is set to YES then a list of source files will 717# be generated. Documented entities will be cross-referenced with these sources. 718# Note: To get rid of all source code in the generated output, make sure also 719# VERBATIM_HEADERS is set to NO. 720 721SOURCE_BROWSER = NO 722 723# Setting the INLINE_SOURCES tag to YES will include the body 724# of functions and classes directly in the documentation. 725 726INLINE_SOURCES = NO 727 728# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 729# doxygen to hide any special comment blocks from generated source code 730# fragments. Normal C and C++ comments will always remain visible. 731 732STRIP_CODE_COMMENTS = YES 733 734# If the REFERENCED_BY_RELATION tag is set to YES 735# then for each documented function all documented 736# functions referencing it will be listed. 737 738REFERENCED_BY_RELATION = NO 739 740# If the REFERENCES_RELATION tag is set to YES 741# then for each documented function all documented entities 742# called/used by that function will be listed. 743 744REFERENCES_RELATION = NO 745 746# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 747# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 748# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 749# link to the source code. Otherwise they will link to the documentation. 750 751REFERENCES_LINK_SOURCE = YES 752 753# If the USE_HTAGS tag is set to YES then the references to source code 754# will point to the HTML generated by the htags(1) tool instead of doxygen 755# built-in source browser. The htags tool is part of GNU's global source 756# tagging system (see http://www.gnu.org/software/global/global.html). You 757# will need version 4.8.6 or higher. 758 759USE_HTAGS = NO 760 761# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 762# will generate a verbatim copy of the header file for each class for 763# which an include is specified. Set to NO to disable this. 764 765VERBATIM_HEADERS = YES 766 767#--------------------------------------------------------------------------- 768# configuration options related to the alphabetical class index 769#--------------------------------------------------------------------------- 770 771# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 772# of all compounds will be generated. Enable this if the project 773# contains a lot of classes, structs, unions or interfaces. 774 775ALPHABETICAL_INDEX = YES 776 777# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 778# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 779# in which this list will be split (can be a number in the range [1..20]) 780 781COLS_IN_ALPHA_INDEX = 5 782 783# In case all classes in a project start with a common prefix, all 784# classes will be put under the same header in the alphabetical index. 785# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 786# should be ignored while generating the index headers. 787 788IGNORE_PREFIX = 789 790#--------------------------------------------------------------------------- 791# configuration options related to the HTML output 792#--------------------------------------------------------------------------- 793 794# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 795# generate HTML output. 796 797GENERATE_HTML = YES 798 799# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 800# If a relative path is entered the value of OUTPUT_DIRECTORY will be 801# put in front of it. If left blank `html' will be used as the default path. 802 803HTML_OUTPUT = html 804 805# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 806# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 807# doxygen will generate files with .html extension. 808 809HTML_FILE_EXTENSION = .html 810 811# The HTML_HEADER tag can be used to specify a personal HTML header for 812# each generated HTML page. If it is left blank doxygen will generate a 813# standard header. 814 815HTML_HEADER = 816 817# The HTML_FOOTER tag can be used to specify a personal HTML footer for 818# each generated HTML page. If it is left blank doxygen will generate a 819# standard footer. 820 821HTML_FOOTER = 822 823# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 824# style sheet that is used by each HTML page. It can be used to 825# fine-tune the look of the HTML output. If the tag is left blank doxygen 826# will generate a default style sheet. Note that doxygen will try to copy 827# the style sheet file to the HTML output directory, so don't put your own 828# stylesheet in the HTML output directory as well, or it will be erased! 829 830HTML_STYLESHEET = 831HTML_EXTRA_STYLESHEET = doxygen/style.css 832 833# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 834# Doxygen will adjust the colors in the stylesheet and background images 835# according to this color. Hue is specified as an angle on a colorwheel, 836# see http://en.wikipedia.org/wiki/Hue for more information. 837# For instance the value 0 represents red, 60 is yellow, 120 is green, 838# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 839# The allowed range is 0 to 359. 840 841HTML_COLORSTYLE_HUE = 264 842 843# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 844# the colors in the HTML output. For a value of 0 the output will use 845# grayscales only. A value of 255 will produce the most vivid colors. 846 847HTML_COLORSTYLE_SAT = 64 848 849# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 850# the luminance component of the colors in the HTML output. Values below 851# 100 gradually make the output lighter, whereas values above 100 make 852# the output darker. The value divided by 100 is the actual gamma applied, 853# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 854# and 100 does not change the gamma. 855 856HTML_COLORSTYLE_GAMMA = 99 857 858# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 859# page will contain the date and time when the page was generated. Setting 860# this to NO can help when comparing the output of multiple runs. 861 862HTML_TIMESTAMP = YES 863 864# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 865# documentation will contain sections that can be hidden and shown after the 866# page has loaded. For this to work a browser that supports 867# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 868# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 869 870HTML_DYNAMIC_SECTIONS = YES 871 872# If the GENERATE_DOCSET tag is set to YES, additional index files 873# will be generated that can be used as input for Apple's Xcode 3 874# integrated development environment, introduced with OSX 10.5 (Leopard). 875# To create a documentation set, doxygen will generate a Makefile in the 876# HTML output directory. Running make will produce the docset in that 877# directory and running "make install" will install the docset in 878# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 879# it at startup. 880# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 881# for more information. 882 883GENERATE_DOCSET = NO 884 885# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 886# feed. A documentation feed provides an umbrella under which multiple 887# documentation sets from a single provider (such as a company or product suite) 888# can be grouped. 889 890DOCSET_FEEDNAME = "Doxygen generated docs" 891 892# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 893# should uniquely identify the documentation set bundle. This should be a 894# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 895# will append .docset to the name. 896 897DOCSET_BUNDLE_ID = org.doxygen.Project 898 899# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 900# the documentation publisher. This should be a reverse domain-name style 901# string, e.g. com.mycompany.MyDocSet.documentation. 902 903DOCSET_PUBLISHER_ID = org.doxygen.Publisher 904 905# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 906 907DOCSET_PUBLISHER_NAME = Publisher 908 909# If the GENERATE_HTMLHELP tag is set to YES, additional index files 910# will be generated that can be used as input for tools like the 911# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 912# of the generated HTML documentation. 913 914GENERATE_HTMLHELP = NO 915 916# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 917# be used to specify the file name of the resulting .chm file. You 918# can add a path in front of the file if the result should not be 919# written to the html output directory. 920 921CHM_FILE = 922 923# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 924# be used to specify the location (absolute path including file name) of 925# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 926# the HTML help compiler on the generated index.hhp. 927 928HHC_LOCATION = 929 930# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 931# controls if a separate .chi index file is generated (YES) or that 932# it should be included in the master .chm file (NO). 933 934GENERATE_CHI = NO 935 936# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 937# is used to encode HtmlHelp index (hhk), content (hhc) and project file 938# content. 939 940CHM_INDEX_ENCODING = 941 942# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 943# controls whether a binary table of contents is generated (YES) or a 944# normal table of contents (NO) in the .chm file. 945 946BINARY_TOC = NO 947 948# The TOC_EXPAND flag can be set to YES to add extra items for group members 949# to the contents of the HTML help documentation and to the tree view. 950 951TOC_EXPAND = NO 952 953# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 954# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 955# that can be used as input for Qt's qhelpgenerator to generate a 956# Qt Compressed Help (.qch) of the generated HTML documentation. 957 958GENERATE_QHP = NO 959 960# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 961# be used to specify the file name of the resulting .qch file. 962# The path specified is relative to the HTML output folder. 963 964QCH_FILE = 965 966# The QHP_NAMESPACE tag specifies the namespace to use when generating 967# Qt Help Project output. For more information please see 968# http://doc.trolltech.com/qthelpproject.html#namespace 969 970QHP_NAMESPACE = org.doxygen.Project 971 972# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 973# Qt Help Project output. For more information please see 974# http://doc.trolltech.com/qthelpproject.html#virtual-folders 975 976QHP_VIRTUAL_FOLDER = doc 977 978# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 979# add. For more information please see 980# http://doc.trolltech.com/qthelpproject.html#custom-filters 981 982QHP_CUST_FILTER_NAME = 983 984# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 985# custom filter to add. For more information please see 986# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 987# Qt Help Project / Custom Filters</a>. 988 989QHP_CUST_FILTER_ATTRS = 990 991# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 992# project's 993# filter section matches. 994# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 995# Qt Help Project / Filter Attributes</a>. 996 997QHP_SECT_FILTER_ATTRS = 998 999# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1000# be used to specify the location of Qt's qhelpgenerator. 1001# If non-empty doxygen will try to run qhelpgenerator on the generated 1002# .qhp file. 1003 1004QHG_LOCATION = 1005 1006# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1007# will be generated, which together with the HTML files, form an Eclipse help 1008# plugin. To install this plugin and make it available under the help contents 1009# menu in Eclipse, the contents of the directory containing the HTML and XML 1010# files needs to be copied into the plugins directory of eclipse. The name of 1011# the directory within the plugins directory should be the same as 1012# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1013# the help appears. 1014 1015GENERATE_ECLIPSEHELP = NO 1016 1017# A unique identifier for the eclipse help plugin. When installing the plugin 1018# the directory name containing the HTML and XML files should also have 1019# this name. 1020 1021ECLIPSE_DOC_ID = org.doxygen.Project 1022 1023# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 1024# top of each HTML page. The value NO (the default) enables the index and 1025# the value YES disables it. 1026 1027DISABLE_INDEX = NO 1028 1029# This tag can be used to set the number of enum values (range [0,1..20]) 1030# that doxygen will group on one line in the generated HTML documentation. 1031# Note that a value of 0 will completely suppress the enum values from 1032# appearing in the overview section. 1033 1034ENUM_VALUES_PER_LINE = 4 1035 1036# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1037# structure should be generated to display hierarchical information. 1038# If the tag value is set to YES, a side panel will be generated 1039# containing a tree-like index structure (just like the one that 1040# is generated for HTML Help). For this to work a browser that supports 1041# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1042# Windows users are probably better off using the HTML help feature. 1043 1044GENERATE_TREEVIEW = YES 1045 1046# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1047# used to set the initial width (in pixels) of the frame in which the tree 1048# is shown. 1049 1050TREEVIEW_WIDTH = 300 1051 1052# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1053# links to external symbols imported via tag files in a separate window. 1054 1055EXT_LINKS_IN_WINDOW = NO 1056 1057# Use this tag to change the font size of Latex formulas included 1058# as images in the HTML documentation. The default is 10. Note that 1059# when you change the font size after a successful doxygen run you need 1060# to manually remove any form_*.png images from the HTML output directory 1061# to force them to be regenerated. 1062 1063FORMULA_FONTSIZE = 10 1064 1065# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1066# generated for formulas are transparent PNGs. Transparent PNGs are 1067# not supported properly for IE 6.0, but are supported on all modern browsers. 1068# Note that when changing this option you need to delete any form_*.png files 1069# in the HTML output before the changes have effect. 1070 1071FORMULA_TRANSPARENT = YES 1072 1073# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1074# (see http://www.mathjax.org) which uses client side Javascript for the 1075# rendering instead of using prerendered bitmaps. Use this if you do not 1076# have LaTeX installed or if you want to formulas look prettier in the HTML 1077# output. When enabled you also need to install MathJax separately and 1078# configure the path to it using the MATHJAX_RELPATH option. 1079 1080USE_MATHJAX = NO 1081 1082# When MathJax is enabled you need to specify the location relative to the 1083# HTML output directory using the MATHJAX_RELPATH option. The destination 1084# directory should contain the MathJax.js script. For instance, if the mathjax 1085# directory is located at the same level as the HTML output directory, then 1086# MATHJAX_RELPATH should be ../mathjax. The default value points to the 1087# mathjax.org site, so you can quickly see the result without installing 1088# MathJax, but it is strongly recommended to install a local copy of MathJax 1089# before deployment. 1090 1091MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1092 1093# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1094# for the HTML output. The underlying search engine uses javascript 1095# and DHTML and should work on any modern browser. Note that when using 1096# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1097# (GENERATE_DOCSET) there is already a search function so this one should 1098# typically be disabled. For large projects the javascript based search engine 1099# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1100 1101SEARCHENGINE = YES 1102 1103# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1104# implemented using a PHP enabled web server instead of at the web client 1105# using Javascript. Doxygen will generate the search PHP script and index 1106# file to put on the web server. The advantage of the server 1107# based approach is that it scales better to large projects and allows 1108# full text search. The disadvantages are that it is more difficult to setup 1109# and does not have live searching capabilities. 1110 1111SERVER_BASED_SEARCH = NO 1112 1113#--------------------------------------------------------------------------- 1114# configuration options related to the LaTeX output 1115#--------------------------------------------------------------------------- 1116 1117# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1118# generate Latex output. 1119 1120GENERATE_LATEX = NO 1121 1122# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1123# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1124# put in front of it. If left blank `latex' will be used as the default path. 1125 1126LATEX_OUTPUT = latex 1127 1128# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1129# invoked. If left blank `latex' will be used as the default command name. 1130# Note that when enabling USE_PDFLATEX this option is only used for 1131# generating bitmaps for formulas in the HTML output, but not in the 1132# Makefile that is written to the output directory. 1133 1134LATEX_CMD_NAME = latex 1135 1136# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1137# generate index for LaTeX. If left blank `makeindex' will be used as the 1138# default command name. 1139 1140MAKEINDEX_CMD_NAME = makeindex 1141 1142# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1143# LaTeX documents. This may be useful for small projects and may help to 1144# save some trees in general. 1145 1146COMPACT_LATEX = YES 1147 1148# The PAPER_TYPE tag can be used to set the paper type that is used 1149# by the printer. Possible values are: a4, letter, legal and 1150# executive. If left blank a4wide will be used. 1151 1152PAPER_TYPE = a4 1153 1154# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1155# packages that should be included in the LaTeX output. 1156 1157EXTRA_PACKAGES = 1158 1159# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1160# the generated latex document. The header should contain everything until 1161# the first chapter. If it is left blank doxygen will generate a 1162# standard header. Notice: only use this tag if you know what you are doing! 1163 1164LATEX_HEADER = 1165 1166# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1167# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1168# contain links (just like the HTML output) instead of page references 1169# This makes the output suitable for online browsing using a pdf viewer. 1170 1171PDF_HYPERLINKS = YES 1172 1173# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1174# plain latex in the generated Makefile. Set this option to YES to get a 1175# higher quality PDF documentation. 1176 1177USE_PDFLATEX = YES 1178 1179# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1180# command to the generated LaTeX files. This will instruct LaTeX to keep 1181# running if errors occur, instead of asking the user for help. 1182# This option is also used when generating formulas in HTML. 1183 1184LATEX_BATCHMODE = NO 1185 1186# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1187# include the index chapters (such as File Index, Compound Index, etc.) 1188# in the output. 1189 1190LATEX_HIDE_INDICES = NO 1191 1192# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1193# source code with syntax highlighting in the LaTeX output. 1194# Note that which sources are shown also depends on other settings 1195# such as SOURCE_BROWSER. 1196 1197LATEX_SOURCE_CODE = NO 1198 1199#--------------------------------------------------------------------------- 1200# configuration options related to the RTF output 1201#--------------------------------------------------------------------------- 1202 1203# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1204# The RTF output is optimized for Word 97 and may not look very pretty with 1205# other RTF readers or editors. 1206 1207GENERATE_RTF = NO 1208 1209# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1210# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1211# put in front of it. If left blank `rtf' will be used as the default path. 1212 1213RTF_OUTPUT = rtf 1214 1215# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1216# RTF documents. This may be useful for small projects and may help to 1217# save some trees in general. 1218 1219COMPACT_RTF = NO 1220 1221# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1222# will contain hyperlink fields. The RTF file will 1223# contain links (just like the HTML output) instead of page references. 1224# This makes the output suitable for online browsing using WORD or other 1225# programs which support those fields. 1226# Note: wordpad (write) and others do not support links. 1227 1228RTF_HYPERLINKS = NO 1229 1230# Load stylesheet definitions from file. Syntax is similar to doxygen's 1231# config file, i.e. a series of assignments. You only have to provide 1232# replacements, missing definitions are set to their default value. 1233 1234RTF_STYLESHEET_FILE = 1235 1236# Set optional variables used in the generation of an rtf document. 1237# Syntax is similar to doxygen's config file. 1238 1239RTF_EXTENSIONS_FILE = 1240 1241#--------------------------------------------------------------------------- 1242# configuration options related to the man page output 1243#--------------------------------------------------------------------------- 1244 1245# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1246# generate man pages 1247 1248GENERATE_MAN = NO 1249 1250# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1251# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1252# put in front of it. If left blank `man' will be used as the default path. 1253 1254MAN_OUTPUT = man 1255 1256# The MAN_EXTENSION tag determines the extension that is added to 1257# the generated man pages (default is the subroutine's section .3) 1258 1259MAN_EXTENSION = .3 1260 1261# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1262# then it will generate one additional man file for each entity 1263# documented in the real man page(s). These additional files 1264# only source the real man page, but without them the man command 1265# would be unable to find the correct page. The default is NO. 1266 1267MAN_LINKS = NO 1268 1269#--------------------------------------------------------------------------- 1270# configuration options related to the XML output 1271#--------------------------------------------------------------------------- 1272 1273# If the GENERATE_XML tag is set to YES Doxygen will 1274# generate an XML file that captures the structure of 1275# the code including all documentation. 1276 1277GENERATE_XML = NO 1278 1279# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1280# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1281# put in front of it. If left blank `xml' will be used as the default path. 1282 1283XML_OUTPUT = xml 1284 1285# The XML_SCHEMA tag can be used to specify an XML schema, 1286# which can be used by a validating XML parser to check the 1287# syntax of the XML files. 1288 1289XML_SCHEMA = 1290 1291# The XML_DTD tag can be used to specify an XML DTD, 1292# which can be used by a validating XML parser to check the 1293# syntax of the XML files. 1294 1295XML_DTD = 1296 1297# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1298# dump the program listings (including syntax highlighting 1299# and cross-referencing information) to the XML output. Note that 1300# enabling this will significantly increase the size of the XML output. 1301 1302XML_PROGRAMLISTING = YES 1303 1304#--------------------------------------------------------------------------- 1305# configuration options for the AutoGen Definitions output 1306#--------------------------------------------------------------------------- 1307 1308# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1309# generate an AutoGen Definitions (see autogen.sf.net) file 1310# that captures the structure of the code including all 1311# documentation. Note that this feature is still experimental 1312# and incomplete at the moment. 1313 1314GENERATE_AUTOGEN_DEF = NO 1315 1316#--------------------------------------------------------------------------- 1317# configuration options related to the Perl module output 1318#--------------------------------------------------------------------------- 1319 1320# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1321# generate a Perl module file that captures the structure of 1322# the code including all documentation. Note that this 1323# feature is still experimental and incomplete at the 1324# moment. 1325 1326GENERATE_PERLMOD = NO 1327 1328# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1329# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1330# to generate PDF and DVI output from the Perl module output. 1331 1332PERLMOD_LATEX = NO 1333 1334# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1335# nicely formatted so it can be parsed by a human reader. This is useful 1336# if you want to understand what is going on. On the other hand, if this 1337# tag is set to NO the size of the Perl module output will be much smaller 1338# and Perl will parse it just the same. 1339 1340PERLMOD_PRETTY = YES 1341 1342# The names of the make variables in the generated doxyrules.make file 1343# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1344# This is useful so different doxyrules.make files included by the same 1345# Makefile don't overwrite each other's variables. 1346 1347PERLMOD_MAKEVAR_PREFIX = 1348 1349#--------------------------------------------------------------------------- 1350# Configuration options related to the preprocessor 1351#--------------------------------------------------------------------------- 1352 1353# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1354# evaluate all C-preprocessor directives found in the sources and include 1355# files. 1356 1357ENABLE_PREPROCESSING = NO 1358 1359# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1360# names in the source code. If set to NO (the default) only conditional 1361# compilation will be performed. Macro expansion can be done in a controlled 1362# way by setting EXPAND_ONLY_PREDEF to YES. 1363 1364MACRO_EXPANSION = NO 1365 1366# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1367# then the macro expansion is limited to the macros specified with the 1368# PREDEFINED and EXPAND_AS_DEFINED tags. 1369 1370EXPAND_ONLY_PREDEF = NO 1371 1372# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1373# in the INCLUDE_PATH (see below) will be search if a #include is found. 1374 1375SEARCH_INCLUDES = YES 1376 1377# The INCLUDE_PATH tag can be used to specify one or more directories that 1378# contain include files that are not input files but should be processed by 1379# the preprocessor. 1380 1381INCLUDE_PATH = 1382 1383# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1384# patterns (like *.h and *.hpp) to filter out the header-files in the 1385# directories. If left blank, the patterns specified with FILE_PATTERNS will 1386# be used. 1387 1388INCLUDE_FILE_PATTERNS = 1389 1390# The PREDEFINED tag can be used to specify one or more macro names that 1391# are defined before the preprocessor is started (similar to the -D option of 1392# gcc). The argument of the tag is a list of macros of the form: name 1393# or name=definition (no spaces). If the definition and the = are 1394# omitted =1 is assumed. To prevent a macro definition from being 1395# undefined via #undef or recursively expanded use the := operator 1396# instead of the = operator. 1397 1398PREDEFINED = 1399 1400# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1401# this tag can be used to specify a list of macro names that should be expanded. 1402# The macro definition that is found in the sources will be used. 1403# Use the PREDEFINED tag if you want to use a different macro definition that 1404# overrules the definition found in the source code. 1405 1406EXPAND_AS_DEFINED = 1407 1408# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1409# doxygen's preprocessor will remove all references to function-like macros 1410# that are alone on a line, have an all uppercase name, and do not end with a 1411# semicolon, because these will confuse the parser if not removed. 1412 1413SKIP_FUNCTION_MACROS = YES 1414 1415#--------------------------------------------------------------------------- 1416# Configuration::additions related to external references 1417#--------------------------------------------------------------------------- 1418 1419# The TAGFILES option can be used to specify one or more tagfiles. 1420# Optionally an initial location of the external documentation 1421# can be added for each tagfile. The format of a tag file without 1422# this location is as follows: 1423# TAGFILES = file1 file2 ... 1424# Adding location for the tag files is done as follows: 1425# TAGFILES = file1=loc1 "file2 = loc2" ... 1426# where "loc1" and "loc2" can be relative or absolute paths or 1427# URLs. If a location is present for each tag, the installdox tool 1428# does not have to be run to correct the links. 1429# Note that each tag file must have a unique name 1430# (where the name does NOT include the path) 1431# If a tag file is not located in the directory in which doxygen 1432# is run, you must also specify the path to the tagfile here. 1433 1434TAGFILES = 1435 1436# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1437# a tag file that is based on the input files it reads. 1438 1439GENERATE_TAGFILE = 1440 1441# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1442# in the class index. If set to NO only the inherited external classes 1443# will be listed. 1444 1445ALLEXTERNALS = NO 1446 1447# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1448# in the modules index. If set to NO, only the current project's groups will 1449# be listed. 1450 1451EXTERNAL_GROUPS = YES 1452 1453# The PERL_PATH should be the absolute path and name of the perl script 1454# interpreter (i.e. the result of `which perl'). 1455 1456PERL_PATH = /usr/bin/perl 1457 1458#--------------------------------------------------------------------------- 1459# Configuration options related to the dot tool 1460#--------------------------------------------------------------------------- 1461 1462# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1463# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1464# or super classes. Setting the tag to NO turns the diagrams off. Note that 1465# this option also works with HAVE_DOT disabled, but it is recommended to 1466# install and use dot, since it yields more powerful graphs. 1467 1468CLASS_DIAGRAMS = NO 1469 1470# You can define message sequence charts within doxygen comments using the \msc 1471# command. Doxygen will then run the mscgen tool (see 1472# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1473# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1474# the mscgen tool resides. If left empty the tool is assumed to be found in the 1475# default search path. 1476 1477MSCGEN_PATH = 1478 1479# If set to YES, the inheritance and collaboration graphs will hide 1480# inheritance and usage relations if the target is undocumented 1481# or is not a class. 1482 1483HIDE_UNDOC_RELATIONS = YES 1484 1485# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1486# available from the path. This tool is part of Graphviz, a graph visualization 1487# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1488# have no effect if this option is set to NO (the default) 1489 1490HAVE_DOT = NO 1491 1492# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1493# allowed to run in parallel. When set to 0 (the default) doxygen will 1494# base this on the number of processors available in the system. You can set it 1495# explicitly to a value larger than 0 to get control over the balance 1496# between CPU load and processing speed. 1497 1498DOT_NUM_THREADS = 0 1499 1500# By default doxygen will write a font called Helvetica to the output 1501# directory and reference it in all dot files that doxygen generates. 1502# When you want a differently looking font you can specify the font name 1503# using DOT_FONTNAME. You need to make sure dot is able to find the font, 1504# which can be done by putting it in a standard location or by setting the 1505# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1506# containing the font. 1507 1508DOT_FONTNAME = Helvetica 1509 1510# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1511# The default size is 10pt. 1512 1513DOT_FONTSIZE = 10 1514 1515# By default doxygen will tell dot to use the output directory to look for the 1516# FreeSans.ttf font (which doxygen will put there itself). If you specify a 1517# different font using DOT_FONTNAME you can set the path where dot 1518# can find it using this tag. 1519 1520DOT_FONTPATH = 1521 1522# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1523# will generate a graph for each documented class showing the direct and 1524# indirect inheritance relations. Setting this tag to YES will force the 1525# the CLASS_DIAGRAMS tag to NO. 1526 1527CLASS_GRAPH = NO 1528 1529# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1530# will generate a graph for each documented class showing the direct and 1531# indirect implementation dependencies (inheritance, containment, and 1532# class references variables) of the class with other documented classes. 1533 1534COLLABORATION_GRAPH = YES 1535 1536# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1537# will generate a graph for groups, showing the direct groups dependencies 1538 1539GROUP_GRAPHS = YES 1540 1541# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1542# collaboration diagrams in a style similar to the OMG's Unified Modeling 1543# Language. 1544 1545UML_LOOK = NO 1546 1547# If set to YES, the inheritance and collaboration graphs will show the 1548# relations between templates and their instances. 1549 1550TEMPLATE_RELATIONS = NO 1551 1552# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1553# tags are set to YES then doxygen will generate a graph for each documented 1554# file showing the direct and indirect include dependencies of the file with 1555# other documented files. 1556 1557INCLUDE_GRAPH = YES 1558 1559# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1560# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1561# documented header file showing the documented files that directly or 1562# indirectly include this file. 1563 1564INCLUDED_BY_GRAPH = YES 1565 1566# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1567# doxygen will generate a call dependency graph for every global function 1568# or class method. Note that enabling this option will significantly increase 1569# the time of a run. So in most cases it will be better to enable call graphs 1570# for selected functions only using the \callgraph command. 1571 1572CALL_GRAPH = NO 1573 1574# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1575# doxygen will generate a caller dependency graph for every global function 1576# or class method. Note that enabling this option will significantly increase 1577# the time of a run. So in most cases it will be better to enable caller 1578# graphs for selected functions only using the \callergraph command. 1579 1580CALLER_GRAPH = NO 1581 1582# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1583# will generate a graphical hierarchy of all classes instead of a textual one. 1584 1585GRAPHICAL_HIERARCHY = YES 1586 1587# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1588# then doxygen will show the dependencies a directory has on other directories 1589# in a graphical way. The dependency relations are determined by the #include 1590# relations between the files in the directories. 1591 1592DIRECTORY_GRAPH = YES 1593 1594# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1595# generated by dot. Possible values are png, svg, gif or svg. 1596# If left blank png will be used. 1597 1598DOT_IMAGE_FORMAT = png 1599 1600# The tag DOT_PATH can be used to specify the path where the dot tool can be 1601# found. If left blank, it is assumed the dot tool can be found in the path. 1602 1603DOT_PATH = 1604 1605# The DOTFILE_DIRS tag can be used to specify one or more directories that 1606# contain dot files that are included in the documentation (see the 1607# \dotfile command). 1608 1609DOTFILE_DIRS = 1610 1611# The MSCFILE_DIRS tag can be used to specify one or more directories that 1612# contain msc files that are included in the documentation (see the 1613# \mscfile command). 1614 1615MSCFILE_DIRS = 1616 1617# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1618# nodes that will be shown in the graph. If the number of nodes in a graph 1619# becomes larger than this value, doxygen will truncate the graph, which is 1620# visualized by representing a node as a red box. Note that doxygen if the 1621# number of direct children of the root node in a graph is already larger than 1622# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1623# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1624 1625DOT_GRAPH_MAX_NODES = 50 1626 1627# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1628# graphs generated by dot. A depth value of 3 means that only nodes reachable 1629# from the root by following a path via at most 3 edges will be shown. Nodes 1630# that lay further from the root node will be omitted. Note that setting this 1631# option to 1 or 2 may greatly reduce the computation time needed for large 1632# code bases. Also note that the size of a graph can be further restricted by 1633# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1634 1635MAX_DOT_GRAPH_DEPTH = 0 1636 1637# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1638# background. This is disabled by default, because dot on Windows does not 1639# seem to support this out of the box. Warning: Depending on the platform used, 1640# enabling this option may lead to badly anti-aliased labels on the edges of 1641# a graph (i.e. they become hard to read). 1642 1643DOT_TRANSPARENT = NO 1644 1645# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1646# files in one run (i.e. multiple -o and -T options on the command line). This 1647# makes dot run faster, but since only newer versions of dot (>1.8.10) 1648# support this, this feature is disabled by default. 1649 1650DOT_MULTI_TARGETS = YES 1651 1652# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1653# generate a legend page explaining the meaning of the various boxes and 1654# arrows in the dot generated graphs. 1655 1656GENERATE_LEGEND = YES 1657 1658# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1659# remove the intermediate dot files that are used to generate 1660# the various graphs. 1661 1662DOT_CLEANUP = YES 1663