1# Doxyfile 1.1.0 2 3# This file describes the settings to be used by doxygen for a project 4# 5# All text after a hash (#) is considered a comment and will be ignored 6# The format is: 7# TAG = value [value, ...] 8# Values that contain spaces should be placed between quotes (" ") 9 10#--------------------------------------------------------------------------- 11# General configuration options 12#--------------------------------------------------------------------------- 13 14# The PROJECT_NAME tag is a single word (or a sequence of word surrounded 15# by quotes) that should identify the project. 16 17PROJECT_NAME = Atlas-C++ 18 19# The PROJECT_NUMBER tag can be used to enter a project or revision number. 20# This could be handy for archiving the generated documentation or 21# if some version control system is used. 22 23PROJECT_NUMBER = 24 25# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 26# base path where the generated documentation will be put. 27# If a relative path is entered, it will be relative to the location 28# where doxygen was started. If left blank the current directory will be used. 29 30OUTPUT_DIRECTORY = doc/ 31 32# The OUTPUT_LANGUAGE tag is used to specify the language in which all 33# documentation generated by doxygen is written. Doxygen will use this 34# information to generate all constant output in the proper language. 35# The default language is English, other supported languages are: 36# Dutch, French, Italian, Czech, Swedish, German and Japanese 37 38OUTPUT_LANGUAGE = English 39 40# The QUIET tag can be used to turn on/off the messages that are generated 41# by doxygen. Possible values are YES and NO. If left blank NO is used. 42 43QUIET = NO 44 45# The WARNINGS tag can be used to turn on/off the warning messages that are 46# generated by doxygen. Possible values are YES and NO. If left blank 47# NO is used. 48 49WARNINGS = YES 50 51# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 52# top of each HTML page. The value NO (the default) enables the index and 53# the value YES disables it. 54 55DISABLE_INDEX = NO 56 57# If the EXTRACT_ALL tag is set to YES all classes and functions will be 58# included in the documentation, even if no documentation was available. 59 60EXTRACT_ALL = NO 61 62# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 63# will be included in the documentation. 64 65EXTRACT_PRIVATE = NO 66 67# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 68# undocumented members inside documented classes or files. 69 70HIDE_UNDOC_MEMBERS = NO 71 72# If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all 73# undocumented classes. 74 75HIDE_UNDOC_CLASSES = NO 76 77# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 78# include brief member descriptions after the members that are listed in 79# the file and class documentation (similar to JavaDoc). 80# Set to NO to disable this. 81 82BRIEF_MEMBER_DESC = YES 83 84# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 85# the brief description of a member or function before the detailed description. 86# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 87# brief descriptions will be completely suppressed. 88 89REPEAT_BRIEF = YES 90 91# If the ALWAYS_DETAILS_SEC and REPEAT_BRIEF tags are both set to YES then 92# Doxygen will generate a detailed section even if there is only a brief 93# description. 94 95ALWAYS_DETAILED_SEC = NO 96 97# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 98# path before files name in the file list and in the header files. If set 99# to NO the shortest path that makes the file name unique will be used. 100 101FULL_PATH_NAMES = NO 102 103# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 104# can be used to strip a user defined part of the path. Stripping is 105# only done if one of the specified strings matches the left-hand part of 106# the path. 107 108STRIP_FROM_PATH = 109 110# The INTERNAL_DOCS tag determines if documentation 111# that is typed after a \internal command is included. If the tag is set 112# to NO (the default) then the documentation will be excluded. 113# Set it to YES to include the internal documentation. 114 115INTERNAL_DOCS = NO 116 117# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 118# generate a class diagram (in Html and LaTeX) for classes with base or 119# super classes. Setting the tag to NO turns the diagrams off. 120 121CLASS_DIAGRAMS = YES 122 123# If the SOURCE_BROWSER tag is set to YES then a list of source files will 124# be generated. Documented entities will be cross-referenced with these sources. 125 126SOURCE_BROWSER = NO 127 128# Setting the INLINE_SOURCES tag to YES will include the body 129# of functions and classes directly in the documentation. 130 131INLINE_SOURCES = NO 132 133# If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen 134# will only generate file names in lower case letters. If set to 135# YES upper case letters are also allowed. This is useful if you have 136# classes or files whose names only differ in case and if your file system 137# supports case sensitive file names. 138 139CASE_SENSE_NAMES = NO 140 141# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 142# will generate a verbatim copy of the header file for each class for 143# which an include is specified. Set to NO to disable this. 144 145VERBATIM_HEADERS = YES 146 147# If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen 148# will interpret the first line (until the first dot) of a JavaDoc-style 149# comment as the brief description. If set to NO, the Javadoc-style will 150# behave just like the Qt-style comments. 151 152JAVADOC_AUTOBRIEF = YES 153 154# if the INHERIT_DOCS tag is set to YES (the default) then an undocumented 155# member inherits the documentation from any documented member that it 156# reimplements. 157 158INHERIT_DOCS = YES 159 160# if the INLINE_INFO tag is set to YES (the default) then a tag [inline] 161# is inserted in the documentation for inline members. 162 163INLINE_INFO = YES 164 165# the TAB_SIZE tag can be used to set the number of spaces in a tab. 166# Doxygen uses this value to replace tabs by spaces in code fragments. 167 168TAB_SIZE = 8 169 170#--------------------------------------------------------------------------- 171# configuration options related to the input files 172#--------------------------------------------------------------------------- 173 174# The INPUT tag can be used to specify the files and/or directories that contain 175# documented source files. You may enter file names like "myfile.cpp" or 176# directories like "/usr/src/myproject". Separate the files or directories 177# with spaces. 178 179INPUT = . 180 181# If the value of the INPUT tag contains directories, you can use the 182# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 183# and *.h) to filter out the source-files in the directories. If left 184# blank all files are included. 185 186FILE_PATTERNS = *.h *.dox 187 188# The RECURSIVE tag can be used to turn specify whether or not subdirectories 189# should be searched for input files as well. Possible values are YES and NO. 190# If left blank NO is used. 191 192RECURSIVE = YES 193 194# The EXCLUDE tag can be used to specify files and/or directories that should 195# excluded from the INPUT source files. This way you can easily exclude a 196# subdirectory from a directory tree whose root is specified with the INPUT tag. 197 198EXCLUDE = tutorial/DebugBridge.h src/Bindings config.h 199 200# If the value of the INPUT tag contains directories, you can use the 201# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 202# certain files from those directories. 203 204EXCLUDE_PATTERNS = 205 206# The EXAMPLE_PATH tag can be used to specify one or more files or 207# directories that contain example code fragments that are included (see 208# the \include command). 209 210EXAMPLE_PATH = tutorial 211 212# If the value of the EXAMPLE_PATH tag contains directories, you can use the 213# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 214# and *.h) to filter out the source-files in the directories. If left 215# blank all files are included. 216 217EXAMPLE_PATTERNS = 218 219# The IMAGE_PATH tag can be used to specify one or more files or 220# directories that contain image that are included in the documentation (see 221# the \image command). 222 223IMAGE_PATH = 224 225# The INPUT_FILTER tag can be used to specify a program that doxygen should 226# invoke to filter for each input file. Doxygen will invoke the filter program 227# by executing (via popen()) the command <filter> <input-file>, where <filter> 228# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 229# input file. Doxygen will then use the output that the filter program writes 230# to standard output. 231 232INPUT_FILTER = 233 234#--------------------------------------------------------------------------- 235# configuration options related to the HTML output 236#--------------------------------------------------------------------------- 237 238# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 239# generate HTML output 240 241GENERATE_HTML = YES 242 243# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 244# If a relative path is entered the value of OUTPUT_DIRECTORY will be 245# put in front of it. If left blank `html' will be used as the default path. 246 247HTML_OUTPUT = html 248 249# The HTML_HEADER tag can be used to specify a personal HTML header for 250# each generated HTML page. If it is left blank doxygen will generate a 251# standard header. 252 253HTML_HEADER = 254 255# The HTML_FOOTER tag can be used to specify a personal HTML footer for 256# each generated HTML page. If it is left blank doxygen will generate a 257# standard footer. 258 259HTML_FOOTER = footer.html 260 261# The HTML_STYLESHEET tag can be used to specify a user defined cascading 262# style sheet that is used by each HTML page. It can be used to 263# fine-tune the look of the HTML output. If the tag is left blank doxygen 264# will generate a default style sheet 265 266HTML_STYLESHEET = 267 268# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 269# files or namespaces will be aligned in HTML using tables. If set to 270# NO a bullet list will be used. 271 272HTML_ALIGN_MEMBERS = YES 273 274# If the GENERATE_HTMLHELP tag is set to YES, additional index files 275# will be generated that can be used as input for tools like the 276# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 277# of the generated HTML documentation. 278 279GENERATE_HTMLHELP = NO 280 281#--------------------------------------------------------------------------- 282# configuration options related to the alphabetical class index 283#--------------------------------------------------------------------------- 284 285# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 286# of all compounds will be generated. Enable this if the project 287# contains a lot of classes, structs, unions or interfaces. 288 289ALPHABETICAL_INDEX = NO 290 291# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 292# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 293# in which this list will be split (can be a number in the range [1..20]) 294 295COLS_IN_ALPHA_INDEX = 5 296 297# In case all classes in a project start with a common prefix, all 298# classes will be put under the same header in the alphabetical index. 299# The IGNORE_PREFIX tag can be use to specify a prefix that should be ignored 300# while generating the index headers. 301 302IGNORE_PREFIX = 303 304#--------------------------------------------------------------------------- 305# configuration options related to the LaTeX output 306#--------------------------------------------------------------------------- 307 308# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 309# generate Latex output. 310 311GENERATE_LATEX = YES 312 313# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 314# If a relative path is entered the value of OUTPUT_DIRECTORY will be 315# put in front of it. If left blank `latex' will be used as the default path. 316 317LATEX_OUTPUT = latex 318 319# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 320# LaTeX documents. This may be useful for small projects and may help to 321# save some trees in general. 322 323COMPACT_LATEX = NO 324 325# The PAPER_TYPE tag can be used to set the paper type that is used 326# by the printer. Possible values are: a4, a4wide, letter, legal and 327# executive. If left blank a4wide will be used. 328 329PAPER_TYPE = a4wide 330 331# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 332# packages that should be included in the LaTeX output. 333 334EXTRA_PACKAGES = 335 336# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 337# the generated latex document. The header should contain everything until 338# the first chapter. If it is left blank doxygen will generate a 339# standard header. Notice: only use this tag if you know what you are doing! 340 341LATEX_HEADER = 342 343# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 344# is prepared for conversion to pdf (using ps2pdf). The pdf file will 345# contain links (just like the HTML output) instead of page references 346# This makes the output suitable for online browsing using a pdf viewer. 347 348PDF_HYPERLINKS = NO 349 350#--------------------------------------------------------------------------- 351# configuration options related to the RTF output 352#--------------------------------------------------------------------------- 353 354# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 355# For now this is experimental and is disabled by default. The RTF output 356# is optimised for Word 97 and may not look too pretty with other readers 357# or editors. 358 359GENERATE_RTF = NO 360 361# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 362# If a relative path is entered the value of OUTPUT_DIRECTORY will be 363# put in front of it. If left blank `rtf' will be used as the default path. 364 365RTF_OUTPUT = 366 367# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 368# RTF documents. This may be useful for small projects and may help to 369# save some trees in general. 370 371COMPACT_RTF = NO 372 373# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 374# will contain hyperlink fields. The RTF file will 375# contain links (just like the HTML output) instead of page references. 376# This makes the output suitable for online browsing using a WORD or other. 377# programs which support those fields. 378# Note: wordpad (write) and others do not support links. 379 380RTF_HYPERLINKS = NO 381#--------------------------------------------------------------------------- 382# configuration options related to the man page output 383#--------------------------------------------------------------------------- 384 385# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 386# generate man pages 387 388GENERATE_MAN = YES 389 390# The MAN_OUTPUT tag is used to specify where the man pages will be put. 391# If a relative path is entered the value of OUTPUT_DIRECTORY will be 392# put in front of it. If left blank `man' will be used as the default path. 393 394MAN_OUTPUT = 395 396# The MAN_EXTENSION tag determines the extension that is added to 397# the generated man pages (default is the subroutine's section .3) 398 399MAN_EXTENSION = .3 400 401#--------------------------------------------------------------------------- 402# Configuration options related to the preprocessor 403#--------------------------------------------------------------------------- 404 405# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 406# evaluate all C-preprocessor directives found in the sources and include 407# files. 408 409ENABLE_PREPROCESSING = YES 410 411# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 412# names in the source code. If set to NO (the default) only conditional 413# compilation will be performed. 414 415MACRO_EXPANSION = NO 416 417# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 418# in the INCLUDE_PATH (see below) will be search if a #include is found. 419 420SEARCH_INCLUDES = YES 421 422# The INCLUDE_PATH tag can be used to specify one or more directories that 423# contain include files that are not input files but should be processed by 424# the preprocessor. 425 426INCLUDE_PATH = 427 428# The PREDEFINED tag can be used to specify one or more macro names that 429# are defined before the preprocessor is started (similar to the -D option of 430# gcc). The argument of the tag is a list of macros of the form: name 431# or name=definition (no spaces). If the definition and the = are 432# omitted =1 is assumed. 433 434PREDEFINED = 435 436# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 437# then the macro expansion is limited to the macros specified with the 438# PREDEFINED tag. 439 440EXPAND_ONLY_PREDEF = NO 441 442#--------------------------------------------------------------------------- 443# Configuration options related to external references 444#--------------------------------------------------------------------------- 445 446# The TAGFILES tag can be used to specify one or more tagfiles. 447 448TAGFILES = 449 450# When a file name is specified after GENERATE_TAGFILE, doxygen will create 451# a tag file that is based on the input files it reads. 452 453GENERATE_TAGFILE = 454 455# If the ALLEXTERNALS tag is set to YES all external classes will be listed 456# in the class index. If set to NO only the inherited external classes 457# will be listed. 458 459ALLEXTERNALS = NO 460 461# The PERL_PATH should be the absolute path and name of the perl script 462# interpreter (i.e. the result of `which perl'). 463 464PERL_PATH = /usr/bin/perl 465 466#--------------------------------------------------------------------------- 467# Configuration options related to the dot tool 468#--------------------------------------------------------------------------- 469 470# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 471# available from the path. This tool is part of Graphviz, a graph visualization 472# toolkit from AT&T and Lucent Bell Labs. The other options in this section 473# have no effect if this option is set to NO (the default) 474 475HAVE_DOT = NO 476 477# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 478# will generate a graph for each documented class showing the direct and 479# indirect implementation dependencies (inheritance, containment, and 480# class references variables) of the class with other documented classes. 481 482COLLABORATION_GRAPH = YES 483 484# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to 485# YES then doxygen will generate a graph for each documented file showing 486# the direct and indirect include dependencies of the file with other 487# documented files. 488 489INCLUDE_GRAPH = YES 490 491# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 492# will graphical hierarchy of all classes instead of a textual one. 493 494GRAPHICAL_HIERARCHY = YES 495 496#--------------------------------------------------------------------------- 497# Configuration options related to the search engine 498#--------------------------------------------------------------------------- 499 500# The SEARCHENGINE tag specifies whether or not a search engine should be 501# used. If set to NO the values of all tags below this one will be ignored. 502 503SEARCHENGINE = NO 504 505# The CGI_NAME tag should be the name of the CGI script that 506# starts the search engine (doxysearch) with the correct parameters. 507# A script with this name will be generated by doxygen. 508 509CGI_NAME = search.cgi 510 511# The CGI_URL tag should be the absolute URL to the directory where the 512# cgi binaries are located. See the documentation of your http daemon for 513# details. 514 515CGI_URL = 516 517# The DOC_URL tag should be the absolute URL to the directory where the 518# documentation is located. If left blank the absolute path to the 519# documentation, with file:// prepended to it, will be used. 520 521DOC_URL = 522 523# The DOC_ABSPATH tag should be the absolute path to the directory where the 524# documentation is located. If left blank the directory on the local machine 525# will be used. 526 527DOC_ABSPATH = 528 529# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 530# is installed. 531 532BIN_ABSPATH = /usr/local/bin/ 533 534# The EXT_DOC_PATHS tag can be used to specify one or more paths to 535# documentation generated for other projects. This allows doxysearch to search 536# the documentation for these projects as well. 537 538EXT_DOC_PATHS = 539