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