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