#### /Doxyfile

#! | 1547 lines | 1121 code | 426 blank | 0 comment | 0 complexity | a1011f688cd1e1092200e0a499d255fe MD5 | raw file

Large files files are truncated, but you can click here to view the full file

   1# Doxyfile 1.7.4
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8#       TAG = value [value, ...]
9# For lists items can also be appended using:
10#       TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# 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           = PSTreeGraphView
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# Using the PROJECT_BRIEF tag one can provide an optional one line description
37# for a project that appears at the top of each page and should give viewer
38# a quick idea about the purpose of the project. Keep the description short.
39
40PROJECT_BRIEF          = "A tree graph view control for iPad applications."
41
42# With the PROJECT_LOGO tag one can specify an logo or icon that is
43# included in the documentation. The maximum height of the logo should not
44# exceed 55 pixels and the maximum width should not exceed 200 pixels.
45# Doxygen will copy the logo to the output directory.
46
47PROJECT_LOGO           =
48
49# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
50# base path where the generated documentation will be put.
51# If a relative path is entered, it will be relative to the location
52# where doxygen was started. If left blank the current directory will be used.
53
54OUTPUT_DIRECTORY       = Documentation
55
56# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
57# 4096 sub-directories (in 2 levels) under the output directory of each output
58# format and will distribute the generated files over these directories.
59# Enabling this option can be useful when feeding doxygen a huge amount of
60# source files, where putting all generated files in the same directory would
61# otherwise cause performance problems for the file system.
62
63CREATE_SUBDIRS         = NO
64
65# The OUTPUT_LANGUAGE tag is used to specify the language in which all
66# documentation generated by doxygen is written. Doxygen will use this
67# information to generate all constant output in the proper language.
68# The default language is English, other supported languages are:
69# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
70# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
71# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
72# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
73# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
74# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
75
76OUTPUT_LANGUAGE        = English
77
78# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
79# include brief member descriptions after the members that are listed in
80# the file and class documentation (similar to JavaDoc).
81# Set to NO to disable this.
82
83BRIEF_MEMBER_DESC      = YES
84
85# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
86# the brief description of a member or function before the detailed description.
87# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
88# brief descriptions will be completely suppressed.
89
90REPEAT_BRIEF           = YES
91
92# This tag implements a quasi-intelligent brief description abbreviator
93# that is used to form the text in various listings. Each string
94# in this list, if found as the leading text of the brief description, will be
95# stripped from the text and the result after processing the whole list, is
96# used as the annotated text. Otherwise, the brief description is used as-is.
97# If left blank, the following values are used ("$name" is automatically 98# replaced with the name of the entity): "The$name class" "The $name widget" 99# "The$name file" "is" "provides" "specifies" "contains"
100# "represents" "a" "an" "the"
101
102ABBREVIATE_BRIEF       = "The $name class" \ 103 "The$name widget" \
104                         "The $name file" \ 105 is \ 106 provides \ 107 specifies \ 108 contains \ 109 represents \ 110 a \ 111 an \ 112 the 113 114# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 115# Doxygen will generate a detailed section even if there is only a brief 116# description. 117 118ALWAYS_DETAILED_SEC = NO 119 120# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 121# inherited members of a class in the documentation of that class as if those 122# members were ordinary class members. Constructors, destructors and assignment 123# operators of the base classes will not be shown. 124 125INLINE_INHERITED_MEMB = NO 126 127# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 128# path before files name in the file list and in the header files. If set 129# to NO the shortest path that makes the file name unique will be used. 130 131FULL_PATH_NAMES = YES 132 133# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 134# can be used to strip a user-defined part of the path. Stripping is 135# only done if one of the specified strings matches the left-hand part of 136# the path. The tag can be used to show relative paths in the file list. 137# If left blank the directory from which doxygen is run is used as the 138# path to strip. 139 140STRIP_FROM_PATH = 141 142# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 143# the path mentioned in the documentation of a class, which tells 144# the reader which header file to include in order to use a class. 145# If left blank only the name of the header file containing the class 146# definition is used. Otherwise one should specify the include paths that 147# are normally passed to the compiler using the -I flag. 148 149STRIP_FROM_INC_PATH = 150 151# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 152# (but less readable) file names. This can be useful if your file system 153# doesn't support long names like on DOS, Mac, or CD-ROM. 154 155SHORT_NAMES = NO 156 157# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 158# will interpret the first line (until the first dot) of a JavaDoc-style 159# comment as the brief description. If set to NO, the JavaDoc 160# comments will behave just like regular Qt-style comments 161# (thus requiring an explicit @brief command for a brief description.) 162 163JAVADOC_AUTOBRIEF = YES 164 165# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 166# interpret the first line (until the first dot) of a Qt-style 167# comment as the brief description. If set to NO, the comments 168# will behave just like regular Qt-style comments (thus requiring 169# an explicit \brief command for a brief description.) 170 171QT_AUTOBRIEF = NO 172 173# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 174# treat a multi-line C++ special comment block (i.e. a block of //! or /// 175# comments) as a brief description. This used to be the default behaviour. 176# The new default is to treat a multi-line C++ comment block as a detailed 177# description. Set this tag to YES if you prefer the old behaviour instead. 178 179MULTILINE_CPP_IS_BRIEF = NO 180 181# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 182# member inherits the documentation from any documented member that it 183# re-implements. 184 185INHERIT_DOCS = YES 186 187# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 188# a new page for each member. If set to NO, the documentation of a member will 189# be part of the file/class/namespace that contains it. 190 191SEPARATE_MEMBER_PAGES = NO 192 193# The TAB_SIZE tag can be used to set the number of spaces in a tab. 194# Doxygen uses this value to replace tabs by spaces in code fragments. 195 196TAB_SIZE = 8 197 198# This tag can be used to specify a number of aliases that acts 199# as commands in the documentation. An alias has the form "name=value". 200# For example adding "sideeffect=\par Side Effects:\n" will allow you to 201# put the command \sideeffect (or @sideeffect) in the documentation, which 202# will result in a user-defined paragraph with heading "Side Effects:". 203# You can put \n's in the value part of an alias to insert newlines. 204 205ALIASES = 206 207# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 208# sources only. Doxygen will then generate output that is more tailored for C. 209# For instance, some of the names that are used will be different. The list 210# of all members will be omitted, etc. 211 212OPTIMIZE_OUTPUT_FOR_C = NO 213 214# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 215# sources only. Doxygen will then generate output that is more tailored for 216# Java. For instance, namespaces will be presented as packages, qualified 217# scopes will look different, etc. 218 219OPTIMIZE_OUTPUT_JAVA = NO 220 221# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 222# sources only. Doxygen will then generate output that is more tailored for 223# Fortran. 224 225OPTIMIZE_FOR_FORTRAN = NO 226 227# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 228# sources. Doxygen will then generate output that is tailored for 229# VHDL. 230 231OPTIMIZE_OUTPUT_VHDL = NO 232 233# Doxygen selects the parser to use depending on the extension of the files it 234# parses. With this tag you can assign which parser to use for a given extension. 235# Doxygen has a built-in mapping, but you can override or extend it using this 236# tag. The format is ext=language, where ext is a file extension, and language 237# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 238# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 239# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 240# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 241# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 242 243EXTENSION_MAPPING = 244 245# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 246# to include (a tag file for) the STL sources as input, then you should 247# set this tag to YES in order to let doxygen match functions declarations and 248# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 249# func(std::string) {}). This also makes the inheritance and collaboration 250# diagrams that involve STL classes more complete and accurate. 251 252BUILTIN_STL_SUPPORT = NO 253 254# If you use Microsoft's C++/CLI language, you should set this option to YES to 255# enable parsing support. 256 257CPP_CLI_SUPPORT = NO 258 259# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 260# Doxygen will parse them like normal C++ but will assume all classes use public 261# instead of private inheritance when no explicit protection keyword is present. 262 263SIP_SUPPORT = NO 264 265# For Microsoft's IDL there are propget and propput attributes to indicate getter 266# and setter methods for a property. Setting this option to YES (the default) 267# will make doxygen replace the get and set methods by a property in the 268# documentation. This will only work if the methods are indeed getting or 269# setting a simple type. If this is not the case, or you want to show the 270# methods anyway, you should set this option to NO. 271 272IDL_PROPERTY_SUPPORT = YES 273 274# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 275# tag is set to YES, then doxygen will reuse the documentation of the first 276# member in the group (if any) for the other members of the group. By default 277# all members of a group must be documented explicitly. 278 279DISTRIBUTE_GROUP_DOC = NO 280 281# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 282# the same type (for instance a group of public functions) to be put as a 283# subgroup of that type (e.g. under the Public Functions section). Set it to 284# NO to prevent subgrouping. Alternatively, this can be done per class using 285# the \nosubgrouping command. 286 287SUBGROUPING = YES 288 289# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 290# unions are shown inside the group in which they are included (e.g. using 291# @ingroup) instead of on a separate page (for HTML and Man pages) or 292# section (for LaTeX and RTF). 293 294INLINE_GROUPED_CLASSES = NO 295 296# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 297# is documented as struct, union, or enum with the name of the typedef. So 298# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 299# with name TypeT. When disabled the typedef will appear as a member of a file, 300# namespace, or class. And the struct will be named TypeS. This can typically 301# be useful for C code in case the coding convention dictates that all compound 302# types are typedef'ed and only the typedef is referenced, never the tag name. 303 304TYPEDEF_HIDES_STRUCT = NO 305 306# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 307# determine which symbols to keep in memory and which to flush to disk. 308# When the cache is full, less often used symbols will be written to disk. 309# For small to medium size projects (<1000 input files) the default value is 310# probably good enough. For larger projects a too small cache size can cause 311# doxygen to be busy swapping symbols to and from disk most of the time 312# causing a significant performance penalty. 313# If the system has enough physical memory increasing the cache will improve the 314# performance by keeping more symbols in memory. Note that the value works on 315# a logarithmic scale so increasing the size by one will roughly double the 316# memory usage. The cache size is given by this formula: 317# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 318# corresponding to a cache size of 2^16 = 65536 symbols 319 320SYMBOL_CACHE_SIZE = 0 321 322#--------------------------------------------------------------------------- 323# Build related configuration options 324#--------------------------------------------------------------------------- 325 326# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 327# documentation are documented, even if no documentation was available. 328# Private class members and static file members will be hidden unless 329# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 330 331EXTRACT_ALL = NO 332 333# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 334# will be included in the documentation. 335 336EXTRACT_PRIVATE = NO 337 338# If the EXTRACT_STATIC tag is set to YES all static members of a file 339# will be included in the documentation. 340 341EXTRACT_STATIC = NO 342 343# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 344# defined locally in source files will be included in the documentation. 345# If set to NO only classes defined in header files are included. 346 347EXTRACT_LOCAL_CLASSES = YES 348 349# This flag is only useful for Objective-C code. When set to YES local 350# methods, which are defined in the implementation section but not in 351# the interface are included in the documentation. 352# If set to NO (the default) only methods in the interface are included. 353 354EXTRACT_LOCAL_METHODS = NO 355 356# If this flag is set to YES, the members of anonymous namespaces will be 357# extracted and appear in the documentation as a namespace called 358# 'anonymous_namespace{file}', where file will be replaced with the base 359# name of the file that contains the anonymous namespace. By default 360# anonymous namespaces are hidden. 361 362EXTRACT_ANON_NSPACES = NO 363 364# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 365# undocumented members of documented classes, files or namespaces. 366# If set to NO (the default) these members will be included in the 367# various overviews, but no documentation section is generated. 368# This option has no effect if EXTRACT_ALL is enabled. 369 370HIDE_UNDOC_MEMBERS = NO 371 372# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 373# undocumented classes that are normally visible in the class hierarchy. 374# If set to NO (the default) these classes will be included in the various 375# overviews. This option has no effect if EXTRACT_ALL is enabled. 376 377HIDE_UNDOC_CLASSES = NO 378 379# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 380# friend (class|struct|union) declarations. 381# If set to NO (the default) these declarations will be included in the 382# documentation. 383 384HIDE_FRIEND_COMPOUNDS = NO 385 386# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 387# documentation blocks found inside the body of a function. 388# If set to NO (the default) these blocks will be appended to the 389# function's detailed documentation block. 390 391HIDE_IN_BODY_DOCS = NO 392 393# The INTERNAL_DOCS tag determines if documentation 394# that is typed after a \internal command is included. If the tag is set 395# to NO (the default) then the documentation will be excluded. 396# Set it to YES to include the internal documentation. 397 398INTERNAL_DOCS = NO 399 400# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 401# file names in lower-case letters. If set to YES upper-case letters are also 402# allowed. This is useful if you have classes or files whose names only differ 403# in case and if your file system supports case sensitive file names. Windows 404# and Mac users are advised to set this option to NO. 405 406CASE_SENSE_NAMES = YES 407 408# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 409# will show members with their full class and namespace scopes in the 410# documentation. If set to YES the scope will be hidden. 411 412HIDE_SCOPE_NAMES = NO 413 414# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 415# will put a list of the files that are included by a file in the documentation 416# of that file. 417 418SHOW_INCLUDE_FILES = YES 419 420# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 421# will list include files with double quotes in the documentation 422# rather than with sharp brackets. 423 424FORCE_LOCAL_INCLUDES = NO 425 426# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 427# is inserted in the documentation for inline members. 428 429INLINE_INFO = YES 430 431# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 432# will sort the (detailed) documentation of file and class members 433# alphabetically by member name. If set to NO the members will appear in 434# declaration order. 435 436SORT_MEMBER_DOCS = NO 437 438# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 439# brief documentation of file, namespace and class members alphabetically 440# by member name. If set to NO (the default) the members will appear in 441# declaration order. 442 443SORT_BRIEF_DOCS = NO 444 445# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 446# will sort the (brief and detailed) documentation of class members so that 447# constructors and destructors are listed first. If set to NO (the default) 448# the constructors will appear in the respective orders defined by 449# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 450# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 451# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 452 453SORT_MEMBERS_CTORS_1ST = NO 454 455# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 456# hierarchy of group names into alphabetical order. If set to NO (the default) 457# the group names will appear in their defined order. 458 459SORT_GROUP_NAMES = NO 460 461# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 462# sorted by fully-qualified names, including namespaces. If set to 463# NO (the default), the class list will be sorted only by class name, 464# not including the namespace part. 465# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 466# Note: This option applies only to the class list, not to the 467# alphabetical list. 468 469SORT_BY_SCOPE_NAME = NO 470 471# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 472# do proper type resolution of all parameters of a function it will reject a 473# match between the prototype and the implementation of a member function even 474# if there is only one candidate or it is obvious which candidate to choose 475# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 476# will still accept a match between prototype and implementation in such cases. 477 478STRICT_PROTO_MATCHING = NO 479 480# The GENERATE_TODOLIST tag can be used to enable (YES) or 481# disable (NO) the todo list. This list is created by putting \todo 482# commands in the documentation. 483 484GENERATE_TODOLIST = YES 485 486# The GENERATE_TESTLIST tag can be used to enable (YES) or 487# disable (NO) the test list. This list is created by putting \test 488# commands in the documentation. 489 490GENERATE_TESTLIST = YES 491 492# The GENERATE_BUGLIST tag can be used to enable (YES) or 493# disable (NO) the bug list. This list is created by putting \bug 494# commands in the documentation. 495 496GENERATE_BUGLIST = YES 497 498# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 499# disable (NO) the deprecated list. This list is created by putting 500# \deprecated commands in the documentation. 501 502GENERATE_DEPRECATEDLIST= YES 503 504# The ENABLED_SECTIONS tag can be used to enable conditional 505# documentation sections, marked by \if sectionname ... \endif. 506 507ENABLED_SECTIONS = 508 509# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 510# the initial value of a variable or macro consists of for it to appear in 511# the documentation. If the initializer consists of more lines than specified 512# here it will be hidden. Use a value of 0 to hide initializers completely. 513# The appearance of the initializer of individual variables and macros in the 514# documentation can be controlled using \showinitializer or \hideinitializer 515# command in the documentation regardless of this setting. 516 517MAX_INITIALIZER_LINES = 30 518 519# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 520# at the bottom of the documentation of classes and structs. If set to YES the 521# list will mention the files that were used to generate the documentation. 522 523SHOW_USED_FILES = YES 524 525# If the sources in your project are distributed over multiple directories 526# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 527# in the documentation. The default is NO. 528 529SHOW_DIRECTORIES = NO 530 531# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 532# This will remove the Files entry from the Quick Index and from the 533# Folder Tree View (if specified). The default is YES. 534 535SHOW_FILES = YES 536 537# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 538# Namespaces page. This will remove the Namespaces entry from the Quick Index 539# and from the Folder Tree View (if specified). The default is YES. 540 541SHOW_NAMESPACES = YES 542 543# The FILE_VERSION_FILTER tag can be used to specify a program or script that 544# doxygen should invoke to get the current version for each file (typically from 545# the version control system). Doxygen will invoke the program by executing (via 546# popen()) the command <command> <input-file>, where <command> is the value of 547# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 548# provided by doxygen. Whatever the program writes to standard output 549# is used as the file version. See the manual for examples. 550 551FILE_VERSION_FILTER = 552 553# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 554# by doxygen. The layout file controls the global structure of the generated 555# output files in an output format independent way. The create the layout file 556# that represents doxygen's defaults, run doxygen with the -l option. 557# You can optionally specify a file name after the option, if omitted 558# DoxygenLayout.xml will be used as the name of the layout file. 559 560LAYOUT_FILE = 561 562#--------------------------------------------------------------------------- 563# configuration options related to warning and progress messages 564#--------------------------------------------------------------------------- 565 566# The QUIET tag can be used to turn on/off the messages that are generated 567# by doxygen. Possible values are YES and NO. If left blank NO is used. 568 569QUIET = NO 570 571# The WARNINGS tag can be used to turn on/off the warning messages that are 572# generated by doxygen. Possible values are YES and NO. If left blank 573# NO is used. 574 575WARNINGS = YES 576 577# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 578# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 579# automatically be disabled. 580 581WARN_IF_UNDOCUMENTED = NO 582 583# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 584# potential errors in the documentation, such as not documenting some 585# parameters in a documented function, or documenting parameters that 586# don't exist or using markup commands wrongly. 587 588WARN_IF_DOC_ERROR = YES 589 590# The WARN_NO_PARAMDOC option can be enabled to get warnings for 591# functions that are documented, but have no documentation for their parameters 592# or return value. If set to NO (the default) doxygen will only warn about 593# wrong or incomplete parameter documentation, but not about the absence of 594# documentation. 595 596WARN_NO_PARAMDOC = NO 597 598# The WARN_FORMAT tag determines the format of the warning messages that 599# doxygen can produce. The string should contain the$file, $line, and$text
600# tags, which will be replaced by the file and line number from which the
601# warning originated and the warning text. Optionally the format may contain
602# $version, which will be replaced by the version of the file (if it could 603# be obtained via FILE_VERSION_FILTER) 604 605WARN_FORMAT = "$file:$line:$text"
606
607# The WARN_LOGFILE tag can be used to specify a file to which warning
608# and error messages should be written. If left blank the output is written
609# to stderr.
610
611WARN_LOGFILE           =
612
613#---------------------------------------------------------------------------
614# configuration options related to the input files
615#---------------------------------------------------------------------------
616
617# The INPUT tag can be used to specify the files and/or directories that contain
618# documented source files. You may enter file names like "myfile.cpp" or
619# directories like "/usr/src/myproject". Separate the files or directories
620# with spaces.
621
622INPUT                  = PSTreeGraphView
623
624# This tag can be used to specify the character encoding of the source files
625# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
626# also the default input encoding. Doxygen uses libiconv (or the iconv built
627# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
628# the list of possible encodings.
629
630INPUT_ENCODING         = UTF-8
631
632# If the value of the INPUT tag contains directories, you can use the
633# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
634# and *.h) to filter out the source-files in the directories. If left
635# blank the following patterns are tested:
636# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
637# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
638# *.f90 *.f *.for *.vhd *.vhdl
639
640FILE_PATTERNS          = *.h \
641                         *.hh \
642                         *.hxx \
643                         *.hpp \
644                         *.h++
645
646# The RECURSIVE tag can be used to turn specify whether or not subdirectories
647# should be searched for input files as well. Possible values are YES and NO.
648# If left blank NO is used.
649
650RECURSIVE              = NO
651
652# The EXCLUDE tag can be used to specify files and/or directories that should
653# excluded from the INPUT source files. This way you can easily exclude a
654# subdirectory from a directory tree whose root is specified with the INPUT tag.
655
656EXCLUDE                =
657
658# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
659# directories that are symbolic links (a Unix file system feature) are excluded
660# from the input.
661
663
664# If the value of the INPUT tag contains directories, you can use the
665# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
666# certain files from those directories. Note that the wildcards are matched
667# against the file with absolute path, so to exclude all test directories
668# for example use the pattern */test/*
669
670EXCLUDE_PATTERNS       = *Internal.*
671
672# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
673# (namespaces, classes, functions, etc.) that should be excluded from the
674# output. The symbol name can be a fully qualified name, a word, or if the
675# wildcard * is used, a substring. Examples: ANamespace, AClass,
676# AClass::ANamespace, ANamespace::*Test
677
678EXCLUDE_SYMBOLS        =
679
680# The EXAMPLE_PATH tag can be used to specify one or more files or
681# directories that contain example code fragments that are included (see
682# the \include command).
683
684EXAMPLE_PATH           =
685
686# If the value of the EXAMPLE_PATH tag contains directories, you can use the
687# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
688# and *.h) to filter out the source-files in the directories. If left
689# blank all files are included.
690
691EXAMPLE_PATTERNS       = *
692
693# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
694# searched for input files to be used with the \include or \dontinclude
695# commands irrespective of the value of the RECURSIVE tag.
696# Possible values are YES and NO. If left blank NO is used.
697
698EXAMPLE_RECURSIVE      = NO
699
700# The IMAGE_PATH tag can be used to specify one or more files or
701# directories that contain image that are included in the documentation (see
702# the \image command).
703
704IMAGE_PATH             =
705
706# The INPUT_FILTER tag can be used to specify a program that doxygen should
707# invoke to filter for each input file. Doxygen will invoke the filter program
708# by executing (via popen()) the command <filter> <input-file>, where <filter>
709# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
710# input file. Doxygen will then use the output that the filter program writes
711# to standard output.  If FILTER_PATTERNS is specified, this tag will be
712# ignored.
713
714INPUT_FILTER           =
715
716# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
717# basis.  Doxygen will compare the file name with each pattern and apply the
718# filter if there is a match.  The filters are a list of the form:
719# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
720# info on how filters are used. If FILTER_PATTERNS is empty or if
721# non of the patterns match the file name, INPUT_FILTER is applied.
722
723FILTER_PATTERNS        =
724
725# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
726# INPUT_FILTER) will be used to filter the input files when producing source
727# files to browse (i.e. when SOURCE_BROWSER is set to YES).
728
729FILTER_SOURCE_FILES    = NO
730
731# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
732# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
733# and it is also possible to disable source filtering for a specific pattern
734# using *.ext= (so without naming a filter). This option only has effect when
735# FILTER_SOURCE_FILES is enabled.
736
737FILTER_SOURCE_PATTERNS =
738
739#---------------------------------------------------------------------------
740# configuration options related to source browsing
741#---------------------------------------------------------------------------
742
743# If the SOURCE_BROWSER tag is set to YES then a list of source files will
744# be generated. Documented entities will be cross-referenced with these sources.
745# Note: To get rid of all source code in the generated output, make sure also
746# VERBATIM_HEADERS is set to NO.
747
748SOURCE_BROWSER         = NO
749
750# Setting the INLINE_SOURCES tag to YES will include the body
751# of functions and classes directly in the documentation.
752
753INLINE_SOURCES         = NO
754
755# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
756# doxygen to hide any special comment blocks from generated source code
757# fragments. Normal C and C++ comments will always remain visible.
758
760
761# If the REFERENCED_BY_RELATION tag is set to YES
762# then for each documented function all documented
763# functions referencing it will be listed.
764
765REFERENCED_BY_RELATION = NO
766
767# If the REFERENCES_RELATION tag is set to YES
768# then for each documented function all documented entities
769# called/used by that function will be listed.
770
771REFERENCES_RELATION    = NO
772
773# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
774# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
775# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
776# link to the source code.  Otherwise they will link to the documentation.
777
779
780# If the USE_HTAGS tag is set to YES then the references to source code
781# will point to the HTML generated by the htags(1) tool instead of doxygen
782# built-in source browser. The htags tool is part of GNU's global source
783# tagging system (see http://www.gnu.org/software/global/global.html). You
784# will need version 4.8.6 or higher.
785
786USE_HTAGS              = NO
787
788# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
789# will generate a verbatim copy of the header file for each class for
790# which an include is specified. Set to NO to disable this.
791
793
794#---------------------------------------------------------------------------
795# configuration options related to the alphabetical class index
796#---------------------------------------------------------------------------
797
798# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
799# of all compounds will be generated. Enable this if the project
800# contains a lot of classes, structs, unions or interfaces.
801
802ALPHABETICAL_INDEX     = YES
803
804# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
805# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
806# in which this list will be split (can be a number in the range [1..20])
807
808COLS_IN_ALPHA_INDEX    = 5
809
810# In case all classes in a project start with a common prefix, all
811# classes will be put under the same header in the alphabetical index.
812# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
813# should be ignored while generating the index headers.
814
815IGNORE_PREFIX          =
816
817#---------------------------------------------------------------------------
818# configuration options related to the HTML output
819#---------------------------------------------------------------------------
820
821# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
822# generate HTML output.
823
824GENERATE_HTML          = YES
825
826# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
827# If a relative path is entered the value of OUTPUT_DIRECTORY will be
828# put in front of it. If left blank html' will be used as the default path.
829
830HTML_OUTPUT            = html
831
832# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
833# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
834# doxygen will generate files with .html extension.
835
836HTML_FILE_EXTENSION    = .html
837
838# The HTML_HEADER tag can be used to specify a personal HTML header for
839# each generated HTML page. If it is left blank doxygen will generate a
840# standard header. Note that when using a custom header you are responsible
841# for the proper inclusion of any scripts and style sheets that doxygen
842# needs, which is dependent on the configuration options used.
843# It is adviced to generate a default header using "doxygen -w html
844# header.html footer.html stylesheet.css YourConfigFile" and then modify
845# that header. Note that the header is subject to change so you typically
846# have to redo this when upgrading to a newer version of doxygen or when
847# changing the value of configuration settings such as GENERATE_TREEVIEW!
848
850
851# The HTML_FOOTER tag can be used to specify a personal HTML footer for
852# each generated HTML page. If it is left blank doxygen will generate a
853# standard footer.
854
855HTML_FOOTER            =
856
857# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
858# style sheet that is used by each HTML page. It can be used to
859# fine-tune the look of the HTML output. If the tag is left blank doxygen
860# will generate a default style sheet. Note that doxygen will try to copy
861# the style sheet file to the HTML output directory, so don't put your own
862# stylesheet in the HTML output directory as well, or it will be erased!
863
864HTML_STYLESHEET        =
865
866# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
867# other source files which should be copied to the HTML output directory. Note
868# that these files will be copied to the base HTML output directory. Use the
869# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
870# files. In the HTML_STYLESHEET file, use the file name only. Also note that
871# the files will be copied as-is; there are no commands or markers available.
872
873HTML_EXTRA_FILES       =
874
875# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
876# Doxygen will adjust the colors in the stylesheet and background images
877# according to this color. Hue is specified as an angle on a colorwheel,
879# For instance the value 0 represents red, 60 is yellow, 120 is green,
880# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
881# The allowed range is 0 to 359.
882
883HTML_COLORSTYLE_HUE    = 220
884
885# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
886# the colors in the HTML output. For a value of 0 the output will use
887# grayscales only. A value of 255 will produce the most vivid colors.
888
889HTML_COLORSTYLE_SAT    = 100
890
891# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
892# the luminance component of the colors in the HTML output. Values below
893# 100 gradually make the output lighter, whereas values above 100 make
894# the output darker. The value divided by 100 is the actual gamma applied,
895# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
896# and 100 does not change the gamma.
897
898HTML_COLORSTYLE_GAMMA  = 80
899
900# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
901# page will contain the date and time when the page was generated. Setting
902# this to NO can help when comparing the output of multiple runs.
903
904HTML_TIMESTAMP         = YES
905
906# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
907# files or namespaces will be aligned in HTML using tables. If set to
908# NO a bullet list will be used.
909
910HTML_ALIGN_MEMBERS     = YES
911
912# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
913# documentation will contain sections that can be hidden and shown after the
914# page has loaded. For this to work a browser that supports
915# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
916# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
917
918HTML_DYNAMIC_SECTIONS  = YES
919
920# If the GENERATE_DOCSET tag is set to YES, additional index files
921# will be generated that can be used as input for Apple's Xcode 3
922# integrated development environment, introduced with OSX 10.5 (Leopard).
923# To create a documentation set, doxygen will generate a Makefile in the
924# HTML output directory. Running make will produce the docset in that
925# directory and running "make install" will install the docset in
926# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
927# it at startup.
928# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
930
931GENERATE_DOCSET        = NO
932
933# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
934# feed. A documentation feed provides an umbrella under which multiple
935# documentation sets from a single provider (such as a company or product suite)
936# can be grouped.
937
938DOCSET_FEEDNAME        = "Doxygen generated docs"
939
940# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
941# should uniquely identify the documentation set bundle. This should be a
942# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
943# will append .docset to the name.
944
945DOCSET_BUNDLE_ID       = org.doxygen.Project
946
947# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
948# the documentation publisher. This should be a reverse domain-name style
949# string, e.g. com.mycompany.MyDocSet.documentation.
950
951DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
952
953# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
954
955DOCSET_PUBLISHER_NAME  = Publisher
956
957# If the GENERATE_HTMLHELP tag is set to YES, additional index files
958# will be generated that can be used as input for tools like the
959# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
960# of the generated HTML documentation.
961
962GENERATE_HTMLHELP      = NO
963
964# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
965# be used to specify the file name of the resulting .chm file. You
966# can add a path in front of the file if the result should not be
967# written to the html output directory.
968
969CHM_FILE               =
970
971# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
972# be used to specify the location (absolute path including file name) of
973# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
974# the HTML help compiler on the generated index.hhp.
975
976HHC_LOCATION           =
977
978# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
979# controls if a separate .chi index file is generated (YES) or that
980# it should be included in the master .chm file (NO).
981
982GENERATE_CHI           = NO
983
984# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
985# is used to encode HtmlHelp index (hhk), content (hhc) and project file
986# content.
987
988CHM_INDEX_ENCODING     =
989
990# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
993
994BINARY_TOC             = NO
995
996# The TOC_EXPAND flag can be set to YES to add extra items for group members
997# to the contents of the HTML help documentation and to the tree view.
998
999TOC_EXPAND             = NO
1000
1001# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1002# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1003# that can be used as input for Qt's qhelpgenerator to generate a
1004# Qt Compressed Help (.qch) of the generated HTML documentation.
1005
1006GENERATE_QHP           = NO
1007
1008# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1009# be used to specify the file name of the resulting .qch file.
1010# The path specified is relative to the HTML output folder.
1011
1012QCH_FILE               =
1013
1014# The QHP_NAMESPACE tag specifies the namespace to use when generating
1016# http://doc.trolltech.com/qthelpproject.html#namespace
1017
1018QHP_NAMESPACE          = org.doxygen.Project
1019
1020# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1022# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1023
1024QHP_VIRTUAL_FOLDER     = doc
1025
1026# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1028# http://doc.trolltech.com/qthelpproject.html#custom-filters
1029
1030QHP_CUST_FILTER_NAME   =
1031
1032# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1034# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1035# Qt Help Project / Custom Filters</a>.
1036
1037QHP_CUST_FILTER_ATTRS  =
1038
1039# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1040# project's
1041# filter section matches.
1042# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1043# Qt Help Project / Filter Attributes</a>.
1044
1045QHP_SECT_FILTER_ATTRS  =
1046
1047# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1048# be used to specify the location of Qt's qhelpgenerator.
1049# If non-empty doxygen will try to run qhelpgenerator on the generated
1050# .qhp file.
1051
1052QHG_LOCATION           =
1053
1054# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1055# will be generated, which together with the HTML files, form an Eclipse help
1056# plugin. To install this plugin and make it available under the help contents
1057# menu in Eclipse, the contents of the directory containing the HTML and XML
1058# files needs to be copied into the plugins directory of eclipse. The name of
1059# the directory within the plugins directory should be the same as
1060# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1061# the help appears.
1062
1063GENERATE_ECLIPSEHELP   = NO
1064
1065# A unique identifier for the eclipse help plugin. When installing the plugin
1066# the directory name containing the HTML and XML files should also have
1067# this name.
1068
1069ECLIPSE_DOC_ID         = org.doxygen.Project
1070
1071# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1072# top of each HTML page. The value NO (the default) enables the index and
1073# the value YES disables it.
1074
1075DISABLE_INDEX          = NO
1076
1077# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1078# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1079# documentation. Note that a value of 0 will completely suppress the enum
1080# values from appearing in the overview section.
1081
1082ENUM_VALUES_PER_LINE   = 4
1083
1084# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1085# structure should be generated to display hierarchical information.
1086# If the tag value is set to YES, a side panel will be generated
1087# containing a tree-like index structure (just like the one that
1088# is generated for HTML Help). For this to work a browser that supports
1089# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1090# Windows users are probably better off using the HTML help feature.
1091
1092GENERATE_TREEVIEW      = YES
1093
1094# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1095# and Class Hierarchy pages using a tree view instead of an ordered list.
1096
1097USE_INLINE_TREES       = NO
1098
1099# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1100# used to set the initial width (in pixels) of the frame in which the tree
1101# is shown.
1102
1103TREEVIEW_WIDTH         = 250
1104
1105# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1106# links to external symbols imported via tag files in a separate window.
1107
1109
1110# Use this tag to change the font size of Latex formulas included
1111# as images in the HTML documentation. The default is 10. Note that
1112# when you change the font size after a successful doxygen run you need
1113# to manually remove any form_*.png images from the HTML output directory
1114# to force them to be regenerated.
1115
1116FORMULA_FONTSIZE       = 10
1117
1118# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1119# generated for formulas are transparent PNGs. Transparent PNGs are
1120# not supported properly for IE 6.0, but are supported on all modern browsers.
1121# Note that when changing this option you need to delete any form_*.png files
1122# in the HTML output before the changes have effect.
1123
1124FORMULA_TRANSPARENT    = YES
1125
1126# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1127# (see http://www.mathjax.org) which uses client side Javascript for the
1128# rendering instead of using prerendered bitmaps. Use this if you do not
1129# have LaTeX installed or if you want to formulas look prettier in the HTML
1130# output. When enabled you also need to install MathJax separately and
1131# configure the path to it using the MATHJAX_RELPATH option.
1132
1133USE_MATHJAX            = NO
1134
1135# When MathJax is enabled you need to specify the location relative to the
1136# HTML output directory using the MATHJAX_RELPATH option. The destination
1137# directory should contain the MathJax.js script. For instance, if the mathjax
1138# directory is located at the same level as the HTML output directory, then
1139# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1140# mathjax.org site, so you can quickly see the result without installing
1141# MathJax, but it is strongly recommended to install a local copy of MathJax
1142# before deployment.
1143
1144MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1145
1146# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1147# for the HTML output. The underlying search engine uses javascript
1148# and DHTML and should work on any modern browser. Note that when using
1149# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1150# (GENERATE_DOCSET) there is already a search function so this one should
1151# typically be disabled. For large projects the javascript based search engine
1152# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1153
1154SEARCHENGINE           = YES
1155
1156# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1157# implemented using a PHP enabled web server instead of at the web client
1158# using Javascript. Doxygen will generate the search PHP script and index
1159# file to put on the web server. The advantage …`

Large files files are truncated, but you can click here to view the full file