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