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