1# Doxyfile 1.8.3 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 = OGRE 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 = master 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 = "Object-Oriented Graphics Rendering Engine" 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 = "Docs/ogre-logo-wetfloor.gif" 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 = "build/api/" 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 = YES 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 = YES 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 = NO 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 = 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 = 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 = YES 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 = 4 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 = material=C++ compositor=C++ particle=C++ txt=Python glsl=C++ 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 293# getter and setter methods for a property. Setting this option to YES (the 294# default) will make doxygen replace the get and set methods by a property in 295# the documentation. This will only work if the methods are indeed getting or 296# setting a simple type. If this is not the case, or you want to show the 297# methods anyway, you should set this option to NO. 298 299IDL_PROPERTY_SUPPORT = YES 300 301# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 302# tag is set to YES, then doxygen will reuse the documentation of the first 303# member in the group (if any) for the other members of the group. By default 304# all members of a group must be documented explicitly. 305 306DISTRIBUTE_GROUP_DOC = NO 307 308# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 309# the same type (for instance a group of public functions) to be put as a 310# subgroup of that type (e.g. under the Public Functions section). Set it to 311# NO to prevent subgrouping. Alternatively, this can be done per class using 312# the \nosubgrouping command. 313 314SUBGROUPING = YES 315 316# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 317# unions are shown inside the group in which they are included (e.g. using 318# @ingroup) instead of on a separate page (for HTML and Man pages) or 319# section (for LaTeX and RTF). 320 321INLINE_GROUPED_CLASSES = NO 322 323# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 324# unions with only public data fields will be shown inline in the documentation 325# of the scope in which they are defined (i.e. file, namespace, or group 326# documentation), provided this scope is documented. If set to NO (the default), 327# structs, classes, and unions are shown on a separate page (for HTML and Man 328# pages) or section (for LaTeX and RTF). 329 330INLINE_SIMPLE_STRUCTS = NO 331 332# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 333# is documented as struct, union, or enum with the name of the typedef. So 334# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 335# with name TypeT. When disabled the typedef will appear as a member of a file, 336# namespace, or class. And the struct will be named TypeS. This can typically 337# be useful for C code in case the coding convention dictates that all compound 338# types are typedef'ed and only the typedef is referenced, never the tag name. 339 340TYPEDEF_HIDES_STRUCT = NO 341 342# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 343# cache is used to resolve symbols given their name and scope. Since this can be 344# an expensive process and often the same symbol appears multiple times in the 345# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 346# doxygen will become slower. If the cache is too large, memory is wasted. The 347# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 348# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 349# symbols. At the end of a run doxygen will report the cache usage and suggest 350# the optimal cache size from a speed point of view. 351# Minimum value: 0, maximum value: 9, default value: 0. 352 353LOOKUP_CACHE_SIZE = 1 354 355#--------------------------------------------------------------------------- 356# Build related configuration options 357#--------------------------------------------------------------------------- 358 359# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 360# documentation are documented, even if no documentation was available. 361# Private class members and static file members will be hidden unless 362# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 363 364EXTRACT_ALL = YES 365 366# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 367# will be included in the documentation. 368 369EXTRACT_PRIVATE = NO 370 371# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 372# scope will be included in the documentation. 373 374EXTRACT_PACKAGE = NO 375 376# If the EXTRACT_STATIC tag is set to YES all static members of a file 377# will be included in the documentation. 378 379EXTRACT_STATIC = YES 380 381# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 382# defined locally in source files will be included in the documentation. 383# If set to NO only classes defined in header files are included. 384 385EXTRACT_LOCAL_CLASSES = YES 386 387# This flag is only useful for Objective-C code. When set to YES local 388# methods, which are defined in the implementation section but not in 389# the interface are included in the documentation. 390# If set to NO (the default) only methods in the interface are included. 391 392EXTRACT_LOCAL_METHODS = NO 393 394# If this flag is set to YES, the members of anonymous namespaces will be 395# extracted and appear in the documentation as a namespace called 396# 'anonymous_namespace{file}', where file will be replaced with the base 397# name of the file that contains the anonymous namespace. By default 398# anonymous namespaces are hidden. 399 400EXTRACT_ANON_NSPACES = NO 401 402# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 403# undocumented members of documented classes, files or namespaces. 404# If set to NO (the default) these members will be included in the 405# various overviews, but no documentation section is generated. 406# This option has no effect if EXTRACT_ALL is enabled. 407 408HIDE_UNDOC_MEMBERS = NO 409 410# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 411# undocumented classes that are normally visible in the class hierarchy. 412# If set to NO (the default) these classes will be included in the various 413# overviews. This option has no effect if EXTRACT_ALL is enabled. 414 415HIDE_UNDOC_CLASSES = NO 416 417# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 418# friend (class|struct|union) declarations. 419# If set to NO (the default) these declarations will be included in the 420# documentation. 421 422HIDE_FRIEND_COMPOUNDS = NO 423 424# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 425# documentation blocks found inside the body of a function. 426# If set to NO (the default) these blocks will be appended to the 427# function's detailed documentation block. 428 429HIDE_IN_BODY_DOCS = NO 430 431# The INTERNAL_DOCS tag determines if documentation 432# that is typed after a \internal command is included. If the tag is set 433# to NO (the default) then the documentation will be excluded. 434# Set it to YES to include the internal documentation. 435 436INTERNAL_DOCS = NO 437 438# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 439# file names in lower-case letters. If set to YES upper-case letters are also 440# allowed. This is useful if you have classes or files whose names only differ 441# in case and if your file system supports case sensitive file names. Windows 442# and Mac users are advised to set this option to NO. 443 444CASE_SENSE_NAMES = NO 445 446# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 447# will show members with their full class and namespace scopes in the 448# documentation. If set to YES the scope will be hidden. 449 450HIDE_SCOPE_NAMES = NO 451 452# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 453# will put a list of the files that are included by a file in the documentation 454# of that file. 455 456SHOW_INCLUDE_FILES = YES 457 458# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 459# will list include files with double quotes in the documentation 460# rather than with sharp brackets. 461 462FORCE_LOCAL_INCLUDES = NO 463 464# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 465# is inserted in the documentation for inline members. 466 467INLINE_INFO = YES 468 469# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 470# will sort the (detailed) documentation of file and class members 471# alphabetically by member name. If set to NO the members will appear in 472# declaration order. 473 474SORT_MEMBER_DOCS = NO 475 476# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 477# brief documentation of file, namespace and class members alphabetically 478# by member name. If set to NO (the default) the members will appear in 479# declaration order. 480 481SORT_BRIEF_DOCS = YES 482 483# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 484# will sort the (brief and detailed) documentation of class members so that 485# constructors and destructors are listed first. If set to NO (the default) 486# the constructors will appear in the respective orders defined by 487# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 488# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 489# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 490 491SORT_MEMBERS_CTORS_1ST = YES 492 493# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 494# hierarchy of group names into alphabetical order. If set to NO (the default) 495# the group names will appear in their defined order. 496 497SORT_GROUP_NAMES = YES 498 499# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 500# sorted by fully-qualified names, including namespaces. If set to 501# NO (the default), the class list will be sorted only by class name, 502# not including the namespace part. 503# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 504# Note: This option applies only to the class list, not to the 505# alphabetical list. 506 507SORT_BY_SCOPE_NAME = YES 508 509# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 510# do proper type resolution of all parameters of a function it will reject a 511# match between the prototype and the implementation of a member function even 512# if there is only one candidate or it is obvious which candidate to choose 513# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 514# will still accept a match between prototype and implementation in such cases. 515 516STRICT_PROTO_MATCHING = NO 517 518# The GENERATE_TODOLIST tag can be used to enable (YES) or 519# disable (NO) the todo list. This list is created by putting \todo 520# commands in the documentation. 521 522GENERATE_TODOLIST = NO 523 524# The GENERATE_TESTLIST tag can be used to enable (YES) or 525# disable (NO) the test list. This list is created by putting \test 526# commands in the documentation. 527 528GENERATE_TESTLIST = YES 529 530# The GENERATE_BUGLIST tag can be used to enable (YES) or 531# disable (NO) the bug list. This list is created by putting \bug 532# commands in the documentation. 533 534GENERATE_BUGLIST = YES 535 536# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 537# disable (NO) the deprecated list. This list is created by putting 538# \deprecated commands in the documentation. 539 540GENERATE_DEPRECATEDLIST= YES 541 542# The ENABLED_SECTIONS tag can be used to enable conditional 543# documentation sections, marked by \if section-label ... \endif 544# and \cond section-label ... \endcond blocks. 545 546ENABLED_SECTIONS = 547 548# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 549# the initial value of a variable or macro consists of for it to appear in 550# the documentation. If the initializer consists of more lines than specified 551# here it will be hidden. Use a value of 0 to hide initializers completely. 552# The appearance of the initializer of individual variables and macros in the 553# documentation can be controlled using \showinitializer or \hideinitializer 554# command in the documentation regardless of this setting. 555 556MAX_INITIALIZER_LINES = 30 557 558# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 559# at the bottom of the documentation of classes and structs. If set to YES the 560# list will mention the files that were used to generate the documentation. 561 562SHOW_USED_FILES = YES 563 564# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 565# This will remove the Files entry from the Quick Index and from the 566# Folder Tree View (if specified). The default is YES. 567 568SHOW_FILES = YES 569 570# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 571# Namespaces page. 572# This will remove the Namespaces entry from the Quick Index 573# and from the Folder Tree View (if specified). The default is YES. 574 575SHOW_NAMESPACES = YES 576 577# The FILE_VERSION_FILTER tag can be used to specify a program or script that 578# doxygen should invoke to get the current version for each file (typically from 579# the version control system). Doxygen will invoke the program by executing (via 580# popen()) the command <command> <input-file>, where <command> is the value of 581# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 582# provided by doxygen. Whatever the program writes to standard output 583# is used as the file version. See the manual for examples. 584 585FILE_VERSION_FILTER = 586 587# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 588# by doxygen. The layout file controls the global structure of the generated 589# output files in an output format independent way. To create the layout file 590# that represents doxygen's defaults, run doxygen with the -l option. 591# You can optionally specify a file name after the option, if omitted 592# DoxygenLayout.xml will be used as the name of the layout file. 593 594LAYOUT_FILE = 595 596# The CITE_BIB_FILES tag can be used to specify one or more bib files 597# containing the references data. This must be a list of .bib files. The 598# .bib extension is automatically appended if omitted. Using this command 599# requires the bibtex tool to be installed. See also 600# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 601# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 602# feature you need bibtex and perl available in the search path. Do not use 603# file names with spaces, bibtex cannot handle them. 604 605CITE_BIB_FILES = "Docs/src/bibliography.bib" 606 607# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 608# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 609# http://en.wikipedia.org/wiki/BibTeX for more info. 610 611LATEX_BIB_STYLE = plain 612 613#--------------------------------------------------------------------------- 614# configuration options related to warning and progress messages 615#--------------------------------------------------------------------------- 616 617# The QUIET tag can be used to turn on/off the messages that are generated 618# by doxygen. Possible values are YES and NO. If left blank NO is used. 619 620QUIET = NO 621 622# The WARNINGS tag can be used to turn on/off the warning messages that are 623# generated by doxygen. Possible values are YES and NO. If left blank 624# NO is used. 625 626WARNINGS = YES 627 628# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 629# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 630# automatically be disabled. 631 632WARN_IF_UNDOCUMENTED = YES 633 634# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 635# potential errors in the documentation, such as not documenting some 636# parameters in a documented function, or documenting parameters that 637# don't exist or using markup commands wrongly. 638 639WARN_IF_DOC_ERROR = YES 640 641# The WARN_NO_PARAMDOC option can be enabled to get warnings for 642# functions that are documented, but have no documentation for their parameters 643# or return value. If set to NO (the default) doxygen will only warn about 644# wrong or incomplete parameter documentation, but not about the absence of 645# documentation. 646 647WARN_NO_PARAMDOC = NO 648 649# The WARN_FORMAT tag determines the format of the warning messages that 650# doxygen can produce. The string should contain the $file, $line, and $text 651# tags, which will be replaced by the file and line number from which the 652# warning originated and the warning text. Optionally the format may contain 653# $version, which will be replaced by the version of the file (if it could 654# be obtained via FILE_VERSION_FILTER) 655 656WARN_FORMAT = "$file:$line: $text" 657 658# The WARN_LOGFILE tag can be used to specify a file to which warning 659# and error messages should be written. If left blank the output is written 660# to stderr. 661 662WARN_LOGFILE = "build/doxygen_warnings.log" 663 664#--------------------------------------------------------------------------- 665# configuration options related to the input files 666#--------------------------------------------------------------------------- 667 668# The INPUT tag can be used to specify the files and/or directories that contain 669# documented source files. You may enter file names like "myfile.cpp" or 670# directories like "/usr/src/myproject". Separate the files or directories 671# with spaces. 672 673INPUT = OgreMain/include \ 674 Components \ 675 PlugIns \ 676 PlugIns/PCZSceneManager/docs/readme.md \ 677 RenderSystems \ 678 Docs/src/apimainpage.md \ 679 Docs/src/manual.md \ 680 Docs/src/OgreShadows.md \ 681 Docs/src/scripts.md \ 682 Docs/src/material-scripts.md \ 683 Docs/src/high-level-programs.md \ 684 Docs/src/particle-scripts.md \ 685 Docs/src/hardware-buffers.md \ 686 Docs/src/hlms.md \ 687 Docs/src/rtss.md \ 688 Docs/src/resourcemanagement.md \ 689 BuildingOgre.md \ 690 Docs/src/tutorials/deferred.md \ 691 Docs/src/tutorials/external_texture.md \ 692 Docs/src/tutorials/manualmesh.md \ 693 Docs/src/tutorials/numpy.md \ 694 Docs/src/tutorials/profiler.md \ 695 Docs/src/tutorials/setup.md \ 696 Docs/src/tutorials/trays.md \ 697 Docs/src/tutorials/tutorials.md \ 698 Docs/src/tutorials/volume.md \ 699 Docs/src/tutorials/basictutorials/basictutorial1.md \ 700 Docs/src/tutorials/basictutorials/basictutorial2.md 701 702# This tag can be used to specify the character encoding of the source files 703# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 704# also the default input encoding. Doxygen uses libiconv (or the iconv built 705# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 706# the list of possible encodings. 707 708INPUT_ENCODING = UTF-8 709 710# If the value of the INPUT tag contains directories, you can use the 711# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 712# and *.h) to filter out the source-files in the directories. If left 713# blank the following patterns are tested: 714# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 715# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 716# *.f90 *.f *.for *.vhd *.vhdl 717 718FILE_PATTERNS = Ogre*.h 719 720# The RECURSIVE tag can be used to turn specify whether or not subdirectories 721# should be searched for input files as well. Possible values are YES and NO. 722# If left blank NO is used. 723 724RECURSIVE = YES 725 726# The EXCLUDE tag can be used to specify files and/or directories that should be 727# excluded from the INPUT source files. This way you can easily exclude a 728# subdirectory from a directory tree whose root is specified with the INPUT tag. 729# Note that relative paths are relative to the directory from which doxygen is 730# run. 731 732EXCLUDE = 733 734# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 735# directories that are symbolic links (a Unix file system feature) are excluded 736# from the input. 737 738EXCLUDE_SYMLINKS = NO 739 740# If the value of the INPUT tag contains directories, you can use the 741# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 742# certain files from those directories. Note that the wildcards are matched 743# against the file with absolute path, so to exclude all test directories 744# for example use the pattern */test/* 745 746EXCLUDE_PATTERNS = *UTF* \ 747 */GLSupport/include/EGL/* \ 748 */GLSupport/include/GLX/* \ 749 */GLSupport/include/OSX/* \ 750 */GLSupport/include/win32/* \ 751 *EAGL* \ 752 */RenderSystems/GLES/* 753 754# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 755# (namespaces, classes, functions, etc.) that should be excluded from the 756# output. The symbol name can be a fully qualified name, a word, or if the 757# wildcard * is used, a substring. Examples: ANamespace, AClass, 758# AClass::ANamespace, ANamespace::*Test 759 760EXCLUDE_SYMBOLS = 761 762# The EXAMPLE_PATH tag can be used to specify one or more files or 763# directories that contain example code fragments that are included (see 764# the \include command). 765 766EXAMPLE_PATH = "." 767 768# If the value of the EXAMPLE_PATH tag contains directories, you can use the 769# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 770# and *.h) to filter out the source-files in the directories. If left 771# blank all files are included. 772 773EXAMPLE_PATTERNS = 774 775# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 776# searched for input files to be used with the \include or \dontinclude 777# commands irrespective of the value of the RECURSIVE tag. 778# Possible values are YES and NO. If left blank NO is used. 779 780EXAMPLE_RECURSIVE = NO 781 782# The IMAGE_PATH tag can be used to specify one or more files or 783# directories that contain image that are included in the documentation (see 784# the \image command). 785 786IMAGE_PATH = "Docs/src/tutorials/" \ 787 "Docs/src/images/" 788 789# The INPUT_FILTER tag can be used to specify a program that doxygen should 790# invoke to filter for each input file. Doxygen will invoke the filter program 791# by executing (via popen()) the command <filter> <input-file>, where <filter> 792# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 793# input file. Doxygen will then use the output that the filter program writes 794# to standard output. 795# If FILTER_PATTERNS is specified, this tag will be 796# ignored. 797 798INPUT_FILTER = 799 800# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 801# basis. 802# Doxygen will compare the file name with each pattern and apply the 803# filter if there is a match. 804# The filters are a list of the form: 805# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 806# info on how filters are used. If FILTER_PATTERNS is empty or if 807# non of the patterns match the file name, INPUT_FILTER is applied. 808 809FILTER_PATTERNS = 810 811# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 812# INPUT_FILTER) will be used to filter the input files when producing source 813# files to browse (i.e. when SOURCE_BROWSER is set to YES). 814 815FILTER_SOURCE_FILES = NO 816 817# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 818# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 819# and it is also possible to disable source filtering for a specific pattern 820# using *.ext= (so without naming a filter). This option only has effect when 821# FILTER_SOURCE_FILES is enabled. 822 823FILTER_SOURCE_PATTERNS = 824 825# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that 826# is part of the input, its contents will be placed on the main page (index.html). 827# This can be useful if you have a project on for instance GitHub and want reuse 828# the introduction page also for the doxygen output. 829 830USE_MDFILE_AS_MAINPAGE = 831 832#--------------------------------------------------------------------------- 833# configuration options related to source browsing 834#--------------------------------------------------------------------------- 835 836# If the SOURCE_BROWSER tag is set to YES then a list of source files will 837# be generated. Documented entities will be cross-referenced with these sources. 838# Note: To get rid of all source code in the generated output, make sure also 839# VERBATIM_HEADERS is set to NO. 840 841SOURCE_BROWSER = NO 842 843# Setting the INLINE_SOURCES tag to YES will include the body 844# of functions and classes directly in the documentation. 845 846INLINE_SOURCES = NO 847 848# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 849# doxygen to hide any special comment blocks from generated source code 850# fragments. Normal C, C++ and Fortran comments will always remain visible. 851 852STRIP_CODE_COMMENTS = YES 853 854# If the REFERENCED_BY_RELATION tag is set to YES 855# then for each documented function all documented 856# functions referencing it will be listed. 857 858REFERENCED_BY_RELATION = YES 859 860# If the REFERENCES_RELATION tag is set to YES 861# then for each documented function all documented entities 862# called/used by that function will be listed. 863 864REFERENCES_RELATION = YES 865 866# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 867# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 868# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 869# link to the source code. 870# Otherwise they will link to the documentation. 871 872REFERENCES_LINK_SOURCE = YES 873 874# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 875# source code will show a tooltip with additional information such as prototype, 876# brief description and links to the definition and documentation. Since this 877# will make the HTML file larger and loading of large files a bit slower, you 878# can opt to disable this feature. 879# The default value is: YES. 880# This tag requires that the tag SOURCE_BROWSER is set to YES. 881 882SOURCE_TOOLTIPS = YES 883# If the USE_HTAGS tag is set to YES then the references to source code 884# will point to the HTML generated by the htags(1) tool instead of doxygen 885# built-in source browser. The htags tool is part of GNU's global source 886# tagging system (see http://www.gnu.org/software/global/global.html). You 887# will need version 4.8.6 or higher. 888 889USE_HTAGS = NO 890 891# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 892# will generate a verbatim copy of the header file for each class for 893# which an include is specified. Set to NO to disable this. 894 895VERBATIM_HEADERS = NO 896 897#--------------------------------------------------------------------------- 898# configuration options related to the alphabetical class index 899#--------------------------------------------------------------------------- 900 901# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 902# of all compounds will be generated. Enable this if the project 903# contains a lot of classes, structs, unions or interfaces. 904 905ALPHABETICAL_INDEX = YES 906 907# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 908# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 909# in which this list will be split (can be a number in the range [1..20]) 910 911COLS_IN_ALPHA_INDEX = 3 912 913# In case all classes in a project start with a common prefix, all 914# classes will be put under the same header in the alphabetical index. 915# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 916# should be ignored while generating the index headers. 917 918IGNORE_PREFIX = 919 920#--------------------------------------------------------------------------- 921# configuration options related to the HTML output 922#--------------------------------------------------------------------------- 923 924# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 925# generate HTML output. 926 927GENERATE_HTML = YES 928 929# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 930# If a relative path is entered the value of OUTPUT_DIRECTORY will be 931# put in front of it. If left blank `html' will be used as the default path. 932 933HTML_OUTPUT = html 934 935# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 936# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 937# doxygen will generate files with .html extension. 938 939HTML_FILE_EXTENSION = .html 940 941# The HTML_HEADER tag can be used to specify a personal HTML header for 942# each generated HTML page. If it is left blank doxygen will generate a 943# standard header. Note that when using a custom header you are responsible 944# for the proper inclusion of any scripts and style sheets that doxygen 945# needs, which is dependent on the configuration options used. 946# It is advised to generate a default header using "doxygen -w html 947# header.html footer.html stylesheet.css YourConfigFile" and then modify 948# that header. Note that the header is subject to change so you typically 949# have to redo this when upgrading to a newer version of doxygen or when 950# changing the value of configuration settings such as GENERATE_TREEVIEW! 951 952HTML_HEADER = 953 954# The HTML_FOOTER tag can be used to specify a personal HTML footer for 955# each generated HTML page. If it is left blank doxygen will generate a 956# standard footer. 957 958HTML_FOOTER = 959 960# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 961# style sheet that is used by each HTML page. It can be used to 962# fine-tune the look of the HTML output. If left blank doxygen will 963# generate a default style sheet. Note that it is recommended to use 964# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 965# tag will in the future become obsolete. 966 967HTML_STYLESHEET = 968 969# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 970# user-defined cascading style sheet that is included after the standard 971# style sheets created by doxygen. Using this option one can overrule 972# certain style aspects. This is preferred over using HTML_STYLESHEET 973# since it does not replace the standard style sheet and is therefor more 974# robust against future updates. Doxygen will copy the style sheet file to 975# the output directory. 976 977HTML_EXTRA_STYLESHEET = "Docs/ogre_style.css" 978 979# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 980# other source files which should be copied to the HTML output directory. Note 981# that these files will be copied to the base HTML output directory. Use the 982# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 983# files. In the HTML_STYLESHEET file, use the file name only. Also note that 984# the files will be copied as-is; there are no commands or markers available. 985 986HTML_EXTRA_FILES = 987 988# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 989# Doxygen will adjust the colors in the style sheet and background images 990# according to this color. Hue is specified as an angle on a colorwheel, 991# see http://en.wikipedia.org/wiki/Hue for more information. 992# For instance the value 0 represents red, 60 is yellow, 120 is green, 993# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 994# The allowed range is 0 to 359. 995 996HTML_COLORSTYLE_HUE = 130 997 998# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 999# the colors in the HTML output. For a value of 0 the output will use 1000# grayscales only. A value of 255 will produce the most vivid colors. 1001 1002HTML_COLORSTYLE_SAT = 40 1003 1004# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 1005# the luminance component of the colors in the HTML output. Values below 1006# 100 gradually make the output lighter, whereas values above 100 make 1007# the output darker. The value divided by 100 is the actual gamma applied, 1008# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 1009# and 100 does not change the gamma. 1010 1011HTML_COLORSTYLE_GAMMA = 80 1012 1013# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1014# page will contain the date and time when the page was generated. Setting 1015# this to NO can help when comparing the output of multiple runs. 1016 1017HTML_TIMESTAMP = NO 1018 1019# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1020# documentation will contain sections that can be hidden and shown after the 1021# page has loaded. 1022 1023HTML_DYNAMIC_SECTIONS = YES 1024 1025# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 1026# entries shown in the various tree structured indices initially; the user 1027# can expand and collapse entries dynamically later on. Doxygen will expand 1028# the tree to such a level that at most the specified number of entries are 1029# visible (unless a fully collapsed tree already exceeds this amount). 1030# So setting the number of entries 1 will produce a full collapsed tree by 1031# default. 0 is a special value representing an infinite number of entries 1032# and will result in a full expanded tree by default. 1033 1034HTML_INDEX_NUM_ENTRIES = 100 1035 1036# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1037# at top of each HTML page. The value NO (the default) enables the index and 1038# the value YES disables it. Since the tabs have the same information as the 1039# navigation tree you can set this option to NO if you already set 1040# GENERATE_TREEVIEW to YES. 1041 1042DISABLE_INDEX = NO 1043 1044# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1045# structure should be generated to display hierarchical information. 1046# If the tag value is set to YES, a side panel will be generated 1047# containing a tree-like index structure (just like the one that 1048# is generated for HTML Help). For this to work a browser that supports 1049# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1050# Windows users are probably better off using the HTML help feature. 1051# Since the tree basically has the same information as the tab index you 1052# could consider to set DISABLE_INDEX to NO when enabling this option. 1053 1054GENERATE_TREEVIEW = YES 1055 1056# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1057# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1058# documentation. Note that a value of 0 will completely suppress the enum 1059# values from appearing in the overview section. 1060 1061ENUM_VALUES_PER_LINE = 4 1062 1063# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1064# used to set the initial width (in pixels) of the frame in which the tree 1065# is shown. 1066 1067TREEVIEW_WIDTH = 250 1068 1069# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1070# links to external symbols imported via tag files in a separate window. 1071 1072EXT_LINKS_IN_WINDOW = NO 1073 1074# Use this tag to change the font size of Latex formulas included 1075# as images in the HTML documentation. The default is 10. Note that 1076# when you change the font size after a successful doxygen run you need 1077# to manually remove any form_*.png images from the HTML output directory 1078# to force them to be regenerated. 1079 1080FORMULA_FONTSIZE = 10 1081 1082# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1083# generated for formulas are transparent PNGs. Transparent PNGs are 1084# not supported properly for IE 6.0, but are supported on all modern browsers. 1085# Note that when changing this option you need to delete any form_*.png files 1086# in the HTML output before the changes have effect. 1087 1088FORMULA_TRANSPARENT = YES 1089 1090# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1091# (see http://www.mathjax.org) which uses client side Javascript for the 1092# rendering instead of using prerendered bitmaps. Use this if you do not 1093# have LaTeX installed or if you want to formulas look prettier in the HTML 1094# output. When enabled you may also need to install MathJax separately and 1095# configure the path to it using the MATHJAX_RELPATH option. 1096 1097USE_MATHJAX = YES 1098 1099# When MathJax is enabled you can set the default output format to be used for 1100# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 1101# SVG. The default value is HTML-CSS, which is slower, but has the best 1102# compatibility. 1103 1104MATHJAX_FORMAT = HTML-CSS 1105 1106# When MathJax is enabled you need to specify the location relative to the 1107# HTML output directory using the MATHJAX_RELPATH option. The destination 1108# directory should contain the MathJax.js script. For instance, if the mathjax 1109# directory is located at the same level as the HTML output directory, then 1110# MATHJAX_RELPATH should be ../mathjax. The default value points to 1111# the MathJax Content Delivery Network so you can quickly see the result without 1112# installing MathJax. 1113# However, it is strongly recommended to install a local 1114# copy of MathJax from http://www.mathjax.org before deployment. 1115 1116MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0 1117 1118# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1119# names that should be enabled during MathJax rendering. 1120 1121MATHJAX_EXTENSIONS = 1122 1123# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1124# for the HTML output. The underlying search engine uses javascript 1125# and DHTML and should work on any modern browser. Note that when using 1126# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1127# (GENERATE_DOCSET) there is already a search function so this one should 1128# typically be disabled. For large projects the javascript based search engine 1129# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1130 1131SEARCHENGINE = YES 1132 1133# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1134# implemented using a web server instead of a web client using Javascript. 1135# There are two flavours of web server based search depending on the 1136# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 1137# searching and an index file used by the script. When EXTERNAL_SEARCH is 1138# enabled the indexing and searching needs to be provided by external tools. 1139# See the manual for details. 1140 1141SERVER_BASED_SEARCH = NO 1142 1143# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP 1144# script for searching. Instead the search results are written to an XML file 1145# which needs to be processed by an external indexer. Doxygen will invoke an 1146# external search engine pointed to by the SEARCHENGINE_URL option to obtain 1147# the search results. Doxygen ships with an example indexer (doxyindexer) and 1148# search engine (doxysearch.cgi) which are based on the open source search engine 1149# library Xapian. See the manual for configuration details. 1150 1151EXTERNAL_SEARCH = NO 1152 1153# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1154# which will returned the search results when EXTERNAL_SEARCH is enabled. 1155# Doxygen ships with an example search engine (doxysearch) which is based on 1156# the open source search engine library Xapian. See the manual for configuration 1157# details. 1158 1159SEARCHENGINE_URL = 1160 1161# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1162# search data is written to a file for indexing by an external tool. With the 1163# SEARCHDATA_FILE tag the name of this file can be specified. 1164 1165SEARCHDATA_FILE = searchdata.xml 1166 1167# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through other 1168# doxygen projects that are not otherwise connected via tags files, but are 1169# all added to the same search index. Each project needs to have a tag file set 1170# via GENERATE_TAGFILE. The search mapping then maps the name of the tag file 1171# to a relative location where the documentation can be found, 1172# similar to the 1173# TAGFILES option but without actually processing the tag file. 1174# The format is: EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1175 1176EXTRA_SEARCH_MAPPINGS = 1177 1178#--------------------------------------------------------------------------- 1179# Configuration options related to the preprocessor 1180#--------------------------------------------------------------------------- 1181 1182# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1183# evaluate all C-preprocessor directives found in the sources and include 1184# files. 1185 1186ENABLE_PREPROCESSING = YES 1187 1188# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1189# names in the source code. If set to NO (the default) only conditional 1190# compilation will be performed. Macro expansion can be done in a controlled 1191# way by setting EXPAND_ONLY_PREDEF to YES. 1192 1193MACRO_EXPANSION = YES 1194 1195# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1196# then the macro expansion is limited to the macros specified with the 1197# PREDEFINED and EXPAND_AS_DEFINED tags. 1198 1199EXPAND_ONLY_PREDEF = YES 1200 1201# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1202# pointed to by INCLUDE_PATH will be searched when a #include is found. 1203 1204SEARCH_INCLUDES = YES 1205 1206# The INCLUDE_PATH tag can be used to specify one or more directories that 1207# contain include files that are not input files but should be processed by 1208# the preprocessor. 1209 1210INCLUDE_PATH = 1211 1212# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1213# patterns (like *.h and *.hpp) to filter out the header-files in the 1214# directories. If left blank, the patterns specified with FILE_PATTERNS will 1215# be used. 1216 1217INCLUDE_FILE_PATTERNS = 1218 1219# The PREDEFINED tag can be used to specify one or more macro names that 1220# are defined before the preprocessor is started (similar to the -D option of 1221# gcc). The argument of the tag is a list of macros of the form: name 1222# or name=definition (no spaces). If the definition and the = are 1223# omitted =1 is assumed. To prevent a macro definition from being 1224# undefined via #undef or recursively expanded use the := operator 1225# instead of the = operator. 1226 1227PREDEFINED = OGRE_MEMORY_ALLOCATOR=1 \ 1228 RTSHADER_SYSTEM_BUILD_CORE_SHADERS \ 1229 RTSHADER_SYSTEM_BUILD_EXT_SHADERS \ 1230 OGRE_PLATFORM=10 \ 1231 OGRE_DEPRECATED= \ 1232 MANAGED_RESOURCE= \ 1233 OGRE_RESOURCE_GROUP_INIT==RGN_DEFAULT \ 1234 protected=private 1235 1236# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1237# this tag can be used to specify a list of macro names that should be expanded. 1238# The macro definition that is found in the sources will be used. 1239# Use the PREDEFINED tag if you want to use a different macro definition that 1240# overrules the definition found in the source code. 1241 1242EXPAND_AS_DEFINED = 1243 1244# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1245# doxygen's preprocessor will remove all references to function-like macros 1246# that are alone on a line, have an all uppercase name, and do not end with a 1247# semicolon, because these will confuse the parser if not removed. 1248 1249SKIP_FUNCTION_MACROS = YES 1250 1251#--------------------------------------------------------------------------- 1252# Configuration::additions related to external references 1253#--------------------------------------------------------------------------- 1254 1255# The TAGFILES option can be used to specify one or more tagfiles. For each 1256# tag file the location of the external documentation should be added. The 1257# format of a tag file without this location is as follows: 1258# 1259# TAGFILES = file1 file2 ... 1260# Adding location for the tag files is done as follows: 1261# 1262# TAGFILES = file1=loc1 "file2 = loc2" ... 1263# where "loc1" and "loc2" can be relative or absolute paths 1264# or URLs. Note that each tag file must have a unique name (where the name does 1265# NOT include the path). If a tag file is not located in the directory in which 1266# doxygen is run, you must also specify the path to the tagfile here. 1267 1268TAGFILES = 1269 1270# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1271# a tag file that is based on the input files it reads. 1272 1273GENERATE_TAGFILE = "build/api/Ogre.tag" 1274 1275# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1276# in the class index. If set to NO only the inherited external classes 1277# will be listed. 1278 1279ALLEXTERNALS = NO 1280 1281# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1282# in the modules index. If set to NO, only the current project's groups will 1283# be listed. 1284 1285EXTERNAL_GROUPS = YES 1286 1287# The PERL_PATH should be the absolute path and name of the perl script 1288# interpreter (i.e. the result of `which perl'). 1289 1290PERL_PATH = /usr/bin/perl 1291 1292#--------------------------------------------------------------------------- 1293# Configuration options related to the dot tool 1294#--------------------------------------------------------------------------- 1295 1296# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1297# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1298# or super classes. Setting the tag to NO turns the diagrams off. Note that 1299# this option also works with HAVE_DOT disabled, but it is recommended to 1300# install and use dot, since it yields more powerful graphs. 1301 1302CLASS_DIAGRAMS = YES 1303 1304# You can define message sequence charts within doxygen comments using the \msc 1305# command. Doxygen will then run the mscgen tool (see 1306# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1307# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1308# the mscgen tool resides. If left empty the tool is assumed to be found in the 1309# default search path. 1310 1311MSCGEN_PATH = 1312 1313# If set to YES, the inheritance and collaboration graphs will hide 1314# inheritance and usage relations if the target is undocumented 1315# or is not a class. 1316 1317HIDE_UNDOC_RELATIONS = YES 1318 1319# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1320# available from the path. This tool is part of Graphviz, a graph visualization 1321# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1322# have no effect if this option is set to NO (the default) 1323 1324HAVE_DOT = YES 1325 1326# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1327# allowed to run in parallel. When set to 0 (the default) doxygen will 1328# base this on the number of processors available in the system. You can set it 1329# explicitly to a value larger than 0 to get control over the balance 1330# between CPU load and processing speed. 1331 1332DOT_NUM_THREADS = 0 1333 1334# By default doxygen will use the Helvetica font for all dot files that 1335# doxygen generates. When you want a differently looking font you can specify 1336# the font name using DOT_FONTNAME. You need to make sure dot is able to find 1337# the font, which can be done by putting it in a standard location or by setting 1338# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1339# directory containing the font. 1340 1341DOT_FONTNAME = Helvetica 1342 1343# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1344# The default size is 10pt. 1345 1346DOT_FONTSIZE = 10 1347 1348# By default doxygen will tell dot to use the Helvetica font. 1349# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1350# set the path where dot can find it. 1351 1352DOT_FONTPATH = 1353 1354# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1355# will generate a graph for each documented class showing the direct and 1356# indirect inheritance relations. Setting this tag to YES will force the 1357# CLASS_DIAGRAMS tag to NO. 1358 1359CLASS_GRAPH = YES 1360 1361# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1362# will generate a graph for each documented class showing the direct and 1363# indirect implementation dependencies (inheritance, containment, and 1364# class references variables) of the class with other documented classes. 1365 1366COLLABORATION_GRAPH = NO 1367 1368# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1369# will generate a graph for groups, showing the direct groups dependencies 1370 1371GROUP_GRAPHS = NO 1372 1373# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1374# collaboration diagrams in a style similar to the OMG's Unified Modeling 1375# Language. 1376 1377UML_LOOK = NO 1378 1379# If the UML_LOOK tag is enabled, the fields and methods are shown inside 1380# the class node. If there are many fields or methods and many nodes the 1381# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1382# threshold limits the number of items for each type to make the size more 1383# managable. Set this to 0 for no limit. Note that the threshold may be 1384# exceeded by 50% before the limit is enforced. 1385 1386UML_LIMIT_NUM_FIELDS = 10 1387 1388# If set to YES, the inheritance and collaboration graphs will show the 1389# relations between templates and their instances. 1390 1391TEMPLATE_RELATIONS = NO 1392 1393# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1394# tags are set to YES then doxygen will generate a graph for each documented 1395# file showing the direct and indirect include dependencies of the file with 1396# other documented files. 1397 1398INCLUDE_GRAPH = NO 1399 1400# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1401# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1402# documented header file showing the documented files that directly or 1403# indirectly include this file. 1404 1405INCLUDED_BY_GRAPH = NO 1406 1407# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1408# doxygen will generate a call dependency graph for every global function 1409# or class method. Note that enabling this option will significantly increase 1410# the time of a run. So in most cases it will be better to enable call graphs 1411# for selected functions only using the \callgraph command. 1412 1413CALL_GRAPH = NO 1414 1415# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1416# doxygen will generate a caller dependency graph for every global function 1417# or class method. Note that enabling this option will significantly increase 1418# the time of a run. So in most cases it will be better to enable caller 1419# graphs for selected functions only using the \callergraph command. 1420 1421CALLER_GRAPH = NO 1422 1423# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1424# will generate a graphical hierarchy of all classes instead of a textual one. 1425 1426GRAPHICAL_HIERARCHY = YES 1427 1428# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1429# then doxygen will show the dependencies a directory has on other directories 1430# in a graphical way. The dependency relations are determined by the #include 1431# relations between the files in the directories. 1432 1433DIRECTORY_GRAPH = NO 1434 1435# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1436# generated by dot. Possible values are svg, png, jpg, or gif. 1437# If left blank png will be used. If you choose svg you need to set 1438# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1439# visible in IE 9+ (other browsers do not have this requirement). 1440 1441DOT_IMAGE_FORMAT = svg 1442 1443# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1444# enable generation of interactive SVG images that allow zooming and panning. 1445# Note that this requires a modern browser other than Internet Explorer. 1446# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1447# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1448# visible. Older versions of IE do not have SVG support. 1449 1450INTERACTIVE_SVG = NO 1451 1452# The tag DOT_PATH can be used to specify the path where the dot tool can be 1453# found. If left blank, it is assumed the dot tool can be found in the path. 1454 1455DOT_PATH = /usr/bin 1456 1457# The DOTFILE_DIRS tag can be used to specify one or more directories that 1458# contain dot files that are included in the documentation (see the 1459# \dotfile command). 1460 1461DOTFILE_DIRS = 1462 1463# The MSCFILE_DIRS tag can be used to specify one or more directories that 1464# contain msc files that are included in the documentation (see the 1465# \mscfile command). 1466 1467MSCFILE_DIRS = 1468 1469# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1470# nodes that will be shown in the graph. If the number of nodes in a graph 1471# becomes larger than this value, doxygen will truncate the graph, which is 1472# visualized by representing a node as a red box. Note that doxygen if the 1473# number of direct children of the root node in a graph is already larger than 1474# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1475# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1476 1477DOT_GRAPH_MAX_NODES = 50 1478 1479# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1480# graphs generated by dot. A depth value of 3 means that only nodes reachable 1481# from the root by following a path via at most 3 edges will be shown. Nodes 1482# that lay further from the root node will be omitted. Note that setting this 1483# option to 1 or 2 may greatly reduce the computation time needed for large 1484# code bases. Also note that the size of a graph can be further restricted by 1485# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1486 1487MAX_DOT_GRAPH_DEPTH = 4 1488 1489# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1490# background. This is disabled by default, because dot on Windows does not 1491# seem to support this out of the box. Warning: Depending on the platform used, 1492# enabling this option may lead to badly anti-aliased labels on the edges of 1493# a graph (i.e. they become hard to read). 1494 1495DOT_TRANSPARENT = YES 1496 1497# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1498# files in one run (i.e. multiple -o and -T options on the command line). This 1499# makes dot run faster, but since only newer versions of dot (>1.8.10) 1500# support this, this feature is disabled by default. 1501 1502DOT_MULTI_TARGETS = YES 1503 1504# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1505# generate a legend page explaining the meaning of the various boxes and 1506# arrows in the dot generated graphs. 1507 1508GENERATE_LEGEND = YES 1509 1510# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1511# remove the intermediate dot files that are used to generate 1512# the various graphs. 1513 1514DOT_CLEANUP = YES 1515
