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