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