1# Doxyfile 1.2.18 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# General configuration options 15#--------------------------------------------------------------------------- 16 17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18# by quotes) that should identify the project. 19 20PROJECT_NAME = Xnee 21 22# The PROJECT_NUMBER tag can be used to enter a project or revision number. 23# This could be handy for archiving the generated documentation or 24# if some version control system is used. 25 26PROJECT_NUMBER = 27 28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 29# base path where the generated documentation will be put. 30# If a relative path is entered, it will be relative to the location 31# where doxygen was started. If left blank the current directory will be used. 32 33OUTPUT_DIRECTORY = 34 35# The OUTPUT_LANGUAGE tag is used to specify the language in which all 36# documentation generated by doxygen is written. Doxygen will use this 37# information to generate all constant output in the proper language. 38# The default language is English, other supported languages are: 39# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 40# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 41# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese, 42# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian. 43 44OUTPUT_LANGUAGE = English 45 46# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 47# documentation are documented, even if no documentation was available. 48# Private class members and static file members will be hidden unless 49# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 50 51EXTRACT_ALL = YES 52 53# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 54# will be included in the documentation. 55 56EXTRACT_PRIVATE = NO 57 58# If the EXTRACT_STATIC tag is set to YES all static members of a file 59# will be included in the documentation. 60 61EXTRACT_STATIC = NO 62 63# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 64# defined locally in source files will be included in the documentation. 65# If set to NO only classes defined in header files are included. 66 67EXTRACT_LOCAL_CLASSES = YES 68 69# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 70# undocumented members of documented classes, files or namespaces. 71# If set to NO (the default) these members will be included in the 72# various overviews, but no documentation section is generated. 73# This option has no effect if EXTRACT_ALL is enabled. 74 75HIDE_UNDOC_MEMBERS = NO 76 77# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 78# undocumented classes that are normally visible in the class hierarchy. 79# If set to NO (the default) these class will be included in the various 80# overviews. This option has no effect if EXTRACT_ALL is enabled. 81 82HIDE_UNDOC_CLASSES = NO 83 84# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 85# friend (class|struct|union) declarations. 86# If set to NO (the default) these declarations will be included in the 87# documentation. 88 89HIDE_FRIEND_COMPOUNDS = NO 90 91# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 92# include brief member descriptions after the members that are listed in 93# the file and class documentation (similar to JavaDoc). 94# Set to NO to disable this. 95 96BRIEF_MEMBER_DESC = YES 97 98# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 99# the brief description of a member or function before the detailed description. 100# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 101# brief descriptions will be completely suppressed. 102 103REPEAT_BRIEF = YES 104 105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 106# Doxygen will generate a detailed section even if there is only a brief 107# description. 108 109ALWAYS_DETAILED_SEC = NO 110 111# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 112# members of a class in the documentation of that class as if those members were 113# ordinary class members. Constructors, destructors and assignment operators of 114# the base classes will not be shown. 115 116INLINE_INHERITED_MEMB = NO 117 118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 119# path before files name in the file list and in the header files. If set 120# to NO the shortest path that makes the file name unique will be used. 121 122FULL_PATH_NAMES = NO 123 124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 125# can be used to strip a user defined part of the path. Stripping is 126# only done if one of the specified strings matches the left-hand part of 127# the path. It is allowed to use relative paths in the argument list. 128 129STRIP_FROM_PATH = 130 131# The INTERNAL_DOCS tag determines if documentation 132# that is typed after a \internal command is included. If the tag is set 133# to NO (the default) then the documentation will be excluded. 134# Set it to YES to include the internal documentation. 135 136INTERNAL_DOCS = NO 137 138# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 139# doxygen to hide any special comment blocks from generated source code 140# fragments. Normal C and C++ comments will always remain visible. 141 142STRIP_CODE_COMMENTS = YES 143 144# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 145# file names in lower case letters. If set to YES upper case letters are also 146# allowed. This is useful if you have classes or files whose names only differ 147# in case and if your file system supports case sensitive file names. Windows 148# users are adviced to set this option to NO. 149 150CASE_SENSE_NAMES = YES 151 152# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 153# (but less readable) file names. This can be useful is your file systems 154# doesn't support long names like on DOS, Mac, or CD-ROM. 155 156SHORT_NAMES = NO 157 158# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 159# will show members with their full class and namespace scopes in the 160# documentation. If set to YES the scope will be hidden. 161 162HIDE_SCOPE_NAMES = NO 163 164# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 165# will generate a verbatim copy of the header file for each class for 166# which an include is specified. Set to NO to disable this. 167 168VERBATIM_HEADERS = YES 169 170# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 171# will put list of the files that are included by a file in the documentation 172# of that file. 173 174SHOW_INCLUDE_FILES = YES 175 176# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 177# will interpret the first line (until the first dot) of a JavaDoc-style 178# comment as the brief description. If set to NO, the JavaDoc 179# comments will behave just like the Qt-style comments (thus requiring an 180# explict @brief command for a brief description. 181 182JAVADOC_AUTOBRIEF = NO 183 184# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 185# treat a multi-line C++ special comment block (i.e. a block of //! or /// 186# comments) as a brief description. This used to be the default behaviour. 187# The new default is to treat a multi-line C++ comment block as a detailed 188# description. Set this tag to YES if you prefer the old behaviour instead. 189 190MULTILINE_CPP_IS_BRIEF = NO 191 192# If the DETAILS_AT_TOP tag is set to YES then Doxygen 193# will output the detailed description near the top, like JavaDoc. 194# If set to NO, the detailed description appears after the member 195# documentation. 196 197DETAILS_AT_TOP = NO 198 199# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 200# member inherits the documentation from any documented member that it 201# reimplements. 202 203INHERIT_DOCS = YES 204 205# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 206# is inserted in the documentation for inline members. 207 208INLINE_INFO = YES 209 210# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 211# will sort the (detailed) documentation of file and class members 212# alphabetically by member name. If set to NO the members will appear in 213# declaration order. 214 215SORT_MEMBER_DOCS = YES 216 217# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 218# tag is set to YES, then doxygen will reuse the documentation of the first 219# member in the group (if any) for the other members of the group. By default 220# all members of a group must be documented explicitly. 221 222DISTRIBUTE_GROUP_DOC = NO 223 224# The TAB_SIZE tag can be used to set the number of spaces in a tab. 225# Doxygen uses this value to replace tabs by spaces in code fragments. 226 227TAB_SIZE = 8 228 229# The GENERATE_TODOLIST tag can be used to enable (YES) or 230# disable (NO) the todo list. This list is created by putting \todo 231# commands in the documentation. 232 233GENERATE_TODOLIST = YES 234 235# The GENERATE_TESTLIST tag can be used to enable (YES) or 236# disable (NO) the test list. This list is created by putting \test 237# commands in the documentation. 238 239GENERATE_TESTLIST = YES 240 241# The GENERATE_BUGLIST tag can be used to enable (YES) or 242# disable (NO) the bug list. This list is created by putting \bug 243# commands in the documentation. 244 245GENERATE_BUGLIST = YES 246 247# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 248# disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation. 249 250GENERATE_DEPRECATEDLIST= YES 251 252# This tag can be used to specify a number of aliases that acts 253# as commands in the documentation. An alias has the form "name=value". 254# For example adding "sideeffect=\par Side Effects:\n" will allow you to 255# put the command \sideeffect (or @sideeffect) in the documentation, which 256# will result in a user defined paragraph with heading "Side Effects:". 257# You can put \n's in the value part of an alias to insert newlines. 258 259ALIASES = 260 261# The ENABLED_SECTIONS tag can be used to enable conditional 262# documentation sections, marked by \if sectionname ... \endif. 263 264ENABLED_SECTIONS = 265 266# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 267# the initial value of a variable or define consist of for it to appear in 268# the documentation. If the initializer consists of more lines than specified 269# here it will be hidden. Use a value of 0 to hide initializers completely. 270# The appearance of the initializer of individual variables and defines in the 271# documentation can be controlled using \showinitializer or \hideinitializer 272# command in the documentation regardless of this setting. 273 274MAX_INITIALIZER_LINES = 30 275 276# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 277# only. Doxygen will then generate output that is more tailored for C. 278# For instance some of the names that are used will be different. The list 279# of all members will be omitted, etc. 280 281OPTIMIZE_OUTPUT_FOR_C = YES 282 283# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 284# only. Doxygen will then generate output that is more tailored for Java. 285# For instance namespaces will be presented as packages, qualified scopes 286# will look different, etc. 287 288OPTIMIZE_OUTPUT_JAVA = NO 289 290# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 291# at the bottom of the documentation of classes and structs. If set to YES the 292# list will mention the files that were used to generate the documentation. 293 294SHOW_USED_FILES = YES 295 296#--------------------------------------------------------------------------- 297# configuration options related to warning and progress messages 298#--------------------------------------------------------------------------- 299 300# The QUIET tag can be used to turn on/off the messages that are generated 301# by doxygen. Possible values are YES and NO. If left blank NO is used. 302 303QUIET = NO 304 305# The WARNINGS tag can be used to turn on/off the warning messages that are 306# generated by doxygen. Possible values are YES and NO. If left blank 307# NO is used. 308 309WARNINGS = YES 310 311# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 312# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 313# automatically be disabled. 314 315WARN_IF_UNDOCUMENTED = YES 316 317# The WARN_FORMAT tag determines the format of the warning messages that 318# doxygen can produce. The string should contain the $file, $line, and $text 319# tags, which will be replaced by the file and line number from which the 320# warning originated and the warning text. 321 322WARN_FORMAT = "$file:$line: $text" 323 324# The WARN_LOGFILE tag can be used to specify a file to which warning 325# and error messages should be written. If left blank the output is written 326# to stderr. 327 328WARN_LOGFILE = 329 330#--------------------------------------------------------------------------- 331# configuration options related to the input files 332#--------------------------------------------------------------------------- 333 334# The INPUT tag can be used to specify the files and/or directories that contain 335# documented source files. You may enter file names like "myfile.cpp" or 336# directories like "/usr/src/myproject". Separate the files or directories 337# with spaces. 338 339INPUT = ../libxnee/include/libxnee/ 340 341# If the value of the INPUT tag contains directories, you can use the 342# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 343# and *.h) to filter out the source-files in the directories. If left 344# blank the following patterns are tested: 345# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 346# *.h++ *.idl *.odl 347 348FILE_PATTERNS = *.h 349 350# The RECURSIVE tag can be used to turn specify whether or not subdirectories 351# should be searched for input files as well. Possible values are YES and NO. 352# If left blank NO is used. 353 354RECURSIVE = NO 355 356# The EXCLUDE tag can be used to specify files and/or directories that should 357# excluded from the INPUT source files. This way you can easily exclude a 358# subdirectory from a directory tree whose root is specified with the INPUT tag. 359 360EXCLUDE = 361 362# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 363# that are symbolic links (a Unix filesystem feature) are excluded from the input. 364 365EXCLUDE_SYMLINKS = NO 366 367# If the value of the INPUT tag contains directories, you can use the 368# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 369# certain files from those directories. 370 371EXCLUDE_PATTERNS = 372 373# The EXAMPLE_PATH tag can be used to specify one or more files or 374# directories that contain example code fragments that are included (see 375# the \include command). 376 377EXAMPLE_PATH = 378 379# If the value of the EXAMPLE_PATH tag contains directories, you can use the 380# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 381# and *.h) to filter out the source-files in the directories. If left 382# blank all files are included. 383 384EXAMPLE_PATTERNS = 385 386# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 387# searched for input files to be used with the \include or \dontinclude 388# commands irrespective of the value of the RECURSIVE tag. 389# Possible values are YES and NO. If left blank NO is used. 390 391EXAMPLE_RECURSIVE = NO 392 393# The IMAGE_PATH tag can be used to specify one or more files or 394# directories that contain image that are included in the documentation (see 395# the \image command). 396 397IMAGE_PATH = 398 399# The INPUT_FILTER tag can be used to specify a program that doxygen should 400# invoke to filter for each input file. Doxygen will invoke the filter program 401# by executing (via popen()) the command <filter> <input-file>, where <filter> 402# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 403# input file. Doxygen will then use the output that the filter program writes 404# to standard output. 405 406INPUT_FILTER = 407 408# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 409# INPUT_FILTER) will be used to filter the input files when producing source 410# files to browse (i.e. when SOURCE_BROWSER is set to YES). 411 412FILTER_SOURCE_FILES = NO 413 414#--------------------------------------------------------------------------- 415# configuration options related to source browsing 416#--------------------------------------------------------------------------- 417 418# If the SOURCE_BROWSER tag is set to YES then a list of source files will 419# be generated. Documented entities will be cross-referenced with these sources. 420 421SOURCE_BROWSER = NO 422 423# Setting the INLINE_SOURCES tag to YES will include the body 424# of functions and classes directly in the documentation. 425 426INLINE_SOURCES = NO 427 428# If the REFERENCED_BY_RELATION tag is set to YES (the default) 429# then for each documented function all documented 430# functions referencing it will be listed. 431 432REFERENCED_BY_RELATION = YES 433 434# If the REFERENCES_RELATION tag is set to YES (the default) 435# then for each documented function all documented entities 436# called/used by that function will be listed. 437 438REFERENCES_RELATION = YES 439 440#--------------------------------------------------------------------------- 441# configuration options related to the alphabetical class index 442#--------------------------------------------------------------------------- 443 444# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 445# of all compounds will be generated. Enable this if the project 446# contains a lot of classes, structs, unions or interfaces. 447 448ALPHABETICAL_INDEX = NO 449 450# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 451# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 452# in which this list will be split (can be a number in the range [1..20]) 453 454COLS_IN_ALPHA_INDEX = 5 455 456# In case all classes in a project start with a common prefix, all 457# classes will be put under the same header in the alphabetical index. 458# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 459# should be ignored while generating the index headers. 460 461IGNORE_PREFIX = 462 463#--------------------------------------------------------------------------- 464# configuration options related to the HTML output 465#--------------------------------------------------------------------------- 466 467# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 468# generate HTML output. 469 470GENERATE_HTML = YES 471 472# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 473# If a relative path is entered the value of OUTPUT_DIRECTORY will be 474# put in front of it. If left blank `html' will be used as the default path. 475 476HTML_OUTPUT = html 477 478# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 479# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 480# doxygen will generate files with .html extension. 481 482HTML_FILE_EXTENSION = .html 483 484# The HTML_HEADER tag can be used to specify a personal HTML header for 485# each generated HTML page. If it is left blank doxygen will generate a 486# standard header. 487 488HTML_HEADER = 489 490# The HTML_FOOTER tag can be used to specify a personal HTML footer for 491# each generated HTML page. If it is left blank doxygen will generate a 492# standard footer. 493 494HTML_FOOTER = 495 496# The HTML_STYLESHEET tag can be used to specify a user defined cascading 497# style sheet that is used by each HTML page. It can be used to 498# fine-tune the look of the HTML output. If the tag is left blank doxygen 499# will generate a default style sheet 500 501HTML_STYLESHEET = 502 503# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 504# files or namespaces will be aligned in HTML using tables. If set to 505# NO a bullet list will be used. 506 507HTML_ALIGN_MEMBERS = YES 508 509# If the GENERATE_HTMLHELP tag is set to YES, additional index files 510# will be generated that can be used as input for tools like the 511# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 512# of the generated HTML documentation. 513 514GENERATE_HTMLHELP = NO 515 516# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 517# be used to specify the file name of the resulting .chm file. You 518# can add a path in front of the file if the result should not be 519# written to the html output dir. 520 521CHM_FILE = 522 523# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 524# be used to specify the location (absolute path including file name) of 525# the HTML help compiler (hhc.exe). If non empty doxygen will try to run 526# the html help compiler on the generated index.hhp. 527 528HHC_LOCATION = 529 530# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 531# controls if a separate .chi index file is generated (YES) or that 532# it should be included in the master .chm file (NO). 533 534GENERATE_CHI = NO 535 536# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 537# controls whether a binary table of contents is generated (YES) or a 538# normal table of contents (NO) in the .chm file. 539 540BINARY_TOC = NO 541 542# The TOC_EXPAND flag can be set to YES to add extra items for group members 543# to the contents of the Html help documentation and to the tree view. 544 545TOC_EXPAND = NO 546 547# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 548# top of each HTML page. The value NO (the default) enables the index and 549# the value YES disables it. 550 551DISABLE_INDEX = NO 552 553# This tag can be used to set the number of enum values (range [1..20]) 554# that doxygen will group on one line in the generated HTML documentation. 555 556ENUM_VALUES_PER_LINE = 4 557 558# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 559# generated containing a tree-like index structure (just like the one that 560# is generated for HTML Help). For this to work a browser that supports 561# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, 562# or Internet explorer 4.0+). Note that for large projects the tree generation 563# can take a very long time. In such cases it is better to disable this feature. 564# Windows users are probably better off using the HTML help feature. 565 566GENERATE_TREEVIEW = YES 567 568# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 569# used to set the initial width (in pixels) of the frame in which the tree 570# is shown. 571 572TREEVIEW_WIDTH = 250 573 574#--------------------------------------------------------------------------- 575# configuration options related to the LaTeX output 576#--------------------------------------------------------------------------- 577 578# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 579# generate Latex output. 580 581GENERATE_LATEX = YES 582 583# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 584# If a relative path is entered the value of OUTPUT_DIRECTORY will be 585# put in front of it. If left blank `latex' will be used as the default path. 586 587LATEX_OUTPUT = latex 588 589# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name. 590 591LATEX_CMD_NAME = latex 592 593# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 594# generate index for LaTeX. If left blank `makeindex' will be used as the 595# default command name. 596 597MAKEINDEX_CMD_NAME = makeindex 598 599# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 600# LaTeX documents. This may be useful for small projects and may help to 601# save some trees in general. 602 603COMPACT_LATEX = NO 604 605# The PAPER_TYPE tag can be used to set the paper type that is used 606# by the printer. Possible values are: a4, a4wide, letter, legal and 607# executive. If left blank a4wide will be used. 608 609PAPER_TYPE = a4wide 610 611# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 612# packages that should be included in the LaTeX output. 613 614EXTRA_PACKAGES = 615 616# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 617# the generated latex document. The header should contain everything until 618# the first chapter. If it is left blank doxygen will generate a 619# standard header. Notice: only use this tag if you know what you are doing! 620 621LATEX_HEADER = 622 623# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 624# is prepared for conversion to pdf (using ps2pdf). The pdf file will 625# contain links (just like the HTML output) instead of page references 626# This makes the output suitable for online browsing using a pdf viewer. 627 628PDF_HYPERLINKS = NO 629 630# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 631# plain latex in the generated Makefile. Set this option to YES to get a 632# higher quality PDF documentation. 633 634USE_PDFLATEX = NO 635 636# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 637# command to the generated LaTeX files. This will instruct LaTeX to keep 638# running if errors occur, instead of asking the user for help. 639# This option is also used when generating formulas in HTML. 640 641LATEX_BATCHMODE = NO 642 643#--------------------------------------------------------------------------- 644# configuration options related to the RTF output 645#--------------------------------------------------------------------------- 646 647# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 648# The RTF output is optimised for Word 97 and may not look very pretty with 649# other RTF readers or editors. 650 651GENERATE_RTF = YES 652 653# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 654# If a relative path is entered the value of OUTPUT_DIRECTORY will be 655# put in front of it. If left blank `rtf' will be used as the default path. 656 657RTF_OUTPUT = rtf 658 659# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 660# RTF documents. This may be useful for small projects and may help to 661# save some trees in general. 662 663COMPACT_RTF = NO 664 665# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 666# will contain hyperlink fields. The RTF file will 667# contain links (just like the HTML output) instead of page references. 668# This makes the output suitable for online browsing using WORD or other 669# programs which support those fields. 670# Note: wordpad (write) and others do not support links. 671 672RTF_HYPERLINKS = NO 673 674# Load stylesheet definitions from file. Syntax is similar to doxygen's 675# config file, i.e. a series of assigments. You only have to provide 676# replacements, missing definitions are set to their default value. 677 678RTF_STYLESHEET_FILE = 679 680# Set optional variables used in the generation of an rtf document. 681# Syntax is similar to doxygen's config file. 682 683RTF_EXTENSIONS_FILE = 684 685#--------------------------------------------------------------------------- 686# configuration options related to the man page output 687#--------------------------------------------------------------------------- 688 689# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 690# generate man pages 691 692GENERATE_MAN = YES 693 694# The MAN_OUTPUT tag is used to specify where the man pages will be put. 695# If a relative path is entered the value of OUTPUT_DIRECTORY will be 696# put in front of it. If left blank `man' will be used as the default path. 697 698MAN_OUTPUT = man 699 700# The MAN_EXTENSION tag determines the extension that is added to 701# the generated man pages (default is the subroutine's section .3) 702 703MAN_EXTENSION = .1 704 705# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 706# then it will generate one additional man file for each entity 707# documented in the real man page(s). These additional files 708# only source the real man page, but without them the man command 709# would be unable to find the correct page. The default is NO. 710 711MAN_LINKS = NO 712 713#--------------------------------------------------------------------------- 714# configuration options related to the XML output 715#--------------------------------------------------------------------------- 716 717# If the GENERATE_XML tag is set to YES Doxygen will 718# generate an XML file that captures the structure of 719# the code including all documentation. Note that this 720# feature is still experimental and incomplete at the 721# moment. 722 723GENERATE_XML = NO 724 725# The XML_SCHEMA tag can be used to specify an XML schema, 726# which can be used by a validating XML parser to check the 727# syntax of the XML files. 728 729XML_SCHEMA = 730 731# The XML_DTD tag can be used to specify an XML DTD, 732# which can be used by a validating XML parser to check the 733# syntax of the XML files. 734 735XML_DTD = 736 737#--------------------------------------------------------------------------- 738# configuration options for the AutoGen Definitions output 739#--------------------------------------------------------------------------- 740 741# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 742# generate an AutoGen Definitions (see autogen.sf.net) file 743# that captures the structure of the code including all 744# documentation. Note that this feature is still experimental 745# and incomplete at the moment. 746 747GENERATE_AUTOGEN_DEF = NO 748 749#--------------------------------------------------------------------------- 750# Configuration options related to the preprocessor 751#--------------------------------------------------------------------------- 752 753# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 754# evaluate all C-preprocessor directives found in the sources and include 755# files. 756 757ENABLE_PREPROCESSING = YES 758 759# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 760# names in the source code. If set to NO (the default) only conditional 761# compilation will be performed. Macro expansion can be done in a controlled 762# way by setting EXPAND_ONLY_PREDEF to YES. 763 764MACRO_EXPANSION = NO 765 766# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 767# then the macro expansion is limited to the macros specified with the 768# PREDEFINED and EXPAND_AS_PREDEFINED tags. 769 770EXPAND_ONLY_PREDEF = NO 771 772# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 773# in the INCLUDE_PATH (see below) will be search if a #include is found. 774 775SEARCH_INCLUDES = YES 776 777# The INCLUDE_PATH tag can be used to specify one or more directories that 778# contain include files that are not input files but should be processed by 779# the preprocessor. 780 781INCLUDE_PATH = 782 783# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 784# patterns (like *.h and *.hpp) to filter out the header-files in the 785# directories. If left blank, the patterns specified with FILE_PATTERNS will 786# be used. 787 788INCLUDE_FILE_PATTERNS = 789 790# The PREDEFINED tag can be used to specify one or more macro names that 791# are defined before the preprocessor is started (similar to the -D option of 792# gcc). The argument of the tag is a list of macros of the form: name 793# or name=definition (no spaces). If the definition and the = are 794# omitted =1 is assumed. 795 796PREDEFINED = 797 798# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 799# this tag can be used to specify a list of macro names that should be expanded. 800# The macro definition that is found in the sources will be used. 801# Use the PREDEFINED tag if you want to use a different macro definition. 802 803EXPAND_AS_DEFINED = 804 805# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 806# doxygen's preprocessor will remove all function-like macros that are alone 807# on a line, have an all uppercase name, and do not end with a semicolon. Such 808# function macros are typically used for boiler-plate code, and will confuse the 809# parser if not removed. 810 811SKIP_FUNCTION_MACROS = YES 812 813#--------------------------------------------------------------------------- 814# Configuration::addtions related to external references 815#--------------------------------------------------------------------------- 816 817# The TAGFILES tag can be used to specify one or more tagfiles. 818 819TAGFILES = 820 821# When a file name is specified after GENERATE_TAGFILE, doxygen will create 822# a tag file that is based on the input files it reads. 823 824GENERATE_TAGFILE = 825 826# If the ALLEXTERNALS tag is set to YES all external classes will be listed 827# in the class index. If set to NO only the inherited external classes 828# will be listed. 829 830ALLEXTERNALS = NO 831 832# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 833# in the modules index. If set to NO, only the current project's groups will 834# be listed. 835 836EXTERNAL_GROUPS = YES 837 838# The PERL_PATH should be the absolute path and name of the perl script 839# interpreter (i.e. the result of `which perl'). 840 841PERL_PATH = /usr/bin/perl 842 843#--------------------------------------------------------------------------- 844# Configuration options related to the dot tool 845#--------------------------------------------------------------------------- 846 847# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 848# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 849# super classes. Setting the tag to NO turns the diagrams off. Note that this 850# option is superceded by the HAVE_DOT option below. This is only a fallback. It is 851# recommended to install and use dot, since it yield more powerful graphs. 852 853CLASS_DIAGRAMS = YES 854 855# If set to YES, the inheritance and collaboration graphs will hide 856# inheritance and usage relations if the target is undocumented 857# or is not a class. 858 859HIDE_UNDOC_RELATIONS = YES 860 861# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 862# available from the path. This tool is part of Graphviz, a graph visualization 863# toolkit from AT&T and Lucent Bell Labs. The other options in this section 864# have no effect if this option is set to NO (the default) 865 866HAVE_DOT = NO 867 868# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 869# will generate a graph for each documented class showing the direct and 870# indirect inheritance relations. Setting this tag to YES will force the 871# the CLASS_DIAGRAMS tag to NO. 872 873CLASS_GRAPH = YES 874 875# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 876# will generate a graph for each documented class showing the direct and 877# indirect implementation dependencies (inheritance, containment, and 878# class references variables) of the class with other documented classes. 879 880COLLABORATION_GRAPH = YES 881 882# If set to YES, the inheritance and collaboration graphs will show the 883# relations between templates and their instances. 884 885TEMPLATE_RELATIONS = YES 886 887# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 888# tags are set to YES then doxygen will generate a graph for each documented 889# file showing the direct and indirect include dependencies of the file with 890# other documented files. 891 892INCLUDE_GRAPH = YES 893 894# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 895# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 896# documented header file showing the documented files that directly or 897# indirectly include this file. 898 899INCLUDED_BY_GRAPH = YES 900 901# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 902# will graphical hierarchy of all classes instead of a textual one. 903 904GRAPHICAL_HIERARCHY = YES 905 906# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 907# generated by dot. Possible values are png, jpg, or gif 908# If left blank png will be used. 909 910DOT_IMAGE_FORMAT = png 911 912# The tag DOT_PATH can be used to specify the path where the dot tool can be 913# found. If left blank, it is assumed the dot tool can be found on the path. 914 915DOT_PATH = 916 917# The DOTFILE_DIRS tag can be used to specify one or more directories that 918# contain dot files that are included in the documentation (see the 919# \dotfile command). 920 921DOTFILE_DIRS = 922 923# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 924# (in pixels) of the graphs generated by dot. If a graph becomes larger than 925# this value, doxygen will try to truncate the graph, so that it fits within 926# the specified constraint. Beware that most browsers cannot cope with very 927# large images. 928 929MAX_DOT_GRAPH_WIDTH = 1024 930 931# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 932# (in pixels) of the graphs generated by dot. If a graph becomes larger than 933# this value, doxygen will try to truncate the graph, so that it fits within 934# the specified constraint. Beware that most browsers cannot cope with very 935# large images. 936 937MAX_DOT_GRAPH_HEIGHT = 1024 938 939# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 940# generate a legend page explaining the meaning of the various boxes and 941# arrows in the dot generated graphs. 942 943GENERATE_LEGEND = YES 944 945# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 946# remove the intermedate dot files that are used to generate 947# the various graphs. 948 949DOT_CLEANUP = YES 950 951#--------------------------------------------------------------------------- 952# Configuration::addtions related to the search engine 953#--------------------------------------------------------------------------- 954 955# The SEARCHENGINE tag specifies whether or not a search engine should be 956# used. If set to NO the values of all tags below this one will be ignored. 957 958SEARCHENGINE = NO 959 960# The CGI_NAME tag should be the name of the CGI script that 961# starts the search engine (doxysearch) with the correct parameters. 962# A script with this name will be generated by doxygen. 963 964CGI_NAME = search.cgi 965 966# The CGI_URL tag should be the absolute URL to the directory where the 967# cgi binaries are located. See the documentation of your http daemon for 968# details. 969 970CGI_URL = 971 972# The DOC_URL tag should be the absolute URL to the directory where the 973# documentation is located. If left blank the absolute path to the 974# documentation, with file:// prepended to it, will be used. 975 976DOC_URL = 977 978# The DOC_ABSPATH tag should be the absolute path to the directory where the 979# documentation is located. If left blank the directory on the local machine 980# will be used. 981 982DOC_ABSPATH = 983 984# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 985# is installed. 986 987BIN_ABSPATH = /usr/local/bin/ 988 989# The EXT_DOC_PATHS tag can be used to specify one or more paths to 990# documentation generated for other projects. This allows doxysearch to search 991# the documentation for these projects as well. 992 993EXT_DOC_PATHS = 994