doxygen.cfg revision 440cde68
1# Doxyfile 1.8.11
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 double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING      = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
35PROJECT_NAME           = "FD.io NSH SFC project"
36
37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
41PROJECT_NUMBER         = $(VERSION) 42 43# Using the PROJECT_BRIEF tag one can provide an optional one line description 44# for a project that appears at the top of each page and should give viewer a 45# quick idea about the purpose of the project. Keep the description short. 46 47PROJECT_BRIEF = "NSH-based Service Function Chaining" 48 49# With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50# in the documentation. The maximum height of the logo should not exceed 55 51# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52# the logo to the output directory. 53 54PROJECT_LOGO =$(ROOT)/doxygen/assets/logo_fdio.png
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
60
61OUTPUT_DIRECTORY       = $(BUILD_ROOT)/docs 62 63# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64# directories (in 2 levels) under the output directory of each output format and 65# will distribute the generated files over these directories. Enabling this 66# option can be useful when feeding doxygen a huge amount of source files, where 67# putting all generated files in the same directory would otherwise causes 68# performance problems for the file system. 69# The default value is: NO. 70 71CREATE_SUBDIRS = YES 72 73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74# characters to appear in the names of generated files. If set to NO, non-ASCII 75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76# U+3044. 77# The default value is: NO. 78 79ALLOW_UNICODE_NAMES = NO 80 81# The OUTPUT_LANGUAGE tag is used to specify the language in which all 82# documentation generated by doxygen is written. Doxygen will use this 83# information to generate all constant output in the proper language. 84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91# Ukrainian and Vietnamese. 92# The default value is: English. 93 94OUTPUT_LANGUAGE = English 95 96# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97# descriptions after the members that are listed in the file and class 98# documentation (similar to Javadoc). Set to NO to disable this. 99# The default value is: YES. 100 101BRIEF_MEMBER_DESC = YES 102 103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104# description of a member or function before the detailed description 105# 106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107# brief descriptions will be completely suppressed. 108# The default value is: YES. 109 110REPEAT_BRIEF = YES 111 112# This tag implements a quasi-intelligent brief description abbreviator that is 113# used to form the text in various listings. Each string in this list, if found 114# as the leading text of the brief description, will be stripped from the text 115# and the result, after processing the whole list, is used as the annotated 116# text. Otherwise, the brief description is used as-is. If left blank, the 117# following values are used ($name is automatically replaced with the name of
118# the entity):The $name class, The$name widget, The $name file, is, provides, 119# specifies, contains, represents, a, an and the. 120 121ABBREVIATE_BRIEF = 122 123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124# doxygen will generate a detailed section even if there is only a brief 125# description. 126# The default value is: NO. 127 128ALWAYS_DETAILED_SEC = NO 129 130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131# inherited members of a class in the documentation of that class as if those 132# members were ordinary class members. Constructors, destructors and assignment 133# operators of the base classes will not be shown. 134# The default value is: NO. 135 136INLINE_INHERITED_MEMB = NO 137 138# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139# before files name in the file list and in the header files. If set to NO the 140# shortest path that makes the file name unique will be used 141# The default value is: YES. 142 143FULL_PATH_NAMES = YES 144 145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146# Stripping is only done if one of the specified strings matches the left-hand 147# part of the path. The tag can be used to show relative paths in the file list. 148# If left blank the directory from which doxygen is run is used as the path to 149# strip. 150# 151# Note that you can specify absolute paths here, but also relative paths, which 152# will be relative from the directory where doxygen is started. 153# This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 155STRIP_FROM_PATH =$(ROOT)
156
157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
163
164STRIP_FROM_INC_PATH    = $(ROOT) 165 166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167# less readable) file names. This can be useful is your file systems doesn't 168# support long names like on DOS, Mac, or CD-ROM. 169# The default value is: NO. 170 171SHORT_NAMES = NO 172 173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174# first line (until the first dot) of a Javadoc-style comment as the brief 175# description. If set to NO, the Javadoc-style will behave just like regular Qt- 176# style comments (thus requiring an explicit @brief command for a brief 177# description.) 178# The default value is: NO. 179 180JAVADOC_AUTOBRIEF = YES 181 182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183# line (until the first dot) of a Qt-style comment as the brief description. If 184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185# requiring an explicit \brief command for a brief description.) 186# The default value is: NO. 187 188QT_AUTOBRIEF = NO 189 190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192# a brief description. This used to be the default behavior. The new default is 193# to treat a multi-line C++ comment block as a detailed description. Set this 194# tag to YES if you prefer the old behavior instead. 195# 196# Note that setting this tag to YES also means that rational rose comments are 197# not recognized any more. 198# The default value is: NO. 199 200MULTILINE_CPP_IS_BRIEF = NO 201 202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203# documentation from any documented member that it re-implements. 204# The default value is: YES. 205 206INHERIT_DOCS = YES 207 208# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 209# page for each member. If set to NO, the documentation of a member will be part 210# of the file/class/namespace that contains it. 211# The default value is: NO. 212 213SEPARATE_MEMBER_PAGES = NO 214 215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216# uses this value to replace tabs by spaces in code fragments. 217# Minimum value: 1, maximum value: 16, default value: 4. 218 219TAB_SIZE = 8 220 221# This tag can be used to specify a number of aliases that act as commands in 222# the documentation. An alias has the form: 223# name=value 224# For example adding 225# "sideeffect=@par Side Effects:\n" 226# will allow you to put the command \sideeffect (or @sideeffect) in the 227# documentation, which will result in a user-defined paragraph with heading 228# "Side Effects:". You can put \n's in the value part of an alias to insert 229# newlines. 230 231ALIASES = 232 233## Indexes VPP graph nodes 234ALIASES += "node=@xrefitem nodes \"Node Identifier\" \"Node Identifiers\" @c " 235 236## Formatting for CLI commands and output 237ALIASES += "cli{1}=<code><pre>\1</code></pre>" 238ALIASES += "clistart=<code><pre>" 239ALIASES += "cliend=</pre></code>" 240 241## Formatting for CLI example paragraphs 242ALIASES += "cliexpar=@par Example usage" 243ALIASES += "cliexcmd{1}=@clistart<b>vpp# <em>\1</em></b>@cliend" 244ALIASES += "cliexstart{1}=@cliexcmd{\1}@clistart" 245ALIASES += "cliexend=@cliend" 246 247 248# This tag can be used to specify a number of word-keyword mappings (TCL only). 249# A mapping has the form "name=value". For example adding "class=itcl::class" 250# will allow you to use the command class in the itcl::class meaning. 251 252TCL_SUBST = 253 254# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 255# only. Doxygen will then generate output that is more tailored for C. For 256# instance, some of the names that are used will be different. The list of all 257# members will be omitted, etc. 258# The default value is: NO. 259 260OPTIMIZE_OUTPUT_FOR_C = YES 261 262# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 263# Python sources only. Doxygen will then generate output that is more tailored 264# for that language. For instance, namespaces will be presented as packages, 265# qualified scopes will look different, etc. 266# The default value is: NO. 267 268OPTIMIZE_OUTPUT_JAVA = NO 269 270# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 271# sources. Doxygen will then generate output that is tailored for Fortran. 272# The default value is: NO. 273 274OPTIMIZE_FOR_FORTRAN = NO 275 276# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 277# sources. Doxygen will then generate output that is tailored for VHDL. 278# The default value is: NO. 279 280OPTIMIZE_OUTPUT_VHDL = NO 281 282# Doxygen selects the parser to use depending on the extension of the files it 283# parses. With this tag you can assign which parser to use for a given 284# extension. Doxygen has a built-in mapping, but you can override or extend it 285# using this tag. The format is ext=language, where ext is a file extension, and 286# language is one of the parsers supported by doxygen: IDL, Java, Javascript, 287# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 288# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 289# Fortran. In the later case the parser tries to guess whether the code is fixed 290# or free formatted code, this is the default for Fortran type files), VHDL. For 291# instance to make doxygen treat .inc files as Fortran files (default is PHP), 292# and .f files as C (default is Fortran), use: inc=Fortran f=C. 293# 294# Note: For files without extension you can use no_extension as a placeholder. 295# 296# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 297# the files are not read by doxygen. 298 299EXTENSION_MAPPING = def=C api=C 300 301# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 302# according to the Markdown format, which allows for more readable 303# documentation. See http://daringfireball.net/projects/markdown/ for details. 304# The output of markdown processing is further processed by doxygen, so you can 305# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 306# case of backward compatibilities issues. 307# The default value is: YES. 308 309MARKDOWN_SUPPORT = YES 310 311# When enabled doxygen tries to link words that correspond to documented 312# classes, or namespaces to their corresponding documentation. Such a link can 313# be prevented in individual cases by putting a % sign in front of the word or 314# globally by setting AUTOLINK_SUPPORT to NO. 315# The default value is: YES. 316 317AUTOLINK_SUPPORT = YES 318 319# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 320# to include (a tag file for) the STL sources as input, then you should set this 321# tag to YES in order to let doxygen match functions declarations and 322# definitions whose arguments contain STL classes (e.g. func(std::string); 323# versus func(std::string) {}). This also make the inheritance and collaboration 324# diagrams that involve STL classes more complete and accurate. 325# The default value is: NO. 326 327BUILTIN_STL_SUPPORT = NO 328 329# If you use Microsoft's C++/CLI language, you should set this option to YES to 330# enable parsing support. 331# The default value is: NO. 332 333CPP_CLI_SUPPORT = NO 334 335# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 336# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 337# will parse them like normal C++ but will assume all classes use public instead 338# of private inheritance when no explicit protection keyword is present. 339# The default value is: NO. 340 341SIP_SUPPORT = NO 342 343# For Microsoft's IDL there are propget and propput attributes to indicate 344# getter and setter methods for a property. Setting this option to YES will make 345# doxygen to replace the get and set methods by a property in the documentation. 346# This will only work if the methods are indeed getting or setting a simple 347# type. If this is not the case, or you want to show the methods anyway, you 348# should set this option to NO. 349# The default value is: YES. 350 351IDL_PROPERTY_SUPPORT = YES 352 353# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 354# tag is set to YES then doxygen will reuse the documentation of the first 355# member in the group (if any) for the other members of the group. By default 356# all members of a group must be documented explicitly. 357# The default value is: NO. 358 359DISTRIBUTE_GROUP_DOC = NO 360 361# If one adds a struct or class to a group and this option is enabled, then also 362# any nested class or struct is added to the same group. By default this option 363# is disabled and one has to add nested compounds explicitly via \ingroup. 364# The default value is: NO. 365 366GROUP_NESTED_COMPOUNDS = NO 367 368# Set the SUBGROUPING tag to YES to allow class member groups of the same type 369# (for instance a group of public functions) to be put as a subgroup of that 370# type (e.g. under the Public Functions section). Set it to NO to prevent 371# subgrouping. Alternatively, this can be done per class using the 372# \nosubgrouping command. 373# The default value is: YES. 374 375SUBGROUPING = YES 376 377# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 378# are shown inside the group in which they are included (e.g. using \ingroup) 379# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 380# and RTF). 381# 382# Note that this feature does not work in combination with 383# SEPARATE_MEMBER_PAGES. 384# The default value is: NO. 385 386INLINE_GROUPED_CLASSES = NO 387 388# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 389# with only public data fields or simple typedef fields will be shown inline in 390# the documentation of the scope in which they are defined (i.e. file, 391# namespace, or group documentation), provided this scope is documented. If set 392# to NO, structs, classes, and unions are shown on a separate page (for HTML and 393# Man pages) or section (for LaTeX and RTF). 394# The default value is: NO. 395 396INLINE_SIMPLE_STRUCTS = NO 397 398# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 399# enum is documented as struct, union, or enum with the name of the typedef. So 400# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 401# with name TypeT. When disabled the typedef will appear as a member of a file, 402# namespace, or class. And the struct will be named TypeS. This can typically be 403# useful for C code in case the coding convention dictates that all compound 404# types are typedef'ed and only the typedef is referenced, never the tag name. 405# The default value is: NO. 406 407TYPEDEF_HIDES_STRUCT = NO 408 409# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 410# cache is used to resolve symbols given their name and scope. Since this can be 411# an expensive process and often the same symbol appears multiple times in the 412# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 413# doxygen will become slower. If the cache is too large, memory is wasted. The 414# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 415# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 416# symbols. At the end of a run doxygen will report the cache usage and suggest 417# the optimal cache size from a speed point of view. 418# Minimum value: 0, maximum value: 9, default value: 0. 419 420LOOKUP_CACHE_SIZE = 0 421 422#--------------------------------------------------------------------------- 423# Build related configuration options 424#--------------------------------------------------------------------------- 425 426# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 427# documentation are documented, even if no documentation was available. Private 428# class members and static file members will be hidden unless the 429# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 430# Note: This will also disable the warnings about undocumented members that are 431# normally produced when WARNINGS is set to YES. 432# The default value is: NO. 433 434EXTRACT_ALL = YES 435 436# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 437# be included in the documentation. 438# The default value is: NO. 439 440EXTRACT_PRIVATE = NO 441 442# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 443# scope will be included in the documentation. 444# The default value is: NO. 445 446EXTRACT_PACKAGE = NO 447 448# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 449# included in the documentation. 450# The default value is: NO. 451 452EXTRACT_STATIC = YES 453 454# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 455# locally in source files will be included in the documentation. If set to NO, 456# only classes defined in header files are included. Does not have any effect 457# for Java sources. 458# The default value is: YES. 459 460EXTRACT_LOCAL_CLASSES = YES 461 462# This flag is only useful for Objective-C code. If set to YES, local methods, 463# which are defined in the implementation section but not in the interface are 464# included in the documentation. If set to NO, only methods in the interface are 465# included. 466# The default value is: NO. 467 468EXTRACT_LOCAL_METHODS = NO 469 470# If this flag is set to YES, the members of anonymous namespaces will be 471# extracted and appear in the documentation as a namespace called 472# 'anonymous_namespace{file}', where file will be replaced with the base name of 473# the file that contains the anonymous namespace. By default anonymous namespace 474# are hidden. 475# The default value is: NO. 476 477EXTRACT_ANON_NSPACES = NO 478 479# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 480# undocumented members inside documented classes or files. If set to NO these 481# members will be included in the various overviews, but no documentation 482# section is generated. This option has no effect if EXTRACT_ALL is enabled. 483# The default value is: NO. 484 485HIDE_UNDOC_MEMBERS = NO 486 487# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 488# undocumented classes that are normally visible in the class hierarchy. If set 489# to NO, these classes will be included in the various overviews. This option 490# has no effect if EXTRACT_ALL is enabled. 491# The default value is: NO. 492 493HIDE_UNDOC_CLASSES = NO 494 495# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 496# (class|struct|union) declarations. If set to NO, these declarations will be 497# included in the documentation. 498# The default value is: NO. 499 500HIDE_FRIEND_COMPOUNDS = NO 501 502# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 503# documentation blocks found inside the body of a function. If set to NO, these 504# blocks will be appended to the function's detailed documentation block. 505# The default value is: NO. 506 507HIDE_IN_BODY_DOCS = NO 508 509# The INTERNAL_DOCS tag determines if documentation that is typed after a 510# \internal command is included. If the tag is set to NO then the documentation 511# will be excluded. Set it to YES to include the internal documentation. 512# The default value is: NO. 513 514INTERNAL_DOCS = NO 515 516# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 517# names in lower-case letters. If set to YES, upper-case letters are also 518# allowed. This is useful if you have classes or files whose names only differ 519# in case and if your file system supports case sensitive file names. Windows 520# and Mac users are advised to set this option to NO. 521# The default value is: system dependent. 522 523CASE_SENSE_NAMES = NO 524 525# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 526# their full class and namespace scopes in the documentation. If set to YES, the 527# scope will be hidden. 528# The default value is: NO. 529 530HIDE_SCOPE_NAMES = NO 531 532# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 533# append additional text to a page's title, such as Class Reference. If set to 534# YES the compound reference will be hidden. 535# The default value is: NO. 536 537HIDE_COMPOUND_REFERENCE= NO 538 539# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 540# the files that are included by a file in the documentation of that file. 541# The default value is: YES. 542 543SHOW_INCLUDE_FILES = NO 544 545# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 546# grouped member an include statement to the documentation, telling the reader 547# which file to include in order to use the member. 548# The default value is: NO. 549 550SHOW_GROUPED_MEMB_INC = YES 551 552# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 553# files with double quotes in the documentation rather than with sharp brackets. 554# The default value is: NO. 555 556FORCE_LOCAL_INCLUDES = NO 557 558# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 559# documentation for inline members. 560# The default value is: YES. 561 562INLINE_INFO = YES 563 564# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 565# (detailed) documentation of file and class members alphabetically by member 566# name. If set to NO, the members will appear in declaration order. 567# The default value is: YES. 568 569SORT_MEMBER_DOCS = YES 570 571# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 572# descriptions of file, namespace and class members alphabetically by member 573# name. If set to NO, the members will appear in declaration order. Note that 574# this will also influence the order of the classes in the class list. 575# The default value is: NO. 576 577SORT_BRIEF_DOCS = NO 578 579# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 580# (brief and detailed) documentation of class members so that constructors and 581# destructors are listed first. If set to NO the constructors will appear in the 582# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 583# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 584# member documentation. 585# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 586# detailed member documentation. 587# The default value is: NO. 588 589SORT_MEMBERS_CTORS_1ST = NO 590 591# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 592# of group names into alphabetical order. If set to NO the group names will 593# appear in their defined order. 594# The default value is: NO. 595 596SORT_GROUP_NAMES = YES 597 598# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 599# fully-qualified names, including namespaces. If set to NO, the class list will 600# be sorted only by class name, not including the namespace part. 601# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 602# Note: This option applies only to the class list, not to the alphabetical 603# list. 604# The default value is: NO. 605 606SORT_BY_SCOPE_NAME = NO 607 608# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 609# type resolution of all parameters of a function it will reject a match between 610# the prototype and the implementation of a member function even if there is 611# only one candidate or it is obvious which candidate to choose by doing a 612# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 613# accept a match between prototype and implementation in such cases. 614# The default value is: NO. 615 616STRICT_PROTO_MATCHING = NO 617 618# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 619# list. This list is created by putting \todo commands in the documentation. 620# The default value is: YES. 621 622GENERATE_TODOLIST = YES 623 624# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 625# list. This list is created by putting \test commands in the documentation. 626# The default value is: YES. 627 628GENERATE_TESTLIST = YES 629 630# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 631# list. This list is created by putting \bug commands in the documentation. 632# The default value is: YES. 633 634GENERATE_BUGLIST = YES 635 636# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 637# the deprecated list. This list is created by putting \deprecated commands in 638# the documentation. 639# The default value is: YES. 640 641GENERATE_DEPRECATEDLIST= YES 642 643# The ENABLED_SECTIONS tag can be used to enable conditional documentation 644# sections, marked by \if <section_label> ... \endif and \cond <section_label> 645# ... \endcond blocks. 646 647ENABLED_SECTIONS = DPDK 648 649# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 650# initial value of a variable or macro / define can have for it to appear in the 651# documentation. If the initializer consists of more lines than specified here 652# it will be hidden. Use a value of 0 to hide initializers completely. The 653# appearance of the value of individual variables and macros / defines can be 654# controlled using \showinitializer or \hideinitializer command in the 655# documentation regardless of this setting. 656# Minimum value: 0, maximum value: 10000, default value: 30. 657 658MAX_INITIALIZER_LINES = 50 659 660# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 661# the bottom of the documentation of classes and structs. If set to YES, the 662# list will mention the files that were used to generate the documentation. 663# The default value is: YES. 664 665SHOW_USED_FILES = YES 666 667# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 668# will remove the Files entry from the Quick Index and from the Folder Tree View 669# (if specified). 670# The default value is: YES. 671 672SHOW_FILES = YES 673 674# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 675# page. This will remove the Namespaces entry from the Quick Index and from the 676# Folder Tree View (if specified). 677# The default value is: YES. 678 679SHOW_NAMESPACES = YES 680 681# The FILE_VERSION_FILTER tag can be used to specify a program or script that 682# doxygen should invoke to get the current version for each file (typically from 683# the version control system). Doxygen will invoke the program by executing (via 684# popen()) the command command input-file, where command is the value of the 685# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 686# by doxygen. Whatever the program writes to standard output is used as the file 687# version. For an example see the documentation. 688 689FILE_VERSION_FILTER = 690 691# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 692# by doxygen. The layout file controls the global structure of the generated 693# output files in an output format independent way. To create the layout file 694# that represents doxygen's defaults, run doxygen with the -l option. You can 695# optionally specify a file name after the option, if omitted DoxygenLayout.xml 696# will be used as the name of the layout file. 697# 698# Note that if you run doxygen from a directory containing a file called 699# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 700# tag is left empty. 701 702LAYOUT_FILE =$(ROOT)/doxygen/layout.xml
703
704# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
705# the reference definitions. This must be a list of .bib files. The .bib
706# extension is automatically appended if omitted. This requires the bibtex tool
708# For LaTeX the style of the bibliography can be controlled using
709# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
710# search path. See also \cite for info how to create references.
711
712CITE_BIB_FILES         =
713
714#---------------------------------------------------------------------------
715# Configuration options related to warning and progress messages
716#---------------------------------------------------------------------------
717
718# The QUIET tag can be used to turn on/off the messages that are generated to
719# standard output by doxygen. If QUIET is set to YES this implies that the
720# messages are off.
721# The default value is: NO.
722
723QUIET                  = NO
724
725# The WARNINGS tag can be used to turn on/off the warning messages that are
726# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
727# this implies that the warnings are on.
728#
729# Tip: Turn warnings on while writing the documentation.
730# The default value is: YES.
731
732WARNINGS               = YES
733
734# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
735# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
736# will automatically be disabled.
737# The default value is: YES.
738
739WARN_IF_UNDOCUMENTED   = YES
740
741# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
742# potential errors in the documentation, such as not documenting some parameters
743# in a documented function, or documenting parameters that don't exist or using
744# markup commands wrongly.
745# The default value is: YES.
746
747WARN_IF_DOC_ERROR      = YES
748
749# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
750# are documented, but have no documentation for their parameters or return
751# value. If set to NO, doxygen will only warn about wrong or incomplete
752# parameter documentation, but not about the absence of documentation.
753# The default value is: NO.
754
755WARN_NO_PARAMDOC       = NO
756
757# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
758# a warning is encountered.
759# The default value is: NO.
760
761WARN_AS_ERROR          = NO
762
763# The WARN_FORMAT tag determines the format of the warning messages that doxygen
764# can produce. The string should contain the $file,$line, and $text tags, which 765# will be replaced by the file and line number from which the warning originated 766# and the warning text. Optionally the format may contain$version, which will
767# be replaced by the version of the file (if it could be obtained via
768# FILE_VERSION_FILTER)
769# The default value is: $file:$line: $text. 770 771WARN_FORMAT = "$file:$line:$text"
772
773# The WARN_LOGFILE tag can be used to specify a file to which warning and error
774# messages should be written. If left blank the output is written to standard
775# error (stderr).
776
777WARN_LOGFILE           =
778
779#---------------------------------------------------------------------------
780# Configuration options related to the input files
781#---------------------------------------------------------------------------
782
783# The INPUT tag is used to specify the files and/or directories that contain
784# documented source files. You may enter file names like myfile.cpp or
785# directories like /usr/src/myproject. Separate the files or directories with
787# Note: If this tag is empty the current directory is searched.
788
789INPUT                  = $(INPUT) 790 791# This tag can be used to specify the character encoding of the source files 792# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 793# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 794# documentation (see: http://www.gnu.org/software/libiconv) for the list of 795# possible encodings. 796# The default value is: UTF-8. 797 798INPUT_ENCODING = UTF-8 799 800# If the value of the INPUT tag contains directories, you can use the 801# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 802# *.h) to filter out the source-files in the directories. 803# 804# Note that for custom extensions or not directly supported extensions you also 805# need to set EXTENSION_MAPPING for the extension otherwise the files are not 806# read by doxygen. 807# 808# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 809# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 810# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 811# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, 812# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 813 814FILE_PATTERNS = *.md *.c *.h *.def *.inc *.S *.dox *.api 815 816# The RECURSIVE tag can be used to specify whether or not subdirectories should 817# be searched for input files as well. 818# The default value is: NO. 819 820RECURSIVE = YES 821 822# The EXCLUDE tag can be used to specify files and/or directories that should be 823# excluded from the INPUT source files. This way you can easily exclude a 824# subdirectory from a directory tree whose root is specified with the INPUT tag. 825# 826# Note that relative paths are relative to the directory from which doxygen is 827# run. 828 829EXCLUDE =$(EXCLUDE)
830
831# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
832# directories that are symbolic links (a Unix file system feature) are excluded
833# from the input.
834# The default value is: NO.
835
837
838# If the value of the INPUT tag contains directories, you can use the
839# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
840# certain files from those directories.
841#
842# Note that the wildcards are matched against the file with absolute path, so to
843# exclude all test directories for example use the pattern */test/*
844
845EXCLUDE_PATTERNS       = */test/* *_test.c test_*.c
846
847# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
848# (namespaces, classes, functions, etc.) that should be excluded from the
849# output. The symbol name can be a fully qualified name, a word, or if the
850# wildcard * is used, a substring. Examples: ANamespace, AClass,
851# AClass::ANamespace, ANamespace::*Test
852#
853# Note that the wildcards are matched against the file with absolute path, so to
854# exclude all test directories use the pattern */test/*
855
856EXCLUDE_SYMBOLS        = _ _*
857
858# The EXAMPLE_PATH tag can be used to specify one or more files or directories
859# that contain example code fragments that are included (see the \include
860# command).
861
862EXAMPLE_PATH           =
863
864# If the value of the EXAMPLE_PATH tag contains directories, you can use the
865# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
866# *.h) to filter out the source-files in the directories. If left blank all
867# files are included.
868
869EXAMPLE_PATTERNS       = *.c *.h
870
871# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
872# searched for input files to be used with the \include or \dontinclude commands
873# irrespective of the value of the RECURSIVE tag.
874# The default value is: NO.
875
876EXAMPLE_RECURSIVE      = NO
877
878# The IMAGE_PATH tag can be used to specify one or more files or directories
879# that contain images that are to be included in the documentation (see the
880# \image command).
881
882IMAGE_PATH             = $(ROOT)/doxygen/assets 883 884# The INPUT_FILTER tag can be used to specify a program that doxygen should 885# invoke to filter for each input file. Doxygen will invoke the filter program 886# by executing (via popen()) the command: 887# 888# <filter> <input-file> 889# 890# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 891# name of an input file. Doxygen will then use the output that the filter 892# program writes to standard output. If FILTER_PATTERNS is specified, this tag 893# will be ignored. 894# 895# Note that the filter must not add or remove lines; it is applied before the 896# code is scanned, but not when the output code is generated. If lines are added 897# or removed, the anchors will not be placed correctly. 898# 899# Note that for custom extensions or not directly supported extensions you also 900# need to set EXTENSION_MAPPING for the extension otherwise the files are not 901# properly processed by doxygen. 902 903INPUT_FILTER = 904 905# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 906# basis. Doxygen will compare the file name with each pattern and apply the 907# filter if there is a match. The filters are a list of the form: pattern=filter 908# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 909# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 910# patterns match the file name, INPUT_FILTER is applied. 911# 912# Note that for custom extensions or not directly supported extensions you also 913# need to set EXTENSION_MAPPING for the extension otherwise the files are not 914# properly processed by doxygen. 915 916FILTER_PATTERNS = \ 917 *.c=$(ROOT)/doxygen/filter_c.py \
918	*.h=$(ROOT)/doxygen/filter_h.py \ 919 *.api=$(ROOT)/doxygen/filter_api.py
920
921# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
922# INPUT_FILTER) will also be used to filter the input files that are used for
923# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
924# The default value is: NO.
925
926FILTER_SOURCE_FILES    = NO
927
928# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
929# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
930# it is also possible to disable source filtering for a specific pattern using
931# *.ext= (so without naming a filter).
932# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
933
934FILTER_SOURCE_PATTERNS =
935
936# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
937# is part of the input, its contents will be placed on the main page
938# (index.html). This can be useful if you have a project on for instance GitHub
939# and want to reuse the introduction page also for the doxygen output.
940
941USE_MDFILE_AS_MAINPAGE = $(ROOT)/README.md 942 943#--------------------------------------------------------------------------- 944# Configuration options related to source browsing 945#--------------------------------------------------------------------------- 946 947# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 948# generated. Documented entities will be cross-referenced with these sources. 949# 950# Note: To get rid of all source code in the generated output, make sure that 951# also VERBATIM_HEADERS is set to NO. 952# The default value is: NO. 953 954SOURCE_BROWSER = YES 955 956# Setting the INLINE_SOURCES tag to YES will include the body of functions, 957# classes and enums directly into the documentation. 958# The default value is: NO. 959 960INLINE_SOURCES = NO 961 962# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 963# special comment blocks from generated source code fragments. Normal C, C++ and 964# Fortran comments will always remain visible. 965# The default value is: YES. 966 967STRIP_CODE_COMMENTS = NO 968 969# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 970# function all documented functions referencing it will be listed. 971# The default value is: NO. 972 973REFERENCED_BY_RELATION = NO 974 975# If the REFERENCES_RELATION tag is set to YES then for each documented function 976# all documented entities called/used by that function will be listed. 977# The default value is: NO. 978 979REFERENCES_RELATION = NO 980 981# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 982# to YES then the hyperlinks from functions in REFERENCES_RELATION and 983# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 984# link to the documentation. 985# The default value is: YES. 986 987REFERENCES_LINK_SOURCE = YES 988 989# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 990# source code will show a tooltip with additional information such as prototype, 991# brief description and links to the definition and documentation. Since this 992# will make the HTML file larger and loading of large files a bit slower, you 993# can opt to disable this feature. 994# The default value is: YES. 995# This tag requires that the tag SOURCE_BROWSER is set to YES. 996 997SOURCE_TOOLTIPS = YES 998 999# If the USE_HTAGS tag is set to YES then the references to source code will 1000# point to the HTML generated by the htags(1) tool instead of doxygen built-in 1001# source browser. The htags tool is part of GNU's global source tagging system 1002# (see http://www.gnu.org/software/global/global.html). You will need version 1003# 4.8.6 or higher. 1004# 1005# To use it do the following: 1006# - Install the latest version of global 1007# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1008# - Make sure the INPUT points to the root of the source tree 1009# - Run doxygen as normal 1010# 1011# Doxygen will invoke htags (and that will in turn invoke gtags), so these 1012# tools must be available from the command line (i.e. in the search path). 1013# 1014# The result: instead of the source browser generated by doxygen, the links to 1015# source code will now point to the output of htags. 1016# The default value is: NO. 1017# This tag requires that the tag SOURCE_BROWSER is set to YES. 1018 1019USE_HTAGS = NO 1020 1021# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1022# verbatim copy of the header file for each class for which an include is 1023# specified. Set to NO to disable this. 1024# See also: Section \class. 1025# The default value is: YES. 1026 1027VERBATIM_HEADERS = YES 1028 1029# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1030# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1031# cost of reduced performance. This can be particularly helpful with template 1032# rich C++ code for which doxygen's built-in parser lacks the necessary type 1033# information. 1034# Note: The availability of this option depends on whether or not doxygen was 1035# generated with the -Duse-libclang=ON option for CMake. 1036# The default value is: NO. 1037 1038CLANG_ASSISTED_PARSING = NO 1039 1040# If clang assisted parsing is enabled you can provide the compiler with command 1041# line options that you would normally use when invoking the compiler. Note that 1042# the include paths will already be set by doxygen for the files and directories 1043# specified with INPUT and INCLUDE_PATH. 1044# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1045 1046CLANG_OPTIONS = 1047 1048#--------------------------------------------------------------------------- 1049# Configuration options related to the alphabetical class index 1050#--------------------------------------------------------------------------- 1051 1052# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1053# compounds will be generated. Enable this if the project contains a lot of 1054# classes, structs, unions or interfaces. 1055# The default value is: YES. 1056 1057ALPHABETICAL_INDEX = YES 1058 1059# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1060# which the alphabetical index list will be split. 1061# Minimum value: 1, maximum value: 20, default value: 5. 1062# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1063 1064COLS_IN_ALPHA_INDEX = 5 1065 1066# In case all classes in a project start with a common prefix, all classes will 1067# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1068# can be used to specify a prefix (or a list of prefixes) that should be ignored 1069# while generating the index headers. 1070# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1071 1072IGNORE_PREFIX = 1073 1074#--------------------------------------------------------------------------- 1075# Configuration options related to the HTML output 1076#--------------------------------------------------------------------------- 1077 1078# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1079# The default value is: YES. 1080 1081GENERATE_HTML = YES 1082 1083# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1084# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1085# it. 1086# The default directory is: html. 1087# This tag requires that the tag GENERATE_HTML is set to YES. 1088 1089HTML_OUTPUT = html 1090 1091# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1092# generated HTML page (for example: .htm, .php, .asp). 1093# The default value is: .html. 1094# This tag requires that the tag GENERATE_HTML is set to YES. 1095 1096HTML_FILE_EXTENSION = .html 1097 1098# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1099# each generated HTML page. If the tag is left blank doxygen will generate a 1100# standard header. 1101# 1102# To get valid HTML the header file that includes any scripts and style sheets 1103# that doxygen needs, which is dependent on the configuration options used (e.g. 1104# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1105# default header using 1106# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1107# YourConfigFile 1108# and then modify the file new_header.html. See also section "Doxygen usage" 1109# for information on how to generate the default header that doxygen normally 1110# uses. 1111# Note: The header is subject to change so you typically have to regenerate the 1112# default header when upgrading to a newer version of doxygen. For a description 1113# of the possible markers and block names see the documentation. 1114# This tag requires that the tag GENERATE_HTML is set to YES. 1115 1116HTML_HEADER = 1117 1118# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1119# generated HTML page. If the tag is left blank doxygen will generate a standard 1120# footer. See HTML_HEADER for more information on how to generate a default 1121# footer and what special commands can be used inside the footer. See also 1122# section "Doxygen usage" for information on how to generate the default footer 1123# that doxygen normally uses. 1124# This tag requires that the tag GENERATE_HTML is set to YES. 1125 1126HTML_FOOTER = 1127 1128# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1129# sheet that is used by each HTML page. It can be used to fine-tune the look of 1130# the HTML output. If left blank doxygen will generate a default style sheet. 1131# See also section "Doxygen usage" for information on how to generate the style 1132# sheet that doxygen normally uses. 1133# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1134# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1135# obsolete. 1136# This tag requires that the tag GENERATE_HTML is set to YES. 1137 1138HTML_STYLESHEET = 1139 1140# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1141# cascading style sheets that are included after the standard style sheets 1142# created by doxygen. Using this option one can overrule certain style aspects. 1143# This is preferred over using HTML_STYLESHEET since it does not replace the 1144# standard style sheet and is therefore more robust against future updates. 1145# Doxygen will copy the style sheet files to the output directory. 1146# Note: The order of the extra style sheet files is of importance (e.g. the last 1147# style sheet in the list overrules the setting of the previous ones in the 1148# list). For an example see the documentation. 1149# This tag requires that the tag GENERATE_HTML is set to YES. 1150 1151HTML_EXTRA_STYLESHEET =$(ROOT)/doxygen/assets/doxy-vpp.css
1152
1153# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1154# other source files which should be copied to the HTML output directory. Note
1155# that these files will be copied to the base HTML output directory. Use the
1156# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1157# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1158# files will be copied as-is; there are no commands or markers available. 1159# This tag requires that the tag GENERATE_HTML is set to YES. 1160 1161HTML_EXTRA_FILES = 1162 1163# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1164# will adjust the colors in the style sheet and background images according to 1165# this color. Hue is specified as an angle on a colorwheel, see 1166# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1167# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1168# purple, and 360 is red again. 1169# Minimum value: 0, maximum value: 359, default value: 220. 1170# This tag requires that the tag GENERATE_HTML is set to YES. 1171 1172HTML_COLORSTYLE_HUE = 230 1173 1174# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1175# in the HTML output. For a value of 0 the output will use grayscales only. A 1176# value of 255 will produce the most vivid colors. 1177# Minimum value: 0, maximum value: 255, default value: 100. 1178# This tag requires that the tag GENERATE_HTML is set to YES. 1179 1180HTML_COLORSTYLE_SAT = 255 1181 1182# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1183# luminance component of the colors in the HTML output. Values below 100 1184# gradually make the output lighter, whereas values above 100 make the output 1185# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1186# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1187# change the gamma. 1188# Minimum value: 40, maximum value: 240, default value: 80. 1189# This tag requires that the tag GENERATE_HTML is set to YES. 1190 1191HTML_COLORSTYLE_GAMMA = 80 1192 1193# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1194# page will contain the date and time when the page was generated. Setting this 1195# to YES can help to show when doxygen was last run and thus if the 1196# documentation is up to date. 1197# The default value is: NO. 1198# This tag requires that the tag GENERATE_HTML is set to YES. 1199 1200HTML_TIMESTAMP = YES 1201 1202# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1203# documentation will contain sections that can be hidden and shown after the 1204# page has loaded. 1205# The default value is: NO. 1206# This tag requires that the tag GENERATE_HTML is set to YES. 1207 1208HTML_DYNAMIC_SECTIONS = YES 1209 1210# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1211# shown in the various tree structured indices initially; the user can expand 1212# and collapse entries dynamically later on. Doxygen will expand the tree to 1213# such a level that at most the specified number of entries are visible (unless 1214# a fully collapsed tree already exceeds this amount). So setting the number of 1215# entries 1 will produce a full collapsed tree by default. 0 is a special value 1216# representing an infinite number of entries and will result in a full expanded 1217# tree by default. 1218# Minimum value: 0, maximum value: 9999, default value: 100. 1219# This tag requires that the tag GENERATE_HTML is set to YES. 1220 1221HTML_INDEX_NUM_ENTRIES = 100 1222 1223# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1224# generated that can be used as input for Apple's Xcode 3 integrated development 1225# environment (see: http://developer.apple.com/tools/xcode/), introduced with 1226# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1227# Makefile in the HTML output directory. Running make will produce the docset in 1228# that directory and running make install will install the docset in 1229# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1230# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1231# for more information. 1232# The default value is: NO. 1233# This tag requires that the tag GENERATE_HTML is set to YES. 1234 1235GENERATE_DOCSET = NO 1236 1237# This tag determines the name of the docset feed. A documentation feed provides 1238# an umbrella under which multiple documentation sets from a single provider 1239# (such as a company or product suite) can be grouped. 1240# The default value is: Doxygen generated docs. 1241# This tag requires that the tag GENERATE_DOCSET is set to YES. 1242 1243DOCSET_FEEDNAME = "FD.io VPP" 1244 1245# This tag specifies a string that should uniquely identify the documentation 1246# set bundle. This should be a reverse domain-name style string, e.g. 1247# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1248# The default value is: org.doxygen.Project. 1249# This tag requires that the tag GENERATE_DOCSET is set to YES. 1250 1251DOCSET_BUNDLE_ID = io.fd.vpp 1252 1253# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1254# the documentation publisher. This should be a reverse domain-name style 1255# string, e.g. com.mycompany.MyDocSet.documentation. 1256# The default value is: org.doxygen.Publisher. 1257# This tag requires that the tag GENERATE_DOCSET is set to YES. 1258 1259DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1260 1261# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1262# The default value is: Publisher. 1263# This tag requires that the tag GENERATE_DOCSET is set to YES. 1264 1265DOCSET_PUBLISHER_NAME = Publisher 1266 1267# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1268# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1269# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1270# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1271# Windows. 1272# 1273# The HTML Help Workshop contains a compiler that can convert all HTML output 1274# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1275# files are now used as the Windows 98 help format, and will replace the old 1276# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1277# HTML files also contain an index, a table of contents, and you can search for 1278# words in the documentation. The HTML workshop also contains a viewer for 1279# compressed HTML files. 1280# The default value is: NO. 1281# This tag requires that the tag GENERATE_HTML is set to YES. 1282 1283GENERATE_HTMLHELP = NO 1284 1285# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1286# file. You can add a path in front of the file if the result should not be 1287# written to the html output directory. 1288# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1289 1290CHM_FILE = 1291 1292# The HHC_LOCATION tag can be used to specify the location (absolute path 1293# including file name) of the HTML help compiler (hhc.exe). If non-empty, 1294# doxygen will try to run the HTML help compiler on the generated index.hhp. 1295# The file has to be specified with full path. 1296# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1297 1298HHC_LOCATION = 1299 1300# The GENERATE_CHI flag controls if a separate .chi index file is generated 1301# (YES) or that it should be included in the master .chm file (NO). 1302# The default value is: NO. 1303# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1304 1305GENERATE_CHI = NO 1306 1307# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1308# and project file content. 1309# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1310 1311CHM_INDEX_ENCODING = 1312 1313# The BINARY_TOC flag controls whether a binary table of contents is generated 1314# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1315# enables the Previous and Next buttons. 1316# The default value is: NO. 1317# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1318 1319BINARY_TOC = NO 1320 1321# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1322# the table of contents of the HTML help documentation and to the tree view. 1323# The default value is: NO. 1324# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1325 1326TOC_EXPAND = NO 1327 1328# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1329# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1330# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1331# (.qch) of the generated HTML documentation. 1332# The default value is: NO. 1333# This tag requires that the tag GENERATE_HTML is set to YES. 1334 1335GENERATE_QHP = NO 1336 1337# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1338# the file name of the resulting .qch file. The path specified is relative to 1339# the HTML output folder. 1340# This tag requires that the tag GENERATE_QHP is set to YES. 1341 1342QCH_FILE = 1343 1344# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1345# Project output. For more information please see Qt Help Project / Namespace 1346# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1347# The default value is: org.doxygen.Project. 1348# This tag requires that the tag GENERATE_QHP is set to YES. 1349 1350QHP_NAMESPACE = io.fd.vpp 1351 1352# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1353# Help Project output. For more information please see Qt Help Project / Virtual 1354# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1355# folders). 1356# The default value is: doc. 1357# This tag requires that the tag GENERATE_QHP is set to YES. 1358 1359QHP_VIRTUAL_FOLDER = doc 1360 1361# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1362# filter to add. For more information please see Qt Help Project / Custom 1363# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1364# filters). 1365# This tag requires that the tag GENERATE_QHP is set to YES. 1366 1367QHP_CUST_FILTER_NAME = 1368 1369# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1370# custom filter to add. For more information please see Qt Help Project / Custom 1371# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1372# filters). 1373# This tag requires that the tag GENERATE_QHP is set to YES. 1374 1375QHP_CUST_FILTER_ATTRS = 1376 1377# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1378# project's filter section matches. Qt Help Project / Filter Attributes (see: 1379# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1380# This tag requires that the tag GENERATE_QHP is set to YES. 1381 1382QHP_SECT_FILTER_ATTRS = 1383 1384# The QHG_LOCATION tag can be used to specify the location of Qt's 1385# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1386# generated .qhp file. 1387# This tag requires that the tag GENERATE_QHP is set to YES. 1388 1389QHG_LOCATION = 1390 1391# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1392# generated, together with the HTML files, they form an Eclipse help plugin. To 1393# install this plugin and make it available under the help contents menu in 1394# Eclipse, the contents of the directory containing the HTML and XML files needs 1395# to be copied into the plugins directory of eclipse. The name of the directory 1396# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1397# After copying Eclipse needs to be restarted before the help appears. 1398# The default value is: NO. 1399# This tag requires that the tag GENERATE_HTML is set to YES. 1400 1401GENERATE_ECLIPSEHELP = YES 1402 1403# A unique identifier for the Eclipse help plugin. When installing the plugin 1404# the directory name containing the HTML and XML files should also have this 1405# name. Each documentation set should have its own identifier. 1406# The default value is: org.doxygen.Project. 1407# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1408 1409ECLIPSE_DOC_ID = io.fd.vpp 1410 1411# If you want full control over the layout of the generated HTML pages it might 1412# be necessary to disable the index and replace it with your own. The 1413# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1414# of each HTML page. A value of NO enables the index and the value YES disables 1415# it. Since the tabs in the index contain the same information as the navigation 1416# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1417# The default value is: NO. 1418# This tag requires that the tag GENERATE_HTML is set to YES. 1419 1420DISABLE_INDEX = NO 1421 1422# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1423# structure should be generated to display hierarchical information. If the tag 1424# value is set to YES, a side panel will be generated containing a tree-like 1425# index structure (just like the one that is generated for HTML Help). For this 1426# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1427# (i.e. any modern browser). Windows users are probably better off using the 1428# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1429# further fine-tune the look of the index. As an example, the default style 1430# sheet generated by doxygen has an example that shows how to put an image at 1431# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1432# the same information as the tab index, you could consider setting 1433# DISABLE_INDEX to YES when enabling this option. 1434# The default value is: NO. 1435# This tag requires that the tag GENERATE_HTML is set to YES. 1436 1437GENERATE_TREEVIEW = YES 1438 1439# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1440# doxygen will group on one line in the generated HTML documentation. 1441# 1442# Note that a value of 0 will completely suppress the enum values from appearing 1443# in the overview section. 1444# Minimum value: 0, maximum value: 20, default value: 4. 1445# This tag requires that the tag GENERATE_HTML is set to YES. 1446 1447ENUM_VALUES_PER_LINE = 4 1448 1449# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1450# to set the initial width (in pixels) of the frame in which the tree is shown. 1451# Minimum value: 0, maximum value: 1500, default value: 250. 1452# This tag requires that the tag GENERATE_HTML is set to YES. 1453 1454TREEVIEW_WIDTH = 250 1455 1456# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1457# external symbols imported via tag files in a separate window. 1458# The default value is: NO. 1459# This tag requires that the tag GENERATE_HTML is set to YES. 1460 1461EXT_LINKS_IN_WINDOW = NO 1462 1463# Use this tag to change the font size of LaTeX formulas included as images in 1464# the HTML documentation. When you change the font size after a successful 1465# doxygen run you need to manually remove any form_*.png images from the HTML 1466# output directory to force them to be regenerated. 1467# Minimum value: 8, maximum value: 50, default value: 10. 1468# This tag requires that the tag GENERATE_HTML is set to YES. 1469 1470FORMULA_FONTSIZE = 10 1471 1472# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1473# generated for formulas are transparent PNGs. Transparent PNGs are not 1474# supported properly for IE 6.0, but are supported on all modern browsers. 1475# 1476# Note that when changing this option you need to delete any form_*.png files in 1477# the HTML output directory before the changes have effect. 1478# The default value is: YES. 1479# This tag requires that the tag GENERATE_HTML is set to YES. 1480 1481FORMULA_TRANSPARENT = YES 1482 1483# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1484# http://www.mathjax.org) which uses client side Javascript for the rendering 1485# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1486# installed or if you want to formulas look prettier in the HTML output. When 1487# enabled you may also need to install MathJax separately and configure the path 1488# to it using the MATHJAX_RELPATH option. 1489# The default value is: NO. 1490# This tag requires that the tag GENERATE_HTML is set to YES. 1491 1492USE_MATHJAX = NO 1493 1494# When MathJax is enabled you can set the default output format to be used for 1495# the MathJax output. See the MathJax site (see: 1496# http://docs.mathjax.org/en/latest/output.html) for more details. 1497# Possible values are: HTML-CSS (which is slower, but has the best 1498# compatibility), NativeMML (i.e. MathML) and SVG. 1499# The default value is: HTML-CSS. 1500# This tag requires that the tag USE_MATHJAX is set to YES. 1501 1502MATHJAX_FORMAT = HTML-CSS 1503 1504# When MathJax is enabled you need to specify the location relative to the HTML 1505# output directory using the MATHJAX_RELPATH option. The destination directory 1506# should contain the MathJax.js script. For instance, if the mathjax directory 1507# is located at the same level as the HTML output directory, then 1508# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1509# Content Delivery Network so you can quickly see the result without installing 1510# MathJax. However, it is strongly recommended to install a local copy of 1511# MathJax from http://www.mathjax.org before deployment. 1512# The default value is: http://cdn.mathjax.org/mathjax/latest. 1513# This tag requires that the tag USE_MATHJAX is set to YES. 1514 1515MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1516 1517# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1518# extension names that should be enabled during MathJax rendering. For example 1519# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1520# This tag requires that the tag USE_MATHJAX is set to YES. 1521 1522MATHJAX_EXTENSIONS = 1523 1524# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1525# of code that will be used on startup of the MathJax code. See the MathJax site 1526# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1527# example see the documentation. 1528# This tag requires that the tag USE_MATHJAX is set to YES. 1529 1530MATHJAX_CODEFILE = 1531 1532# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1533# the HTML output. The underlying search engine uses javascript and DHTML and 1534# should work on any modern browser. Note that when using HTML help 1535# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1536# there is already a search function so this one should typically be disabled. 1537# For large projects the javascript based search engine can be slow, then 1538# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1539# search using the keyboard; to jump to the search box use <access key> + S 1540# (what the <access key> is depends on the OS and browser, but it is typically 1541# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1542# key> to jump into the search results window, the results can be navigated 1543# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1544# the search. The filter options can be selected when the cursor is inside the 1545# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1546# to select a filter and <Enter> or <escape> to activate or cancel the filter 1547# option. 1548# The default value is: YES. 1549# This tag requires that the tag GENERATE_HTML is set to YES. 1550 1551SEARCHENGINE = YES 1552 1553# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1554# implemented using a web server instead of a web client using Javascript. There 1555# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1556# setting. When disabled, doxygen will generate a PHP script for searching and 1557# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1558# and searching needs to be provided by external tools. See the section 1559# "External Indexing and Searching" for details. 1560# The default value is: NO. 1561# This tag requires that the tag SEARCHENGINE is set to YES. 1562 1563SERVER_BASED_SEARCH = NO 1564 1565# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1566# script for searching. Instead the search results are written to an XML file 1567# which needs to be processed by an external indexer. Doxygen will invoke an 1568# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1569# search results. 1570# 1571# Doxygen ships with an example indexer (doxyindexer) and search engine 1572# (doxysearch.cgi) which are based on the open source search engine library 1573# Xapian (see: http://xapian.org/). 1574# 1575# See the section "External Indexing and Searching" for details. 1576# The default value is: NO. 1577# This tag requires that the tag SEARCHENGINE is set to YES. 1578 1579EXTERNAL_SEARCH = NO 1580 1581# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1582# which will return the search results when EXTERNAL_SEARCH is enabled. 1583# 1584# Doxygen ships with an example indexer (doxyindexer) and search engine 1585# (doxysearch.cgi) which are based on the open source search engine library 1586# Xapian (see: http://xapian.org/). See the section "External Indexing and 1587# Searching" for details. 1588# This tag requires that the tag SEARCHENGINE is set to YES. 1589 1590SEARCHENGINE_URL = 1591 1592# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1593# search data is written to a file for indexing by an external tool. With the 1594# SEARCHDATA_FILE tag the name of this file can be specified. 1595# The default file is: searchdata.xml. 1596# This tag requires that the tag SEARCHENGINE is set to YES. 1597 1598SEARCHDATA_FILE = searchdata.xml 1599 1600# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1601# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1602# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1603# projects and redirect the results back to the right project. 1604# This tag requires that the tag SEARCHENGINE is set to YES. 1605 1606EXTERNAL_SEARCH_ID = 1607 1608# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1609# projects other than the one defined by this configuration file, but that are 1610# all added to the same external search index. Each project needs to have a 1611# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1612# to a relative location where the documentation can be found. The format is: 1613# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1614# This tag requires that the tag SEARCHENGINE is set to YES. 1615 1616EXTRA_SEARCH_MAPPINGS = 1617 1618#--------------------------------------------------------------------------- 1619# Configuration options related to the LaTeX output 1620#--------------------------------------------------------------------------- 1621 1622# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1623# The default value is: YES. 1624 1625GENERATE_LATEX = NO 1626 1627# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1628# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1629# it. 1630# The default directory is: latex. 1631# This tag requires that the tag GENERATE_LATEX is set to YES. 1632 1633LATEX_OUTPUT = latex 1634 1635# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1636# invoked. 1637# 1638# Note that when enabling USE_PDFLATEX this option is only used for generating 1639# bitmaps for formulas in the HTML output, but not in the Makefile that is 1640# written to the output directory. 1641# The default file is: latex. 1642# This tag requires that the tag GENERATE_LATEX is set to YES. 1643 1644LATEX_CMD_NAME = latex 1645 1646# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1647# index for LaTeX. 1648# The default file is: makeindex. 1649# This tag requires that the tag GENERATE_LATEX is set to YES. 1650 1651MAKEINDEX_CMD_NAME = makeindex 1652 1653# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1654# documents. This may be useful for small projects and may help to save some 1655# trees in general. 1656# The default value is: NO. 1657# This tag requires that the tag GENERATE_LATEX is set to YES. 1658 1659COMPACT_LATEX = NO 1660 1661# The PAPER_TYPE tag can be used to set the paper type that is used by the 1662# printer. 1663# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1664# 14 inches) and executive (7.25 x 10.5 inches). 1665# The default value is: a4. 1666# This tag requires that the tag GENERATE_LATEX is set to YES. 1667 1668PAPER_TYPE = a4 1669 1670# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1671# that should be included in the LaTeX output. The package can be specified just 1672# by its name or with the correct syntax as to be used with the LaTeX 1673# \usepackage command. To get the times font for instance you can specify : 1674# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1675# To use the option intlimits with the amsmath package you can specify: 1676# EXTRA_PACKAGES=[intlimits]{amsmath} 1677# If left blank no extra packages will be included. 1678# This tag requires that the tag GENERATE_LATEX is set to YES. 1679 1680EXTRA_PACKAGES = 1681 1682# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1683# generated LaTeX document. The header should contain everything until the first 1684# chapter. If it is left blank doxygen will generate a standard header. See 1685# section "Doxygen usage" for information on how to let doxygen write the 1686# default header to a separate file. 1687# 1688# Note: Only use a user-defined header if you know what you are doing! The 1689# following commands have a special meaning inside the header:$title,
1690# $datetime,$date, $doxygenversion,$projectname, $projectnumber, 1691#$projectbrief, $projectlogo. Doxygen will replace$title with the empty
1692# string, for the replacement values of the other commands the user is referred
1694# This tag requires that the tag GENERATE_LATEX is set to YES.
1695
1697
1698# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1699# generated LaTeX document. The footer should contain everything after the last
1700# chapter. If it is left blank doxygen will generate a standard footer. See
1702# special commands can be used inside the footer.
1703#
1704# Note: Only use a user-defined footer if you know what you are doing!
1705# This tag requires that the tag GENERATE_LATEX is set to YES.
1706
1707LATEX_FOOTER           =
1708
1709# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1710# LaTeX style sheets that are included after the standard style sheets created
1711# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1712# will copy the style sheet files to the output directory.
1713# Note: The order of the extra style sheet files is of importance (e.g. the last
1714# style sheet in the list overrules the setting of the previous ones in the
1715# list).
1716# This tag requires that the tag GENERATE_LATEX is set to YES.
1717
1718LATEX_EXTRA_STYLESHEET =
1719
1720# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1721# other source files which should be copied to the LATEX_OUTPUT output
1722# directory. Note that the files will be copied as-is; there are no commands or
1723# markers available.
1724# This tag requires that the tag GENERATE_LATEX is set to YES.
1725
1726LATEX_EXTRA_FILES      =
1727
1728# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1729# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1730# contain links (just like the HTML output) instead of page references. This
1731# makes the output suitable for online browsing using a PDF viewer.
1732# The default value is: YES.
1733# This tag requires that the tag GENERATE_LATEX is set to YES.
1734
1736
1737# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1738# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1739# higher quality PDF documentation.
1740# The default value is: YES.
1741# This tag requires that the tag GENERATE_LATEX is set to YES.
1742
1743USE_PDFLATEX           = YES
1744
1745# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1746# command to the generated LaTeX files. This will instruct LaTeX to keep running
1747# if errors occur, instead of asking the user for help. This option is also used
1748# when generating formulas in HTML.
1749# The default value is: NO.
1750# This tag requires that the tag GENERATE_LATEX is set to YES.
1751
1752LATEX_BATCHMODE        = NO
1753
1754# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1755# index chapters (such as File Index, Compound Index, etc.) in the output.
1756# The default value is: NO.
1757# This tag requires that the tag GENERATE_LATEX is set to YES.
1758
1759LATEX_HIDE_INDICES     = NO
1760
1761# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1762# code with syntax highlighting in the LaTeX output.
1763#
1764# Note that which sources are shown also depends on other settings such as
1765# SOURCE_BROWSER.
1766# The default value is: NO.
1767# This tag requires that the tag GENERATE_LATEX is set to YES.
1768
1769LATEX_SOURCE_CODE      = NO
1770
1771# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1772# bibliography, e.g. plainnat, or ieeetr. See
1774# The default value is: plain.
1775# This tag requires that the tag GENERATE_LATEX is set to YES.
1776
1777LATEX_BIB_STYLE        = plain
1778
1779# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1780# page will contain the date and time when the page was generated. Setting this
1781# to NO can help when comparing the output of multiple runs.
1782# The default value is: NO.
1783# This tag requires that the tag GENERATE_LATEX is set to YES.
1784
1785LATEX_TIMESTAMP        = NO
1786
1787#---------------------------------------------------------------------------
1788# Configuration options related to the RTF output
1789#---------------------------------------------------------------------------
1790
1791# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1792# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1794# The default value is: NO.
1795
1796GENERATE_RTF           = NO
1797
1798# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1799# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1800# it.
1801# The default directory is: rtf.
1802# This tag requires that the tag GENERATE_RTF is set to YES.
1803
1804RTF_OUTPUT             = rtf
1805
1806# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1807# documents. This may be useful for small projects and may help to save some
1808# trees in general.
1809# The default value is: NO.
1810# This tag requires that the tag GENERATE_RTF is set to YES.
1811
1812COMPACT_RTF            = NO
1813
1814# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1815# contain hyperlink fields. The RTF file will contain links (just like the HTML
1816# output) instead of page references. This makes the output suitable for online
1817# browsing using Word or some other Word compatible readers that support those
1818# fields.
1819#
1821# The default value is: NO.
1822# This tag requires that the tag GENERATE_RTF is set to YES.
1823
1825
1826# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1827# file, i.e. a series of assignments. You only have to provide replacements,
1828# missing definitions are set to their default value.
1829#
1830# See also section "Doxygen usage" for information on how to generate the
1831# default style sheet that doxygen normally uses.
1832# This tag requires that the tag GENERATE_RTF is set to YES.
1833
1834RTF_STYLESHEET_FILE    =
1835
1836# Set optional variables used in the generation of an RTF document. Syntax is
1837# similar to doxygen's config file. A template extensions file can be generated
1838# using doxygen -e rtf extensionFile.
1839# This tag requires that the tag GENERATE_RTF is set to YES.
1840
1841RTF_EXTENSIONS_FILE    =
1842
1843# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1844# with syntax highlighting in the RTF output.
1845#
1846# Note that which sources are shown also depends on other settings such as
1847# SOURCE_BROWSER.
1848# The default value is: NO.
1849# This tag requires that the tag GENERATE_RTF is set to YES.
1850
1851RTF_SOURCE_CODE        = NO
1852
1853#---------------------------------------------------------------------------
1854# Configuration options related to the man page output
1855#---------------------------------------------------------------------------
1856
1857# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1858# classes and files.
1859# The default value is: NO.
1860
1861GENERATE_MAN           = NO
1862
1863# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1864# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1865# it. A directory man3 will be created inside the directory specified by
1866# MAN_OUTPUT.
1867# The default directory is: man.
1868# This tag requires that the tag GENERATE_MAN is set to YES.
1869
1870MAN_OUTPUT             = man
1871
1872# The MAN_EXTENSION tag determines the extension that is added to the generated
1873# man pages. In case the manual section does not start with a number, the number
1874# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1875# optional.
1876# The default value is: .3.
1877# This tag requires that the tag GENERATE_MAN is set to YES.
1878
1879MAN_EXTENSION          = .3
1880
1881# The MAN_SUBDIR tag determines the name of the directory created within
1882# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1883# MAN_EXTENSION with the initial . removed.
1884# This tag requires that the tag GENERATE_MAN is set to YES.
1885
1886MAN_SUBDIR             =
1887
1888# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1889# will generate one additional man file for each entity documented in the real
1890# man page(s). These additional files only source the real man page, but without
1891# them the man command would be unable to find the correct page.
1892# The default value is: NO.
1893# This tag requires that the tag GENERATE_MAN is set to YES.
1894
1896
1897#---------------------------------------------------------------------------
1898# Configuration options related to the XML output
1899#---------------------------------------------------------------------------
1900
1901# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1902# captures the structure of the code including all documentation.
1903# The default value is: NO.
1904
1905GENERATE_XML           = NO
1906
1907# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1908# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1909# it.
1910# The default directory is: xml.
1911# This tag requires that the tag GENERATE_XML is set to YES.
1912
1913XML_OUTPUT             = xml
1914
1915# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1916# listings (including syntax highlighting and cross-referencing information) to
1917# the XML output. Note that enabling this will significantly increase the size
1918# of the XML output.
1919# The default value is: YES.
1920# This tag requires that the tag GENERATE_XML is set to YES.
1921
1922XML_PROGRAMLISTING     = YES
1923
1924#---------------------------------------------------------------------------
1925# Configuration options related to the DOCBOOK output
1926#---------------------------------------------------------------------------
1927
1928# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1929# that can be used to generate PDF.
1930# The default value is: NO.
1931
1932GENERATE_DOCBOOK       = NO
1933
1934# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1935# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1936# front of it.
1937# The default directory is: docbook.
1938# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1939
1940DOCBOOK_OUTPUT         = docbook
1941
1942# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1943# program listings (including syntax highlighting and cross-referencing
1944# information) to the DOCBOOK output. Note that enabling this will significantly
1945# increase the size of the DOCBOOK output.
1946# The default value is: NO.
1947# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1948
1949DOCBOOK_PROGRAMLISTING = NO
1950
1951#---------------------------------------------------------------------------
1952# Configuration options for the AutoGen Definitions output
1953#---------------------------------------------------------------------------
1954
1955# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1956# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1957# structure of the code including all documentation. Note that this feature is
1958# still experimental and incomplete at the moment.
1959# The default value is: NO.
1960
1961GENERATE_AUTOGEN_DEF   = NO
1962
1963#---------------------------------------------------------------------------
1964# Configuration options related to the Perl module output
1965#---------------------------------------------------------------------------
1966
1967# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1968# file that captures the structure of the code including all documentation.
1969#
1970# Note that this feature is still experimental and incomplete at the moment.
1971# The default value is: NO.
1972
1973GENERATE_PERLMOD       = NO
1974
1975# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1976# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1977# output from the Perl module output.
1978# The default value is: NO.
1979# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1980
1981PERLMOD_LATEX          = NO
1982
1983# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1984# formatted so it can be parsed by a human reader. This is useful if you want to
1985# understand what is going on. On the other hand, if this tag is set to NO, the
1986# size of the Perl module output will be much smaller and Perl will parse it
1987# just the same.
1988# The default value is: YES.
1989# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1990
1991PERLMOD_PRETTY         = YES
1992
1993# The names of the make variables in the generated doxyrules.make file are
1994# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1995# so different doxyrules.make files included by the same Makefile don't
1996# overwrite each other's variables.
1997# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1998
1999PERLMOD_MAKEVAR_PREFIX =
2000
2001#---------------------------------------------------------------------------
2002# Configuration options related to the preprocessor
2003#---------------------------------------------------------------------------
2004
2005# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2006# C-preprocessor directives found in the sources and include files.
2007# The default value is: YES.
2008
2009ENABLE_PREPROCESSING   = YES
2010
2011# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2012# in the source code. If set to NO, only conditional compilation will be
2013# performed. Macro expansion can be done in a controlled way by setting
2014# EXPAND_ONLY_PREDEF to YES.
2015# The default value is: NO.
2016# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2017
2018MACRO_EXPANSION        = YES
2019
2020# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2021# the macro expansion is limited to the macros specified with the PREDEFINED and
2022# EXPAND_AS_DEFINED tags.
2023# The default value is: NO.
2024# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2025
2026EXPAND_ONLY_PREDEF     = YES
2027
2028# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2029# INCLUDE_PATH will be searched if a #include is found.
2030# The default value is: YES.
2031# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2032
2033SEARCH_INCLUDES        = YES
2034
2035# The INCLUDE_PATH tag can be used to specify one or more directories that
2036# contain include files that are not input files but should be processed by the
2037# preprocessor.
2038# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2039
2040INCLUDE_PATH           = $(INCLUDE_PATH) 2041 2042# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2043# patterns (like *.h and *.hpp) to filter out the header-files in the 2044# directories. If left blank, the patterns specified with FILE_PATTERNS will be 2045# used. 2046# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2047 2048INCLUDE_FILE_PATTERNS = *.h *.def 2049 2050# The PREDEFINED tag can be used to specify one or more macro names that are 2051# defined before the preprocessor is started (similar to the -D option of e.g. 2052# gcc). The argument of the tag is a list of macros of the form: name or 2053# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2054# is assumed. To prevent a macro definition from being undefined via #undef or 2055# recursively expanded use the := operator instead of the = operator. 2056# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2057 2058PREDEFINED = \ 2059 _DOXYGEN _DPDK CLIB_DEBUG CLIB_UNIX __attribute__(x)= \ 2060 __x86_64__ __X86_64__ __linux__ __LINUX__ __64BIT__ __64bit__ \ 2061 __ORDER_LITTLE_ENDIAN__=1234 \ 2062 __BYTE_ORDER__=1234 \ 2063 __FLOAT_WORD_ORDER__=1234 \ 2064 DPDK=1 \ 2065 always_inline:="static inline" 2066 2067# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2068# tag can be used to specify a list of macro names that should be expanded. The 2069# macro definition that is found in the sources will be used. Use the PREDEFINED 2070# tag if you want to use a different macro definition that overrules the 2071# definition found in the source code. 2072# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2073 2074EXPAND_AS_DEFINED = 2075 2076# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2077# remove all references to function-like macros that are alone on a line, have 2078# an all uppercase name, and do not end with a semicolon. Such function macros 2079# are typically used for boiler-plate code, and will confuse the parser if not 2080# removed. 2081# The default value is: YES. 2082# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2083 2084SKIP_FUNCTION_MACROS = YES 2085 2086#--------------------------------------------------------------------------- 2087# Configuration options related to external references 2088#--------------------------------------------------------------------------- 2089 2090# The TAGFILES tag can be used to specify one or more tag files. For each tag 2091# file the location of the external documentation should be added. The format of 2092# a tag file without this location is as follows: 2093# TAGFILES = file1 file2 ... 2094# Adding location for the tag files is done as follows: 2095# TAGFILES = file1=loc1 "file2 = loc2" ... 2096# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2097# section "Linking to external documentation" for more information about the use 2098# of tag files. 2099# Note: Each tag file must have a unique name (where the name does NOT include 2100# the path). If a tag file is not located in the directory in which doxygen is 2101# run, you must also specify the path to the tagfile here. 2102 2103TAGFILES = 2104 2105# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2106# tag file that is based on the input files it reads. See section "Linking to 2107# external documentation" for more information about the usage of tag files. 2108 2109GENERATE_TAGFILE =$(BUILD_ROOT)/docs/vpp.doxytags
2110
2111# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2112# the class index. If set to NO, only the inherited external classes will be
2113# listed.
2114# The default value is: NO.
2115
2116ALLEXTERNALS           = NO
2117
2118# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2119# in the modules index. If set to NO, only the current project's groups will be
2120# listed.
2121# The default value is: YES.
2122
2123EXTERNAL_GROUPS        = YES
2124
2125# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2126# the related pages index. If set to NO, only the current project's pages will
2127# be listed.
2128# The default value is: YES.
2129
2130EXTERNAL_PAGES         = YES
2131
2132# The PERL_PATH should be the absolute path and name of the perl script
2133# interpreter (i.e. the result of 'which perl').
2134# The default file (with absolute path) is: /usr/bin/perl.
2135
2136PERL_PATH              = /usr/bin/perl
2137
2138#---------------------------------------------------------------------------
2139# Configuration options related to the dot tool
2140#---------------------------------------------------------------------------
2141
2142# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2143# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2144# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2145# disabled, but it is recommended to install and use dot, since it yields more
2146# powerful graphs.
2147# The default value is: YES.
2148
2149CLASS_DIAGRAMS         = YES
2150
2151# You can define message sequence charts within doxygen comments using the \msc
2152# command. Doxygen will then run the mscgen tool (see:
2153# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2154# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2155# the mscgen tool resides. If left empty the tool is assumed to be found in the
2156# default search path.
2157
2158MSCGEN_PATH            =
2159
2160# You can include diagrams made with dia in doxygen documentation. Doxygen will
2161# then run dia to produce the diagram and insert it in the documentation. The
2162# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2163# If left empty dia is assumed to be found in the default search path.
2164
2165DIA_PATH               =
2166
2167# If set to YES the inheritance and collaboration graphs will hide inheritance
2168# and usage relations if the target is undocumented or is not a class.
2169# The default value is: YES.
2170
2171HIDE_UNDOC_RELATIONS   = YES
2172
2173# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2174# available from the path. This tool is part of Graphviz (see:
2175# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2176# Bell Labs. The other options in this section have no effect if this option is
2177# set to NO
2178# The default value is: YES.
2179
2180HAVE_DOT               = YES
2181
2182# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2183# to run in parallel. When set to 0 doxygen will base this on the number of
2184# processors available in the system. You can set it explicitly to a value
2185# larger than 0 to get control over the balance between CPU load and processing
2186# speed.
2187# Minimum value: 0, maximum value: 32, default value: 0.
2188# This tag requires that the tag HAVE_DOT is set to YES.
2189
2191
2192# When you want a differently looking font in the dot files that doxygen
2193# generates you can specify the font name using DOT_FONTNAME. You need to make
2194# sure dot is able to find the font, which can be done by putting it in a
2195# standard location or by setting the DOTFONTPATH environment variable or by
2196# setting DOT_FONTPATH to the directory containing the font.
2197# The default value is: Helvetica.
2198# This tag requires that the tag HAVE_DOT is set to YES.
2199
2200DOT_FONTNAME           = Helvetica
2201
2202# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2203# dot graphs.
2204# Minimum value: 4, maximum value: 24, default value: 10.
2205# This tag requires that the tag HAVE_DOT is set to YES.
2206
2207DOT_FONTSIZE           = 10
2208
2209# By default doxygen will tell dot to use the default font as specified with
2210# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2211# the path where dot can find it using this tag.
2212# This tag requires that the tag HAVE_DOT is set to YES.
2213
2214DOT_FONTPATH           =
2215
2216# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2217# each documented class showing the direct and indirect inheritance relations.
2218# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2219# The default value is: YES.
2220# This tag requires that the tag HAVE_DOT is set to YES.
2221
2222CLASS_GRAPH            = YES
2223
2224# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2225# graph for each documented class showing the direct and indirect implementation
2226# dependencies (inheritance, containment, and class references variables) of the
2227# class with other documented classes.
2228# The default value is: YES.
2229# This tag requires that the tag HAVE_DOT is set to YES.
2230
2231COLLABORATION_GRAPH    = YES
2232
2233# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2234# groups, showing the direct groups dependencies.
2235# The default value is: YES.
2236# This tag requires that the tag HAVE_DOT is set to YES.
2237
2238GROUP_GRAPHS           = YES
2239
2240# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2241# collaboration diagrams in a style similar to the OMG's Unified Modeling
2242# Language.
2243# The default value is: NO.
2244# This tag requires that the tag HAVE_DOT is set to YES.
2245
2246UML_LOOK               = NO
2247
2248# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2249# class node. If there are many fields or methods and many nodes the graph may
2250# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2251# number of items for each type to make the size more manageable. Set this to 0
2252# for no limit. Note that the threshold may be exceeded by 50% before the limit
2253# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2254# but if the number exceeds 15, the total amount of fields shown is limited to
2255# 10.
2256# Minimum value: 0, maximum value: 100, default value: 10.
2257# This tag requires that the tag HAVE_DOT is set to YES.
2258
2259UML_LIMIT_NUM_FIELDS   = 10
2260
2261# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2262# collaboration graphs will show the relations between templates and their
2263# instances.
2264# The default value is: NO.
2265# This tag requires that the tag HAVE_DOT is set to YES.
2266
2267TEMPLATE_RELATIONS     = NO
2268
2269# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2270# YES then doxygen will generate a graph for each documented file showing the
2271# direct and indirect include dependencies of the file with other documented
2272# files.
2273# The default value is: YES.
2274# This tag requires that the tag HAVE_DOT is set to YES.
2275
2276INCLUDE_GRAPH          = YES
2277
2278# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2279# set to YES then doxygen will generate a graph for each documented file showing
2280# the direct and indirect include dependencies of the file with other documented
2281# files.
2282# The default value is: YES.
2283# This tag requires that the tag HAVE_DOT is set to YES.
2284
2285INCLUDED_BY_GRAPH      = YES
2286
2287# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2288# dependency graph for every global function or class method.
2289#
2290# Note that enabling this option will significantly increase the time of a run.
2291# So in most cases it will be better to enable call graphs for selected
2292# functions only using the \callgraph command. Disabling a call graph can be
2293# accomplished by means of the command \hidecallgraph.
2294# The default value is: NO.
2295# This tag requires that the tag HAVE_DOT is set to YES.
2296
2297CALL_GRAPH             = YES
2298
2299# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2300# dependency graph for every global function or class method.
2301#
2302# Note that enabling this option will significantly increase the time of a run.
2303# So in most cases it will be better to enable caller graphs for selected
2304# functions only using the \callergraph command. Disabling a caller graph can be
2305# accomplished by means of the command \hidecallergraph.
2306# The default value is: NO.
2307# This tag requires that the tag HAVE_DOT is set to YES.
2308
2309CALLER_GRAPH           = YES
2310
2311# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2312# hierarchy of all classes instead of a textual one.
2313# The default value is: YES.
2314# This tag requires that the tag HAVE_DOT is set to YES.
2315
2316GRAPHICAL_HIERARCHY    = YES
2317
2318# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2319# dependencies a directory has on other directories in a graphical way. The
2320# dependency relations are determined by the #include relations between the
2321# files in the directories.
2322# The default value is: YES.
2323# This tag requires that the tag HAVE_DOT is set to YES.
2324
2325DIRECTORY_GRAPH        = YES
2326
2327# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2328# generated by dot. For an explanation of the image formats see the section
2329# output formats in the documentation of the dot tool (Graphviz (see:
2330# http://www.graphviz.org/)).
2331# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2332# to make the SVG files visible in IE 9+ (other browsers do not have this
2333# requirement).
2334# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2335# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2336# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2337# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2338# png:gdiplus:gdiplus.
2339# The default value is: png.
2340# This tag requires that the tag HAVE_DOT is set to YES.
2341
2342DOT_IMAGE_FORMAT       = svg
2343
2344# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2345# enable generation of interactive SVG images that allow zooming and panning.
2346#
2347# Note that this requires a modern browser other than Internet Explorer. Tested
2348# and working are Firefox, Chrome, Safari, and Opera.
2349# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2350# the SVG files visible. Older versions of IE do not have SVG support.
2351# The default value is: NO.
2352# This tag requires that the tag HAVE_DOT is set to YES.
2353
2354INTERACTIVE_SVG        = YES
2355
2356# The DOT_PATH tag can be used to specify the path where the dot tool can be
2357# found. If left blank, it is assumed the dot tool can be found in the path.
2358# This tag requires that the tag HAVE_DOT is set to YES.
2359
2360DOT_PATH               =
2361
2362# The DOTFILE_DIRS tag can be used to specify one or more directories that
2363# contain dot files that are included in the documentation (see the \dotfile
2364# command).
2365# This tag requires that the tag HAVE_DOT is set to YES.
2366
2367DOTFILE_DIRS           =
2368
2369# The MSCFILE_DIRS tag can be used to specify one or more directories that
2370# contain msc files that are included in the documentation (see the \mscfile
2371# command).
2372
2373MSCFILE_DIRS           =
2374
2375# The DIAFILE_DIRS tag can be used to specify one or more directories that
2376# contain dia files that are included in the documentation (see the \diafile
2377# command).
2378
2379DIAFILE_DIRS           =
2380
2381# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2382# path where java can find the plantuml.jar file. If left blank, it is assumed
2383# PlantUML is not used or called during a preprocessing step. Doxygen will
2384# generate a warning when it encounters a \startuml command in this case and
2385# will not generate output for the diagram.
2386
2387PLANTUML_JAR_PATH      =
2388
2389# When using plantuml, the specified paths are searched for files specified by
2390# the !include statement in a plantuml block.
2391
2392PLANTUML_INCLUDE_PATH  =
2393
2394# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2395# that will be shown in the graph. If the number of nodes in a graph becomes
2396# larger than this value, doxygen will truncate the graph, which is visualized
2397# by representing a node as a red box. Note that doxygen if the number of direct
2398# children of the root node in a graph is already larger than
2399# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2400# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2401# Minimum value: 0, maximum value: 10000, default value: 50.
2402# This tag requires that the tag HAVE_DOT is set to YES.
2403
2404DOT_GRAPH_MAX_NODES    = 50
2405
2406# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2407# generated by dot. A depth value of 3 means that only nodes reachable from the
2408# root by following a path via at most 3 edges will be shown. Nodes that lay
2409# further from the root node will be omitted. Note that setting this option to 1
2410# or 2 may greatly reduce the computation time needed for large code bases. Also
2411# note that the size of a graph can be further restricted by
2412# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2413# Minimum value: 0, maximum value: 1000, default value: 0.
2414# This tag requires that the tag HAVE_DOT is set to YES.
2415
2416MAX_DOT_GRAPH_DEPTH    = 3
2417
2418# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2419# background. This is disabled by default, because dot on Windows does not seem
2420# to support this out of the box.
2421#
2422# Warning: Depending on the platform used, enabling this option may lead to
2423# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2425# The default value is: NO.
2426# This tag requires that the tag HAVE_DOT is set to YES.
2427
2428DOT_TRANSPARENT        = NO
2429
2430# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2431# files in one run (i.e. multiple -o and -T options on the command line). This
2432# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2433# this, this feature is disabled by default.
2434# The default value is: NO.
2435# This tag requires that the tag HAVE_DOT is set to YES.
2436
2437DOT_MULTI_TARGETS      = YES
2438
2439# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2440# explaining the meaning of the various boxes and arrows in the dot generated
2441# graphs.
2442# The default value is: YES.
2443# This tag requires that the tag HAVE_DOT is set to YES.
2444
2445GENERATE_LEGEND        = YES
2446
2447# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2448# files that are used to generate the various graphs.
2449# The default value is: YES.
2450# This tag requires that the tag HAVE_DOT is set to YES.
2451
2452DOT_CLEANUP            = YES
2453
2454