Changeset 1716

Show
Ignore:
Timestamp:
11/16/09 12:44:40 (13 years ago)
Author:
arnonym
Message:
  • Update the doxygen file to a new doxygen-version.
  • De-activate the LaTeX-output.
  • Enable output for QAssistant files.
Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/libffado/doc/reference.doxygen.in

    r605 r1716  
    1 # Doxyfile 1.3.4 
     1# Doxyfile 1.6.1 
    22 
    33# This file describes the settings to be used by the documentation system 
     
    1515#--------------------------------------------------------------------------- 
    1616 
    17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded  
     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 
    1826# by quotes) that should identify the project. 
    1927 
    2028PROJECT_NAME           = LIBFFADO 
    2129 
    22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.  
    23 # This could be handy for archiving the generated documentation or  
     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 
    2432# if some version control system is used. 
    2533 
    2634PROJECT_NUMBER         = $VERSION 
    2735 
    28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)  
    29 # base path where the generated documentation will be put.  
    30 # If a relative path is entered, it will be relative to the location  
     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 
    3139# where doxygen was started. If left blank the current directory will be used. 
    3240 
    3341OUTPUT_DIRECTORY       = reference 
     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 
    3451 
    3552# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    3653# documentation generated by doxygen is written. Doxygen will use this 
    37 # information to generate all constant output in the proper 
    38 # language. The default language is English, other supported languages 
    39 # are: Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, 
    40 # Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
    41 # Italian, Japanese, Japanese-en (Japanese with English messages), 
    42 # Korean, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, 
    43 # Slovak, Slovene, Spanish, Swedish, and Ukrainian. 
     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. 
    4462 
    4563OUTPUT_LANGUAGE        = English 
    4664 
    47 # This tag can be used to specify the encoding used in the generated output.  
    48 # The encoding is not always determined by the language that is chosen,  
    49 # but also whether or not the output is meant for Windows or non-Windows users.  
    50 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES  
    51 # forces the Windows encoding (this is the default for the Windows binary),  
    52 # whereas setting the tag to NO uses a Unix-style encoding (the default for  
    53 # all platforms other than Windows). 
    54  
    55 USE_WINDOWS_ENCODING   = NO 
    56  
    57 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will  
    58 # include brief member descriptions after the members that are listed in  
    59 # the file and class documentation (similar to JavaDoc).  
     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). 
    6068# Set to NO to disable this. 
    6169 
    6270BRIEF_MEMBER_DESC      = YES 
    6371 
    64 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend  
    65 # the brief description of a member or function before the detailed description.  
    66 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the  
     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 
    6775# brief descriptions will be completely suppressed. 
    6876 
    6977REPEAT_BRIEF           = YES 
    7078 
    71 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then  
    72 # Doxygen will generate a detailed section even if there is only a brief  
     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 
    7393# description. 
    7494 
    7595ALWAYS_DETAILED_SEC    = NO 
    7696 
    77 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited  
    78 # members of a class in the documentation of that class as if those members were  
    79 # ordinary class members. Constructors, destructors and assignment operators of  
    80 # the base classes will not be shown. 
     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. 
    81101 
    82102INLINE_INHERITED_MEMB  = YES 
    83103 
    84 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full  
    85 # path before files name in the file list and in the header files. If set  
     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 
    86106# to NO the shortest path that makes the file name unique will be used. 
    87107 
    88108FULL_PATH_NAMES        = NO 
    89109 
    90 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag  
    91 # can be used to strip a user-defined part of the path. Stripping is  
    92 # only done if one of the specified strings matches the left-hand part of  
    93 # the path. It is allowed to use relative paths in the argument list. 
    94  
    95 STRIP_FROM_PATH        =  
    96  
    97 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter  
    98 # (but less readable) file names. This can be useful is your file systems  
     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 
    99130# doesn't support long names like on DOS, Mac, or CD-ROM. 
    100131 
    101132SHORT_NAMES            = NO 
    102133 
    103 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen  
    104 # will interpret the first line (until the first dot) of a JavaDoc-style  
    105 # comment as the brief description. If set to NO, the JavaDoc  
    106 # comments will behave just like the Qt-style comments (thus requiring an  
    107 # explict @brief command for a brief description. 
     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.) 
    108139 
    109140JAVADOC_AUTOBRIEF      = NO 
    110141 
    111 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen  
    112 # treat a multi-line C++ special comment block (i.e. a block of //! or ///  
    113 # comments) as a brief description. This used to be the default behaviour.  
    114 # The new default is to treat a multi-line C++ comment block as a detailed  
     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 
    115154# description. Set this tag to YES if you prefer the old behaviour instead. 
    116155 
    117156MULTILINE_CPP_IS_BRIEF = NO 
    118157 
    119 # If the DETAILS_AT_TOP tag is set to YES then Doxygen  
    120 # will output the detailed description near the top, like JavaDoc. 
    121 # If set to NO, the detailed description appears after the member  
     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               = 4 
     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   = YES 
     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 penality. 
     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 rougly 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            = YES 
     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        = YES 
     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         = YES 
     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 
    122351# documentation. 
    123352 
    124 DETAILS_AT_TOP         = NO 
    125  
    126 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented  
    127 # member inherits the documentation from any documented member that it  
    128 # reimplements. 
    129  
    130 INHERIT_DOCS           = YES 
    131  
    132 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC  
    133 # tag is set to YES, then doxygen will reuse the documentation of the first  
    134 # member in the group (if any) for the other members of the group. By default  
    135 # all members of a group must be documented explicitly. 
    136  
    137 DISTRIBUTE_GROUP_DOC   = NO 
    138  
    139 # The TAB_SIZE tag can be used to set the number of spaces in a tab.  
    140 # Doxygen uses this value to replace tabs by spaces in code fragments. 
    141  
    142 TAB_SIZE               = 4 
    143  
    144 # This tag can be used to specify a number of aliases that acts  
    145 # as commands in the documentation. An alias has the form "name=value".  
    146 # For example adding "sideeffect=\par Side Effects:\n" will allow you to  
    147 # put the command \sideeffect (or @sideeffect) in the documentation, which  
    148 # will result in a user-defined paragraph with heading "Side Effects:".  
    149 # You can put \n's in the value part of an alias to insert newlines. 
    150  
    151 ALIASES                =  
    152  
    153 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources  
    154 # only. Doxygen will then generate output that is more tailored for C.  
    155 # For instance, some of the names that are used will be different. The list  
    156 # of all members will be omitted, etc. 
    157  
    158 OPTIMIZE_OUTPUT_FOR_C  = YES 
    159  
    160 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources  
    161 # only. Doxygen will then generate output that is more tailored for Java.  
    162 # For instance, namespaces will be presented as packages, qualified scopes  
    163 # will look different, etc. 
    164  
    165 OPTIMIZE_OUTPUT_JAVA   = NO 
    166  
    167 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of  
    168 # the same type (for instance a group of public functions) to be put as a  
    169 # subgroup of that type (e.g. under the Public Functions section). Set it to  
    170 # NO to prevent subgrouping. Alternatively, this can be done per class using  
    171 # the \nosubgrouping command. 
    172  
    173 SUBGROUPING            = YES 
    174  
    175 #--------------------------------------------------------------------------- 
    176 # Build related configuration options 
    177 #--------------------------------------------------------------------------- 
    178  
    179 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in  
    180 # documentation are documented, even if no documentation was available.  
    181 # Private class members and static file members will be hidden unless  
    182 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 
    183  
    184 EXTRACT_ALL            = YES 
    185  
    186 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class  
    187 # will be included in the documentation. 
    188  
    189 EXTRACT_PRIVATE        = NO 
    190  
    191 # If the EXTRACT_STATIC tag is set to YES all static members of a file  
    192 # will be included in the documentation. 
    193  
    194 EXTRACT_STATIC         = NO 
    195  
    196 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)  
    197 # defined locally in source files will be included in the documentation.  
    198 # If set to NO only classes defined in header files are included. 
    199  
    200 EXTRACT_LOCAL_CLASSES  = YES 
    201  
    202 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  
    203 # undocumented members of documented classes, files or namespaces.  
    204 # If set to NO (the default) these members will be included in the  
    205 # various overviews, but no documentation section is generated.  
    206 # This option has no effect if EXTRACT_ALL is enabled. 
    207  
    208 HIDE_UNDOC_MEMBERS     = NO 
    209  
    210 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all  
    211 # undocumented classes that are normally visible in the class hierarchy.  
    212 # If set to NO (the default) these classes will be included in the various  
    213 # overviews. This option has no effect if EXTRACT_ALL is enabled. 
    214  
    215 HIDE_UNDOC_CLASSES     = NO 
    216  
    217 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all  
    218 # friend (class|struct|union) declarations.  
    219 # If set to NO (the default) these declarations will be included in the  
     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          = YES 
     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       = NO 
     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                  = YES 
     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 
    220543# documentation. 
    221544 
    222 HIDE_FRIEND_COMPOUNDS  = NO 
    223  
    224 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any  
    225 # documentation blocks found inside the body of a function.  
    226 # If set to NO (the default) these blocks will be appended to the  
    227 # function's detailed documentation block. 
    228  
    229 HIDE_IN_BODY_DOCS      = NO 
    230  
    231 # The INTERNAL_DOCS tag determines if documentation  
    232 # that is typed after a \internal command is included. If the tag is set  
    233 # to NO (the default) then the documentation will be excluded.  
    234 # Set it to YES to include the internal documentation. 
    235  
    236 INTERNAL_DOCS          = NO 
    237  
    238 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate  
    239 # file names in lower-case letters. If set to YES upper-case letters are also  
    240 # allowed. This is useful if you have classes or files whose names only differ  
    241 # in case and if your file system supports case sensitive file names. Windows  
    242 # users are advised to set this option to NO. 
    243  
    244 CASE_SENSE_NAMES       = YES 
    245  
    246 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen  
    247 # will show members with their full class and namespace scopes in the  
    248 # documentation. If set to YES the scope will be hidden. 
    249  
    250 HIDE_SCOPE_NAMES       = NO 
    251  
    252 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen  
    253 # will put a list of the files that are included by a file in the documentation  
    254 # of that file. 
    255  
    256 SHOW_INCLUDE_FILES     = YES 
    257  
    258 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]  
    259 # is inserted in the documentation for inline members. 
    260  
    261 INLINE_INFO            = YES 
    262  
    263 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen  
    264 # will sort the (detailed) documentation of file and class members  
    265 # alphabetically by member name. If set to NO the members will appear in  
    266 # declaration order. 
    267  
    268 SORT_MEMBER_DOCS       = YES 
    269  
    270 # The GENERATE_TODOLIST tag can be used to enable (YES) or  
    271 # disable (NO) the todo list. This list is created by putting \todo  
    272 # commands in the documentation. 
    273  
    274 GENERATE_TODOLIST      = YES 
    275  
    276 # The GENERATE_TESTLIST tag can be used to enable (YES) or  
    277 # disable (NO) the test list. This list is created by putting \test  
    278 # commands in the documentation. 
    279  
    280 GENERATE_TESTLIST      = YES 
    281  
    282 # The GENERATE_BUGLIST tag can be used to enable (YES) or  
    283 # disable (NO) the bug list. This list is created by putting \bug  
    284 # commands in the documentation. 
    285  
    286 GENERATE_BUGLIST       = YES 
    287  
    288 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or  
    289 # disable (NO) the deprecated list. This list is created by putting  
    290 # \deprecated commands in the documentation. 
    291  
    292 GENERATE_DEPRECATEDLIST= YES 
    293  
    294 # The ENABLED_SECTIONS tag can be used to enable conditional  
    295 # documentation sections, marked by \if sectionname ... \endif. 
    296  
    297 ENABLED_SECTIONS       =  
    298  
    299 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines  
    300 # the initial value of a variable or define consists of for it to appear in  
    301 # the documentation. If the initializer consists of more lines than specified  
    302 # here it will be hidden. Use a value of 0 to hide initializers completely.  
    303 # The appearance of the initializer of individual variables and defines in the  
    304 # documentation can be controlled using \showinitializer or \hideinitializer  
    305 # command in the documentation regardless of this setting. 
    306  
    307 MAX_INITIALIZER_LINES  = 30 
    308  
    309 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated  
    310 # at the bottom of the documentation of classes and structs. If set to YES the  
    311 # list will mention the files that were used to generate the documentation. 
    312  
    313 SHOW_USED_FILES        = YES 
    314  
    315 #--------------------------------------------------------------------------- 
    316 # configuration options related to warning and progress messages 
    317 #--------------------------------------------------------------------------- 
    318  
    319 # The QUIET tag can be used to turn on/off the messages that are generated  
    320 # by doxygen. Possible values are YES and NO. If left blank NO is used. 
    321  
    322 QUIET                  = NO 
    323  
    324 # The WARNINGS tag can be used to turn on/off the warning messages that are  
    325 # generated by doxygen. Possible values are YES and NO. If left blank  
    326 # NO is used. 
    327  
    328 WARNINGS               = YES 
    329  
    330 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings  
    331 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will  
    332 # automatically be disabled. 
    333  
    334 WARN_IF_UNDOCUMENTED   = YES 
    335  
    336 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for  
    337 # potential errors in the documentation, such as not documenting some  
    338 # parameters in a documented function, or documenting parameters that  
    339 # don't exist or using markup commands wrongly. 
    340  
    341 WARN_IF_DOC_ERROR      = YES 
    342  
    343 # The WARN_FORMAT tag determines the format of the warning messages that  
    344 # doxygen can produce. The string should contain the $file, $line, and $text  
    345 # tags, which will be replaced by the file and line number from which the  
    346 # warning originated and the warning text. 
     545WARN_NO_PARAMDOC       = NO 
     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) 
    347553 
    348554WARN_FORMAT            = "$file:$line: $text" 
    349555 
    350 # The WARN_LOGFILE tag can be used to specify a file to which warning  
    351 # and error messages should be written. If left blank the output is written  
     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 
    352558# to stderr. 
    353559 
    354 WARN_LOGFILE           =  
     560WARN_LOGFILE           = 
    355561 
    356562#--------------------------------------------------------------------------- 
     
    358564#--------------------------------------------------------------------------- 
    359565 
    360 # The INPUT tag can be used to specify the files and/or directories that contain  
    361 # documented source files. You may enter file names like "myfile.cpp" or  
    362 # directories like "/usr/src/myproject". Separate the files or directories  
     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 
    363569# with spaces. 
    364570 
     
    367573                         $top_srcdir/libffado 
    368574 
    369  
    370 # If the value of the INPUT tag contains directories, you can use the  
    371 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  
    372 # and *.h) to filter out the source-files in the directories. If left  
    373 # blank the following patterns are tested:  
    374 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp  
    375 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc 
    376  
    377 FILE_PATTERNS          = *.cpp *.h *.dox 
    378  
    379 # The RECURSIVE tag can be used to turn specify whether or not subdirectories  
    380 # should be searched for input files as well. Possible values are YES and NO.  
     575# This tag can be used to specify the character encoding of the source files 
     576# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
     577# also the default input encoding. Doxygen uses libiconv (or the iconv built 
     578# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
     579# the list of possible encodings. 
     580 
     581INPUT_ENCODING         = UTF-8 
     582 
     583# If the value of the INPUT tag contains directories, you can use the 
     584# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
     585# and *.h) to filter out the source-files in the directories. If left 
     586# blank the following patterns are tested: 
     587# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
     588# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 
     589 
     590FILE_PATTERNS          = *.cpp \ 
     591                         *.h \ 
     592                         *.dox 
     593 
     594# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
     595# should be searched for input files as well. Possible values are YES and NO. 
    381596# If left blank NO is used. 
    382597 
    383598RECURSIVE              = YES 
    384599 
    385 # The EXCLUDE tag can be used to specify files and/or directories that should  
    386 # excluded from the INPUT source files. This way you can easily exclude a  
     600# The EXCLUDE tag can be used to specify files and/or directories that should 
     601# excluded from the INPUT source files. This way you can easily exclude a 
    387602# subdirectory from a directory tree whose root is specified with the INPUT tag. 
    388603 
    389 EXCLUDE                =  
     604EXCLUDE                = 
    390605 
    391606# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
    392 # directories that are symbolic links (a Unix filesystem feature) are 
    393 # excluded from the input. 
     607# directories that are symbolic links (a Unix filesystem feature) are excluded 
     608# from the input. 
    394609 
    395610EXCLUDE_SYMLINKS       = NO 
    396611 
    397 # If the value of the INPUT tag contains directories, you can use the  
    398 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude  
    399 # certain files from those directories. 
    400  
    401 EXCLUDE_PATTERNS       = *.svn* *reference* 
    402  
    403 # The EXAMPLE_PATH tag can be used to specify one or more files or  
    404 # directories that contain example code fragments that are included (see  
     612# If the value of the INPUT tag contains directories, you can use the 
     613# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
     614# certain files from those directories. Note that the wildcards are matched 
     615# against the file with absolute path, so to exclude all test directories 
     616# for example use the pattern */test/* 
     617 
     618EXCLUDE_PATTERNS       = *.svn* \ 
     619                         *reference* 
     620 
     621# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
     622# (namespaces, classes, functions, etc.) that should be excluded from the 
     623# output. The symbol name can be a fully qualified name, a word, or if the 
     624# wildcard * is used, a substring. Examples: ANamespace, AClass, 
     625# AClass::ANamespace, ANamespace::*Test 
     626 
     627EXCLUDE_SYMBOLS        = 
     628 
     629# The EXAMPLE_PATH tag can be used to specify one or more files or 
     630# directories that contain example code fragments that are included (see 
    405631# the \include command). 
    406632 
    407 EXAMPLE_PATH           =  
    408  
    409 # If the value of the EXAMPLE_PATH tag contains directories, you can use the  
    410 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  
    411 # and *.h) to filter out the source-files in the directories. If left  
     633EXAMPLE_PATH           = 
     634 
     635# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
     636# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
     637# and *.h) to filter out the source-files in the directories. If left 
    412638# blank all files are included. 
    413639 
    414 EXAMPLE_PATTERNS       =  
    415  
    416 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be  
    417 # searched for input files to be used with the \include or \dontinclude  
    418 # commands irrespective of the value of the RECURSIVE tag.  
     640EXAMPLE_PATTERNS       = 
     641 
     642# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
     643# searched for input files to be used with the \include or \dontinclude 
     644# commands irrespective of the value of the RECURSIVE tag. 
    419645# Possible values are YES and NO. If left blank NO is used. 
    420646 
    421647EXAMPLE_RECURSIVE      = NO 
    422648 
    423 # The IMAGE_PATH tag can be used to specify one or more files or  
    424 # directories that contain image that are included in the documentation (see  
     649# The IMAGE_PATH tag can be used to specify one or more files or 
     650# directories that contain image that are included in the documentation (see 
    425651# the \image command). 
    426652 
    427653IMAGE_PATH             = . 
    428654 
    429 # The INPUT_FILTER tag can be used to specify a program that doxygen should  
    430 # invoke to filter for each input file. Doxygen will invoke the filter program  
    431 # by executing (via popen()) the command <filter> <input-file>, where <filter>  
    432 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an  
    433 # input file. Doxygen will then use the output that the filter program writes  
     655# The INPUT_FILTER tag can be used to specify a program that doxygen should 
     656# invoke to filter for each input file. Doxygen will invoke the filter program 
     657# by executing (via popen()) the command <filter> <input-file>, where <filter> 
     658# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
     659# input file. Doxygen will then use the output that the filter program writes 
    434660# to standard output. 
    435  
    436 INPUT_FILTER           =  
    437  
    438 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using  
    439 # INPUT_FILTER) will be used to filter the input files when producing source  
     661# If FILTER_PATTERNS is specified, this tag will be 
     662# ignored. 
     663 
     664INPUT_FILTER           = 
     665 
     666# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
     667# basis. 
     668# Doxygen will compare the file name with each pattern and apply the 
     669# filter if there is a match. 
     670# The filters are a list of the form: 
     671# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
     672# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
     673# is applied to all files. 
     674 
     675FILTER_PATTERNS        = 
     676 
     677# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
     678# INPUT_FILTER) will be used to filter the input files when producing source 
    440679# files to browse (i.e. when SOURCE_BROWSER is set to YES). 
    441680 
     
    446685#--------------------------------------------------------------------------- 
    447686 
    448 # If the SOURCE_BROWSER tag is set to YES then a list of source files will  
     687# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
    449688# be generated. Documented entities will be cross-referenced with these sources. 
     689# Note: To get rid of all source code in the generated output, make sure also 
     690# VERBATIM_HEADERS is set to NO. 
    450691 
    451692SOURCE_BROWSER         = NO 
    452693 
    453 # Setting the INLINE_SOURCES tag to YES will include the body  
     694# Setting the INLINE_SOURCES tag to YES will include the body 
    454695# of functions and classes directly in the documentation. 
    455696 
    456697INLINE_SOURCES         = NO 
    457698 
    458 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct  
    459 # doxygen to hide any special comment blocks from generated source code  
     699# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
     700# doxygen to hide any special comment blocks from generated source code 
    460701# fragments. Normal C and C++ comments will always remain visible. 
    461702 
    462703STRIP_CODE_COMMENTS    = YES 
    463704 
    464 # If the REFERENCED_BY_RELATION tag is set to YES (the default)  
    465 # then for each documented function all documented  
     705# If the REFERENCED_BY_RELATION tag is set to YES 
     706# then for each documented function all documented 
    466707# functions referencing it will be listed. 
    467708 
    468709REFERENCED_BY_RELATION = YES 
    469710 
    470 # If the REFERENCES_RELATION tag is set to YES (the default)  
    471 # then for each documented function all documented entities  
     711# If the REFERENCES_RELATION tag is set to YES 
     712# then for each documented function all documented entities 
    472713# called/used by that function will be listed. 
    473714 
    474715REFERENCES_RELATION    = YES 
    475716 
    476 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen  
    477 # will generate a verbatim copy of the header file for each class for  
     717# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
     718# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
     719# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
     720# link to the source code. 
     721# Otherwise they will link to the documentation. 
     722 
     723REFERENCES_LINK_SOURCE = YES 
     724 
     725# If the USE_HTAGS tag is set to YES then the references to source code 
     726# will point to the HTML generated by the htags(1) tool instead of doxygen 
     727# built-in source browser. The htags tool is part of GNU's global source 
     728# tagging system (see http://www.gnu.org/software/global/global.html). You 
     729# will need version 4.8.6 or higher. 
     730 
     731USE_HTAGS              = NO 
     732 
     733# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
     734# will generate a verbatim copy of the header file for each class for 
    478735# which an include is specified. Set to NO to disable this. 
    479736 
     
    484741#--------------------------------------------------------------------------- 
    485742 
    486 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index  
    487 # of all compounds will be generated. Enable this if the project  
     743# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
     744# of all compounds will be generated. Enable this if the project 
    488745# contains a lot of classes, structs, unions or interfaces. 
    489746 
    490747ALPHABETICAL_INDEX     = YES 
    491748 
    492 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then  
    493 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns  
     749# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
     750# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
    494751# in which this list will be split (can be a number in the range [1..20]) 
    495752 
    496 COLS_IN_ALPHA_INDEX    = 5 
    497  
    498 # In case all classes in a project start with a common prefix, all  
    499 # classes will be put under the same header in the alphabetical index.  
    500 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that  
     753COLS_IN_ALPHA_INDEX    = 3 
     754 
     755# In case all classes in a project start with a common prefix, all 
     756# classes will be put under the same header in the alphabetical index. 
     757# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
    501758# should be ignored while generating the index headers. 
    502759 
    503 IGNORE_PREFIX          =  
     760IGNORE_PREFIX          = 
    504761 
    505762#--------------------------------------------------------------------------- 
     
    507764#--------------------------------------------------------------------------- 
    508765 
    509 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will  
     766# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
    510767# generate HTML output. 
    511768 
    512769GENERATE_HTML          = YES 
    513770 
    514 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.  
    515 # If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     771# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
     772# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
    516773# put in front of it. If left blank `html' will be used as the default path. 
    517774 
    518775HTML_OUTPUT            = html 
    519776 
    520 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for  
    521 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank  
     777# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
     778# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
    522779# doxygen will generate files with .html extension. 
    523780 
    524781HTML_FILE_EXTENSION    = .html 
    525782 
    526 # The HTML_HEADER tag can be used to specify a personal HTML header for  
    527 # each generated HTML page. If it is left blank doxygen will generate a  
     783# The HTML_HEADER tag can be used to specify a personal HTML header for 
     784# each generated HTML page. If it is left blank doxygen will generate a 
    528785# standard header. 
    529786 
    530 HTML_HEADER            =  
    531  
    532 # The HTML_FOOTER tag can be used to specify a personal HTML footer for  
    533 # each generated HTML page. If it is left blank doxygen will generate a  
     787HTML_HEADER            = 
     788 
     789# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
     790# each generated HTML page. If it is left blank doxygen will generate a 
    534791# standard footer. 
    535792 
    536 HTML_FOOTER            =  
    537  
    538 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading  
    539 # style sheet that is used by each HTML page. It can be used to  
    540 # fine-tune the look of the HTML output. If the tag is left blank doxygen  
    541 # will generate a default style sheet 
    542  
    543 HTML_STYLESHEET        =  
    544  
    545 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,  
    546 # files or namespaces will be aligned in HTML using tables. If set to  
     793HTML_FOOTER            = 
     794 
     795# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
     796# style sheet that is used by each HTML page. It can be used to 
     797# fine-tune the look of the HTML output. If the tag is left blank doxygen 
     798# will generate a default style sheet. Note that doxygen will try to copy 
     799# the style sheet file to the HTML output directory, so don't put your own 
     800# stylesheet in the HTML output directory as well, or it will be erased! 
     801 
     802HTML_STYLESHEET        = 
     803 
     804# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
     805# files or namespaces will be aligned in HTML using tables. If set to 
    547806# NO a bullet list will be used. 
    548807 
    549808HTML_ALIGN_MEMBERS     = YES 
    550809 
    551 # If the GENERATE_HTMLHELP tag is set to YES, additional index files  
    552 # will be generated that can be used as input for tools like the  
    553 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)  
     810# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
     811# documentation will contain sections that can be hidden and shown after the 
     812# page has loaded. For this to work a browser that supports 
     813# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
     814# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 
     815 
     816HTML_DYNAMIC_SECTIONS  = YES 
     817 
     818# If the GENERATE_DOCSET tag is set to YES, additional index files 
     819# will be generated that can be used as input for Apple's Xcode 3 
     820# integrated development environment, introduced with OSX 10.5 (Leopard). 
     821# To create a documentation set, doxygen will generate a Makefile in the 
     822# HTML output directory. Running make will produce the docset in that 
     823# directory and running "make install" will install the docset in 
     824# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
     825# it at startup. 
     826# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 
     827 
     828GENERATE_DOCSET        = NO 
     829 
     830# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
     831# feed. A documentation feed provides an umbrella under which multiple 
     832# documentation sets from a single provider (such as a company or product suite) 
     833# can be grouped. 
     834 
     835DOCSET_FEEDNAME        = "Doxygen generated docs" 
     836 
     837# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
     838# should uniquely identify the documentation set bundle. This should be a 
     839# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
     840# will append .docset to the name. 
     841 
     842DOCSET_BUNDLE_ID       = org.doxygen.Project 
     843 
     844# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
     845# will be generated that can be used as input for tools like the 
     846# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
    554847# of the generated HTML documentation. 
    555848 
    556849GENERATE_HTMLHELP      = NO 
    557850 
    558 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  
    559 # be used to specify the file name of the resulting .chm file. You  
    560 # can add a path in front of the file if the result should not be  
    561 # written to the html output dir
    562  
    563 CHM_FILE               =  
    564  
    565 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can  
    566 # be used to specify the location (absolute path including file name) of  
    567 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run  
     851# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
     852# be used to specify the file name of the resulting .chm file. You 
     853# can add a path in front of the file if the result should not be 
     854# written to the html output directory
     855 
     856CHM_FILE               = 
     857 
     858# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
     859# be used to specify the location (absolute path including file name) of 
     860# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
    568861# the HTML help compiler on the generated index.hhp. 
    569862 
    570 HHC_LOCATION           =  
    571  
    572 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag  
    573 # controls if a separate .chi index file is generated (YES) or that  
     863HHC_LOCATION           = 
     864 
     865# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
     866# controls if a separate .chi index file is generated (YES) or that 
    574867# it should be included in the master .chm file (NO). 
    575868 
    576869GENERATE_CHI           = NO 
    577870 
    578 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag  
    579 # controls whether a binary table of contents is generated (YES) or a  
     871# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
     872# is used to encode HtmlHelp index (hhk), content (hhc) and project file 
     873# content. 
     874 
     875CHM_INDEX_ENCODING     = 
     876 
     877# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
     878# controls whether a binary table of contents is generated (YES) or a 
    580879# normal table of contents (NO) in the .chm file. 
    581880 
    582881BINARY_TOC             = NO 
    583882 
    584 # The TOC_EXPAND flag can be set to YES to add extra items for group members  
     883# The TOC_EXPAND flag can be set to YES to add extra items for group members 
    585884# to the contents of the HTML help documentation and to the tree view. 
    586885 
    587886TOC_EXPAND             = NO 
    588887 
    589 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at  
    590 # top of each HTML page. The value NO (the default) enables the index and  
     888# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
     889# are set, an additional index file will be generated that can be used as input for 
     890# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
     891# HTML documentation. 
     892 
     893GENERATE_QHP           = YES 
     894 
     895# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
     896# be used to specify the file name of the resulting .qch file. 
     897# The path specified is relative to the HTML output folder. 
     898 
     899QCH_FILE               = 
     900 
     901# The QHP_NAMESPACE tag specifies the namespace to use when generating 
     902# Qt Help Project output. For more information please see 
     903# http://doc.trolltech.com/qthelpproject.html#namespace 
     904 
     905QHP_NAMESPACE          = LIBFFADO 
     906 
     907# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
     908# Qt Help Project output. For more information please see 
     909# http://doc.trolltech.com/qthelpproject.html#virtual-folders 
     910 
     911QHP_VIRTUAL_FOLDER     = reference 
     912 
     913# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 
     914# For more information please see 
     915# http://doc.trolltech.com/qthelpproject.html#custom-filters 
     916 
     917QHP_CUST_FILTER_NAME   = 
     918 
     919# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 
     920# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 
     921 
     922QHP_CUST_FILTER_ATTRS  = 
     923 
     924# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 
     925# filter section matches. 
     926# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 
     927 
     928QHP_SECT_FILTER_ATTRS  = 
     929 
     930# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
     931# be used to specify the location of Qt's qhelpgenerator. 
     932# If non-empty doxygen will try to run qhelpgenerator on the generated 
     933# .qhp file. 
     934 
     935QHG_LOCATION           = 
     936 
     937# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
     938# top of each HTML page. The value NO (the default) enables the index and 
    591939# the value YES disables it. 
    592940 
    593941DISABLE_INDEX          = NO 
    594942 
    595 # This tag can be used to set the number of enum values (range [1..20])  
     943# This tag can be used to set the number of enum values (range [1..20]) 
    596944# that doxygen will group on one line in the generated HTML documentation. 
    597945 
    598946ENUM_VALUES_PER_LINE   = 4 
    599947 
    600 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 
    601 # generated containing a tree-like index structure (just like the one that  
    602 # is generated for HTML Help). For this to work a browser that supports  
    603 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,  
    604 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are  
    605 # probably better off using the HTML help feature. 
    606  
    607 GENERATE_TREEVIEW      = YES 
    608  
    609 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be  
    610 # used to set the initial width (in pixels) of the frame in which the tree  
     948# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
     949# structure should be generated to display hierarchical information. 
     950# If the tag value is set to YES, a side panel will be generated 
     951# containing a tree-like index structure (just like the one that 
     952# is generated for HTML Help). For this to work a browser that supports 
     953# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 
     954# Windows users are probably better off using the HTML help feature. 
     955 
     956GENERATE_TREEVIEW      = NO 
     957 
     958# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
     959# and Class Hierarchy pages using a tree view instead of an ordered list. 
     960 
     961USE_INLINE_TREES       = YES 
     962 
     963# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
     964# used to set the initial width (in pixels) of the frame in which the tree 
    611965# is shown. 
    612966 
    613967TREEVIEW_WIDTH         = 250 
    614968 
     969# Use this tag to change the font size of Latex formulas included 
     970# as images in the HTML documentation. The default is 10. Note that 
     971# when you change the font size after a successful doxygen run you need 
     972# to manually remove any form_*.png images from the HTML output directory 
     973# to force them to be regenerated. 
     974 
     975FORMULA_FONTSIZE       = 10 
     976 
     977# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript 
     978# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) 
     979# there is already a search function so this one should typically 
     980# be disabled. 
     981 
     982SEARCHENGINE           = NO 
     983 
    615984#--------------------------------------------------------------------------- 
    616985# configuration options related to the LaTeX output 
    617986#--------------------------------------------------------------------------- 
    618987 
    619 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will  
     988# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
    620989# generate Latex output. 
    621990 
    622 GENERATE_LATEX         = YES 
    623  
    624 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.  
    625 # If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     991GENERATE_LATEX         = NO 
     992 
     993# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
     994# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
    626995# put in front of it. If left blank `latex' will be used as the default path. 
    627996 
    628997LATEX_OUTPUT           = latex 
    629998 
    630 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be  
     999# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
    6311000# invoked. If left blank `latex' will be used as the default command name. 
    6321001 
    6331002LATEX_CMD_NAME         = latex 
    6341003 
    635 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to  
    636 # generate index for LaTeX. If left blank `makeindex' will be used as the  
     1004# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
     1005# generate index for LaTeX. If left blank `makeindex' will be used as the 
    6371006# default command name. 
    6381007 
    6391008MAKEINDEX_CMD_NAME     = makeindex 
    6401009 
    641 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact  
    642 # LaTeX documents. This may be useful for small projects and may help to  
     1010# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
     1011# LaTeX documents. This may be useful for small projects and may help to 
    6431012# save some trees in general. 
    6441013 
    6451014COMPACT_LATEX          = NO 
    6461015 
    647 # The PAPER_TYPE tag can be used to set the paper type that is used  
    648 # by the printer. Possible values are: a4, a4wide, letter, legal and  
     1016# The PAPER_TYPE tag can be used to set the paper type that is used 
     1017# by the printer. Possible values are: a4, a4wide, letter, legal and 
    6491018# executive. If left blank a4wide will be used. 
    6501019 
    6511020PAPER_TYPE             = a4 
    6521021 
    653 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX  
     1022# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
    6541023# packages that should be included in the LaTeX output. 
    6551024 
    656 EXTRA_PACKAGES         =  
    657  
    658 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for  
    659 # the generated latex document. The header should contain everything until  
    660 # the first chapter. If it is left blank doxygen will generate a  
     1025EXTRA_PACKAGES         = 
     1026 
     1027# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
     1028# the generated latex document. The header should contain everything until 
     1029# the first chapter. If it is left blank doxygen will generate a 
    6611030# standard header. Notice: only use this tag if you know what you are doing! 
    6621031 
    663 LATEX_HEADER           =  
    664  
    665 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated  
    666 # is prepared for conversion to pdf (using ps2pdf). The pdf file will  
    667 # contain links (just like the HTML output) instead of page references  
     1032LATEX_HEADER           = 
     1033 
     1034# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
     1035# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
     1036# contain links (just like the HTML output) instead of page references 
    6681037# This makes the output suitable for online browsing using a pdf viewer. 
    6691038 
    6701039PDF_HYPERLINKS         = YES 
    6711040 
    672 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of  
    673 # plain latex in the generated Makefile. Set this option to YES to get a  
     1041# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
     1042# plain latex in the generated Makefile. Set this option to YES to get a 
    6741043# higher quality PDF documentation. 
    6751044 
    6761045USE_PDFLATEX           = YES 
    6771046 
    678 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.  
    679 # command to the generated LaTeX files. This will instruct LaTeX to keep  
    680 # running if errors occur, instead of asking the user for help.  
     1047# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
     1048# command to the generated LaTeX files. This will instruct LaTeX to keep 
     1049# running if errors occur, instead of asking the user for help. 
    6811050# This option is also used when generating formulas in HTML. 
    6821051 
    6831052LATEX_BATCHMODE        = NO 
    6841053 
    685 # If LATEX_HIDE_INDICES is set to YES then doxygen will not  
    686 # include the index chapters (such as File Index, Compound Index, etc.)  
     1054# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
     1055# include the index chapters (such as File Index, Compound Index, etc.) 
    6871056# in the output. 
    6881057 
    6891058LATEX_HIDE_INDICES     = NO 
    6901059 
     1060# 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. 
     1061 
     1062LATEX_SOURCE_CODE      = NO 
     1063 
    6911064#--------------------------------------------------------------------------- 
    6921065# configuration options related to the RTF output 
    6931066#--------------------------------------------------------------------------- 
    6941067 
    695 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output  
    696 # The RTF output is optimised for Word 97 and may not look very pretty with  
     1068# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
     1069# The RTF output is optimized for Word 97 and may not look very pretty with 
    6971070# other RTF readers or editors. 
    6981071 
    6991072GENERATE_RTF           = NO 
    7001073 
    701 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.  
    702 # If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     1074# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
     1075# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
    7031076# put in front of it. If left blank `rtf' will be used as the default path. 
    7041077 
    7051078RTF_OUTPUT             = rtf 
    7061079 
    707 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact  
    708 # RTF documents. This may be useful for small projects and may help to  
     1080# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
     1081# RTF documents. This may be useful for small projects and may help to 
    7091082# save some trees in general. 
    7101083 
    7111084COMPACT_RTF            = NO 
    7121085 
    713 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated  
    714 # will contain hyperlink fields. The RTF file will  
    715 # contain links (just like the HTML output) instead of page references.  
    716 # This makes the output suitable for online browsing using WORD or other  
    717 # programs which support those fields.  
     1086# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
     1087# will contain hyperlink fields. The RTF file will 
     1088# contain links (just like the HTML output) instead of page references. 
     1089# This makes the output suitable for online browsing using WORD or other 
     1090# programs which support those fields. 
    7181091# Note: wordpad (write) and others do not support links. 
    7191092 
    7201093RTF_HYPERLINKS         = NO 
    7211094 
    722 # Load stylesheet definitions from file. Syntax is similar to doxygen's  
    723 # config file, i.e. a series of assigments. You only have to provide  
     1095# Load stylesheet definitions from file. Syntax is similar to doxygen's 
     1096# config file, i.e. a series of assignments. You only have to provide 
    7241097# replacements, missing definitions are set to their default value. 
    7251098 
    726 RTF_STYLESHEET_FILE    =  
    727  
    728 # Set optional variables used in the generation of an rtf document.  
     1099RTF_STYLESHEET_FILE    = 
     1100 
     1101# Set optional variables used in the generation of an rtf document. 
    7291102# Syntax is similar to doxygen's config file. 
    7301103 
    731 RTF_EXTENSIONS_FILE    =  
     1104RTF_EXTENSIONS_FILE    = 
    7321105 
    7331106#--------------------------------------------------------------------------- 
     
    7351108#--------------------------------------------------------------------------- 
    7361109 
    737 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will  
     1110# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
    7381111# generate man pages 
    7391112 
    7401113GENERATE_MAN           = NO 
    7411114 
    742 # The MAN_OUTPUT tag is used to specify where the man pages will be put.  
    743 # If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     1115# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
     1116# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
    7441117# put in front of it. If left blank `man' will be used as the default path. 
    7451118 
    7461119MAN_OUTPUT             = man 
    7471120 
    748 # The MAN_EXTENSION tag determines the extension that is added to  
     1121# The MAN_EXTENSION tag determines the extension that is added to 
    7491122# the generated man pages (default is the subroutine's section .3) 
    7501123 
    7511124MAN_EXTENSION          = .3 
    7521125 
    753 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,  
    754 # then it will generate one additional man file for each entity  
    755 # documented in the real man page(s). These additional files  
    756 # only source the real man page, but without them the man command  
     1126# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
     1127# then it will generate one additional man file for each entity 
     1128# documented in the real man page(s). These additional files 
     1129# only source the real man page, but without them the man command 
    7571130# would be unable to find the correct page. The default is NO. 
    7581131 
     
    7631136#--------------------------------------------------------------------------- 
    7641137 
    765 # If the GENERATE_XML tag is set to YES Doxygen will  
    766 # generate an XML file that captures the structure of  
    767 # the code including all documentation. Note that this  
    768 # feature is still experimental and incomplete at the  
     1138# If the GENERATE_XML tag is set to YES Doxygen will 
     1139# generate an XML file that captures the structure of 
     1140# the code including all documentation. 
     1141 
     1142GENERATE_XML           = NO 
     1143 
     1144# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
     1145# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1146# put in front of it. If left blank `xml' will be used as the default path. 
     1147 
     1148XML_OUTPUT             = xml 
     1149 
     1150# The XML_SCHEMA tag can be used to specify an XML schema, 
     1151# which can be used by a validating XML parser to check the 
     1152# syntax of the XML files. 
     1153 
     1154XML_SCHEMA             = 
     1155 
     1156# The XML_DTD tag can be used to specify an XML DTD, 
     1157# which can be used by a validating XML parser to check the 
     1158# syntax of the XML files. 
     1159 
     1160XML_DTD                = 
     1161 
     1162# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
     1163# dump the program listings (including syntax highlighting 
     1164# and cross-referencing information) to the XML output. Note that 
     1165# enabling this will significantly increase the size of the XML output. 
     1166 
     1167XML_PROGRAMLISTING     = YES 
     1168 
     1169#--------------------------------------------------------------------------- 
     1170# configuration options for the AutoGen Definitions output 
     1171#--------------------------------------------------------------------------- 
     1172 
     1173# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
     1174# generate an AutoGen Definitions (see autogen.sf.net) file 
     1175# that captures the structure of the code including all 
     1176# documentation. Note that this feature is still experimental 
     1177# and incomplete at the moment. 
     1178 
     1179GENERATE_AUTOGEN_DEF   = NO 
     1180 
     1181#--------------------------------------------------------------------------- 
     1182# configuration options related to the Perl module output 
     1183#--------------------------------------------------------------------------- 
     1184 
     1185# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
     1186# generate a Perl module file that captures the structure of 
     1187# the code including all documentation. Note that this 
     1188# feature is still experimental and incomplete at the 
    7691189# moment. 
    7701190 
    771 GENERATE_XML           = NO 
    772  
    773 # The XML_OUTPUT tag is used to specify where the XML pages will be put.  
    774 # If a relative path is entered the value of OUTPUT_DIRECTORY will be  
    775 # put in front of it. If left blank `xml' will be used as the default path. 
    776  
    777 XML_OUTPUT             = xml 
    778  
    779 # The XML_SCHEMA tag can be used to specify an XML schema,  
    780 # which can be used by a validating XML parser to check the  
    781 # syntax of the XML files. 
    782  
    783 XML_SCHEMA             =  
    784  
    785 # The XML_DTD tag can be used to specify an XML DTD,  
    786 # which can be used by a validating XML parser to check the  
    787 # syntax of the XML files. 
    788  
    789 XML_DTD                =  
    790  
    791 #--------------------------------------------------------------------------- 
    792 # configuration options for the AutoGen Definitions output 
    793 #--------------------------------------------------------------------------- 
    794  
    795 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will  
    796 # generate an AutoGen Definitions (see autogen.sf.net) file  
    797 # that captures the structure of the code including all  
    798 # documentation. Note that this feature is still experimental  
    799 # and incomplete at the moment. 
    800  
    801 GENERATE_AUTOGEN_DEF   = NO 
    802  
    803 #--------------------------------------------------------------------------- 
    804 # configuration options related to the Perl module output 
    805 #--------------------------------------------------------------------------- 
    806  
    807 # If the GENERATE_PERLMOD tag is set to YES Doxygen will  
    808 # generate a Perl module file that captures the structure of  
    809 # the code including all documentation. Note that this  
    810 # feature is still experimental and incomplete at the  
    811 # moment. 
    812  
    8131191GENERATE_PERLMOD       = NO 
    8141192 
    815 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate  
    816 # the necessary Makefile rules, Perl scripts and LaTeX code to be able  
     1193# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
     1194# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
    8171195# to generate PDF and DVI output from the Perl module output. 
    8181196 
    8191197PERLMOD_LATEX          = NO 
    8201198 
    821 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be  
    822 # nicely formatted so it can be parsed by a human reader.  This is useful  
    823 # if you want to understand what is going on.  On the other hand, if this  
    824 # tag is set to NO the size of the Perl module output will be much smaller  
     1199# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
     1200# nicely formatted so it can be parsed by a human reader. 
     1201# This is useful 
     1202# if you want to understand what is going on. 
     1203# On the other hand, if this 
     1204# tag is set to NO the size of the Perl module output will be much smaller 
    8251205# and Perl will parse it just the same. 
    8261206 
    8271207PERLMOD_PRETTY         = YES 
    8281208 
    829 # The names of the make variables in the generated doxyrules.make file  
    830 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.  
    831 # This is useful so different doxyrules.make files included by the same  
     1209# The names of the make variables in the generated doxyrules.make file 
     1210# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
     1211# This is useful so different doxyrules.make files included by the same 
    8321212# Makefile don't overwrite each other's variables. 
    8331213 
    834 PERLMOD_MAKEVAR_PREFIX =  
    835  
    836 #--------------------------------------------------------------------------- 
    837 # Configuration options related to the preprocessor    
    838 #--------------------------------------------------------------------------- 
    839  
    840 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will  
    841 # evaluate all C-preprocessor directives found in the sources and include  
     1214PERLMOD_MAKEVAR_PREFIX = 
     1215 
     1216#--------------------------------------------------------------------------- 
     1217# Configuration options related to the preprocessor 
     1218#--------------------------------------------------------------------------- 
     1219 
     1220# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
     1221# evaluate all C-preprocessor directives found in the sources and include 
    8421222# files. 
    8431223 
    8441224ENABLE_PREPROCESSING   = YES 
    8451225 
    846 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro  
    847 # names in the source code. If set to NO (the default) only conditional  
    848 # compilation will be performed. Macro expansion can be done in a controlled  
     1226# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
     1227# names in the source code. If set to NO (the default) only conditional 
     1228# compilation will be performed. Macro expansion can be done in a controlled 
    8491229# way by setting EXPAND_ONLY_PREDEF to YES. 
    8501230 
    8511231MACRO_EXPANSION        = NO 
    8521232 
    853 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES  
    854 # then the macro expansion is limited to the macros specified with the  
    855 # PREDEFINED and EXPAND_AS_PREDEFINED tags. 
     1233# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
     1234# then the macro expansion is limited to the macros specified with the 
     1235# PREDEFINED and EXPAND_AS_DEFINED tags. 
    8561236 
    8571237EXPAND_ONLY_PREDEF     = NO 
    8581238 
    859 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  
     1239# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
    8601240# in the INCLUDE_PATH (see below) will be search if a #include is found. 
    8611241 
    8621242SEARCH_INCLUDES        = YES 
    8631243 
    864 # The INCLUDE_PATH tag can be used to specify one or more directories that  
    865 # contain include files that are not input files but should be processed by  
     1244# The INCLUDE_PATH tag can be used to specify one or more directories that 
     1245# contain include files that are not input files but should be processed by 
    8661246# the preprocessor. 
    8671247 
    868 INCLUDE_PATH           =  
    869  
    870 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard  
    871 # patterns (like *.h and *.hpp) to filter out the header-files in the  
    872 # directories. If left blank, the patterns specified with FILE_PATTERNS will  
     1248INCLUDE_PATH           = $top_srcdir/src 
     1249 
     1250# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
     1251# patterns (like *.h and *.hpp) to filter out the header-files in the 
     1252# directories. If left blank, the patterns specified with FILE_PATTERNS will 
    8731253# be used. 
    8741254 
    875 INCLUDE_FILE_PATTERNS  =  
    876  
    877 # The PREDEFINED tag can be used to specify one or more macro names that  
    878 # are defined before the preprocessor is started (similar to the -D option of  
    879 # gcc). The argument of the tag is a list of macros of the form: name  
    880 # or name=definition (no spaces). If the definition and the = are  
    881 # omitted =1 is assumed. 
    882  
    883 PREDEFINED             =  
    884  
    885 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  
    886 # this tag can be used to specify a list of macro names that should be expanded.  
    887 # The macro definition that is found in the sources will be used.  
     1255INCLUDE_FILE_PATTERNS  = 
     1256 
     1257# The PREDEFINED tag can be used to specify one or more macro names that 
     1258# are defined before the preprocessor is started (similar to the -D option of 
     1259# gcc). The argument of the tag is a list of macros of the form: name 
     1260# or name=definition (no spaces). If the definition and the = are 
     1261# omitted =1 is assumed. To prevent a macro definition from being 
     1262# undefined via #undef or recursively expanded use the := operator 
     1263# instead of the = operator. 
     1264 
     1265PREDEFINED             = 
     1266 
     1267# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
     1268# this tag can be used to specify a list of macro names that should be expanded. 
     1269# The macro definition that is found in the sources will be used. 
    8881270# Use the PREDEFINED tag if you want to use a different macro definition. 
    8891271 
    890 EXPAND_AS_DEFINED      =  
     1272EXPAND_AS_DEFINED      = 
    8911273 
    8921274# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
    893 # doxygen's preprocessor will remove all function-like macros that are 
    894 # alone on a line, have an all uppercase name, and do not end with a 
    895 # semicolon. Such function macros are typically used for boiler-plat
    896 # code, and will confuse the parser if not removed. 
     1275# doxygen's preprocessor will remove all function-like macros that are alone 
     1276# on a line, have an all uppercase name, and do not end with a semicolon. Such 
     1277# function macros are typically used for boiler-plate code, and will confus
     1278# the parser if not removed. 
    8971279 
    8981280SKIP_FUNCTION_MACROS   = YES 
    8991281 
    9001282#--------------------------------------------------------------------------- 
    901 # Configuration::addtions related to external references    
    902 #--------------------------------------------------------------------------- 
    903  
    904 # The TAGFILES option can be used to specify one or more tagfiles.  
    905 # Optionally an initial location of the external documentation  
    906 # can be added for each tagfile. The format of a tag file without  
    907 # this location is as follows:  
    908 #   TAGFILES = file1 file2 ...  
    909 # Adding location for the tag files is done as follows:  
    910 #   TAGFILES = file1=loc1 "file2 = loc2" ...  
    911 # where "loc1" and "loc2" can be relative or absolute paths or  
    912 # URLs. If a location is present for each tag, the installdox tool  
     1283# Configuration::additions related to external references 
     1284#--------------------------------------------------------------------------- 
     1285 
     1286# The TAGFILES option can be used to specify one or more tagfiles. 
     1287# Optionally an initial location of the external documentation 
     1288# can be added for each tagfile. The format of a tag file without 
     1289# this location is as follows: 
     1290
     1291# TAGFILES = file1 file2 ... 
     1292# Adding location for the tag files is done as follows: 
     1293
     1294# TAGFILES = file1=loc1 "file2 = loc2" ... 
     1295# where "loc1" and "loc2" can be relative or absolute paths or 
     1296# URLs. If a location is present for each tag, the installdox tool 
    9131297# does not have to be run to correct the links. 
    9141298# Note that each tag file must have a unique name 
    9151299# (where the name does NOT include the path) 
    916 # If a tag file is not located in the directory in which doxygen  
     1300# If a tag file is not located in the directory in which doxygen 
    9171301# is run, you must also specify the path to the tagfile here. 
    9181302 
    919 TAGFILES               =  
    920  
    921 # When a file name is specified after GENERATE_TAGFILE, doxygen will create  
     1303TAGFILES               = 
     1304 
     1305# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
    9221306# a tag file that is based on the input files it reads. 
    9231307 
    924 GENERATE_TAGFILE       =  
    925  
    926 # If the ALLEXTERNALS tag is set to YES all external classes will be listed  
    927 # in the class index. If set to NO only the inherited external classes  
     1308GENERATE_TAGFILE       = 
     1309 
     1310# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
     1311# in the class index. If set to NO only the inherited external classes 
    9281312# will be listed. 
    9291313 
    9301314ALLEXTERNALS           = NO 
    9311315 
    932 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed  
    933 # in the modules index. If set to NO, only the current project's groups will  
     1316# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
     1317# in the modules index. If set to NO, only the current project's groups will 
    9341318# be listed. 
    9351319 
    9361320EXTERNAL_GROUPS        = YES 
    9371321 
    938 # The PERL_PATH should be the absolute path and name of the perl script  
     1322# The PERL_PATH should be the absolute path and name of the perl script 
    9391323# interpreter (i.e. the result of `which perl'). 
    9401324 
     
    9421326 
    9431327#--------------------------------------------------------------------------- 
    944 # Configuration options related to the dot tool    
     1328# Configuration options related to the dot tool 
    9451329#--------------------------------------------------------------------------- 
    9461330 
    9471331# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
    948 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes 
    949 # with base or super classes. Setting the tag to NO turns the diagrams 
    950 # off. Note that this option is superceded by the HAVE_DOT option 
    951 # below. This is only a fallback. It is recommended to install and us
    952 # dot, since it yields more powerful graphs. 
     1332# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
     1333# or super classes. Setting the tag to NO turns the diagrams off. Note that 
     1334# this option is superseded by the HAVE_DOT option below. This is only a 
     1335# fallback. It is recommended to install and use dot, since it yields mor
     1336# powerful graphs. 
    9531337 
    9541338CLASS_DIAGRAMS         = YES 
    9551339 
    956 # If set to YES, the inheritance and collaboration graphs will hide  
    957 # inheritance and usage relations if the target is undocumented  
     1340# You can define message sequence charts within doxygen comments using the \msc 
     1341# command. Doxygen will then run the mscgen tool (see 
     1342# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
     1343# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
     1344# the mscgen tool resides. If left empty the tool is assumed to be found in the 
     1345# default search path. 
     1346 
     1347MSCGEN_PATH            = 
     1348 
     1349# If set to YES, the inheritance and collaboration graphs will hide 
     1350# inheritance and usage relations if the target is undocumented 
    9581351# or is not a class. 
    9591352 
    960 HIDE_UNDOC_RELATIONS   = YES 
    961  
    962 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is  
    963 # available from the path. This tool is part of Graphviz, a graph visualization  
    964 # toolkit from AT&T and Lucent Bell Labs. The other options in this section  
     1353HIDE_UNDOC_RELATIONS   = NO 
     1354 
     1355# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
     1356# available from the path. This tool is part of Graphviz, a graph visualization 
     1357# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
    9651358# have no effect if this option is set to NO (the default) 
    9661359 
    967 HAVE_DOT               = NO 
    968  
    969 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  
    970 # will generate a graph for each documented class showing the direct and  
    971 # indirect inheritance relations. Setting this tag to YES will force the  
     1360HAVE_DOT               = YES 
     1361 
     1362# By default doxygen will write a font called FreeSans.ttf to the output 
     1363# directory and reference it in all dot files that doxygen generates. This 
     1364# font does not include all possible unicode characters however, so when you need 
     1365# these (or just want a differently looking font) you can specify the font name 
     1366# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
     1367# which can be done by putting it in a standard location or by setting the 
     1368# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
     1369# containing the font. 
     1370 
     1371DOT_FONTNAME           = FreeSans 
     1372 
     1373# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
     1374# The default size is 10pt. 
     1375 
     1376DOT_FONTSIZE           = 10 
     1377 
     1378# By default doxygen will tell dot to use the output directory to look for the 
     1379# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
     1380# different font using DOT_FONTNAME you can set the path where dot 
     1381# can find it using this tag. 
     1382 
     1383DOT_FONTPATH           = 
     1384 
     1385# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
     1386# will generate a graph for each documented class showing the direct and 
     1387# indirect inheritance relations. Setting this tag to YES will force the 
    9721388# the CLASS_DIAGRAMS tag to NO. 
    9731389 
    9741390CLASS_GRAPH            = YES 
    9751391 
    976 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen  
    977 # will generate a graph for each documented class showing the direct and  
    978 # indirect implementation dependencies (inheritance, containment, and  
     1392# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
     1393# will generate a graph for each documented class showing the direct and 
     1394# indirect implementation dependencies (inheritance, containment, and 
    9791395# class references variables) of the class with other documented classes. 
    9801396 
    981 COLLABORATION_GRAPH    = YES 
    982  
    983 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and  
    984 # collaboration diagrams in a style similiar to the OMG's Unified Modeling  
     1397COLLABORATION_GRAPH    = NO 
     1398 
     1399# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
     1400# will generate a graph for groups, showing the direct groups dependencies 
     1401 
     1402GROUP_GRAPHS           = YES 
     1403 
     1404# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
     1405# collaboration diagrams in a style similar to the OMG's Unified Modeling 
    9851406# Language. 
    9861407 
    9871408UML_LOOK               = YES 
    9881409 
    989 # If set to YES, the inheritance and collaboration graphs will show the  
     1410# If set to YES, the inheritance and collaboration graphs will show the 
    9901411# relations between templates and their instances. 
    9911412 
    9921413TEMPLATE_RELATIONS     = YES 
    9931414 
    994 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT  
    995 # tags are set to YES then doxygen will generate a graph for each documented  
    996 # file showing the direct and indirect include dependencies of the file with  
     1415# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
     1416# tags are set to YES then doxygen will generate a graph for each documented 
     1417# file showing the direct and indirect include dependencies of the file with 
    9971418# other documented files. 
    9981419 
    999 INCLUDE_GRAPH          = YES 
    1000  
    1001 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and  
    1002 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each  
    1003 # documented header file showing the documented files that directly or  
     1420INCLUDE_GRAPH          = NO 
     1421 
     1422# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
     1423# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
     1424# documented header file showing the documented files that directly or 
    10041425# indirectly include this file. 
    10051426 
    1006 INCLUDED_BY_GRAPH      = YES 
    1007  
    1008 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will  
    1009 # generate a call dependency graph for every global function or class method.  
    1010 # Note that enabling this option will significantly increase the time of a run.  
    1011 # So in most cases it will be better to enable call graphs for selected  
    1012 # functions only using the \callgraph command. 
     1427INCLUDED_BY_GRAPH      = NO 
     1428 
     1429# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
     1430# doxygen will generate a call dependency graph for every global function 
     1431# or class method. Note that enabling this option will significantly increase 
     1432# the time of a run. So in most cases it will be better to enable call graphs 
     1433# for selected functions only using the \callgraph command. 
    10131434 
    10141435CALL_GRAPH             = NO 
    10151436 
    1016 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen  
     1437# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
     1438# doxygen will generate a caller dependency graph for every global function 
     1439# or class method. Note that enabling this option will significantly increase 
     1440# the time of a run. So in most cases it will be better to enable caller 
     1441# graphs for selected functions only using the \callergraph command. 
     1442 
     1443CALLER_GRAPH           = NO 
     1444 
     1445# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
    10171446# will graphical hierarchy of all classes instead of a textual one. 
    10181447 
    10191448GRAPHICAL_HIERARCHY    = YES 
    10201449 
    1021 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images  
     1450# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
     1451# then doxygen will show the dependencies a directory has on other directories 
     1452# in a graphical way. The dependency relations are determined by the #include 
     1453# relations between the files in the directories. 
     1454 
     1455DIRECTORY_GRAPH        = NO 
     1456 
     1457# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
    10221458# generated by dot. Possible values are png, jpg, or gif 
    10231459# If left blank png will be used. 
     
    10251461DOT_IMAGE_FORMAT       = png 
    10261462 
    1027 # The tag DOT_PATH can be used to specify the path where the dot tool can be  
    1028 # found. If left blank, it is assumed the dot tool can be found on the path. 
    1029  
    1030 DOT_PATH               =  
    1031  
    1032 # The DOTFILE_DIRS tag can be used to specify one or more directories that  
    1033 # contain dot files that are included in the documentation (see the  
     1463# The tag DOT_PATH can be used to specify the path where the dot tool can be 
     1464# found. If left blank, it is assumed the dot tool can be found in the path. 
     1465 
     1466DOT_PATH               = 
     1467 
     1468# The DOTFILE_DIRS tag can be used to specify one or more directories that 
     1469# contain dot files that are included in the documentation (see the 
    10341470# \dotfile command). 
    10351471 
    1036 DOTFILE_DIRS           =  
    1037  
    1038 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width  
    1039 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
    1040 # this value, doxygen will try to truncate the graph, so that it fits within  
    1041 # the specified constraint. Beware that most browsers cannot cope with very  
    1042 # large images. 
    1043  
    1044 MAX_DOT_GRAPH_WIDTH    = 1024 
    1045  
    1046 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height  
    1047 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
    1048 # this value, doxygen will try to truncate the graph, so that it fits within  
    1049 # the specified constraint. Beware that most browsers cannot cope with very  
    1050 # large images. 
    1051  
    1052 MAX_DOT_GRAPH_HEIGHT   = 1024 
    1053  
    1054 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of 
    1055 # the graphs generated by dot. A depth value of 3 means that only 
    1056 # nodes reachable from the root by following a path via at most 3 
    1057 # edges will be shown. Nodes that lay further from the root node will 
    1058 # be omitted. Note that setting this option to 1 or 2 may greatly 
    1059 # reduce the computation time needed for large code bases. Also note 
    1060 # that a graph may be further truncated if the graph's image 
    1061 # dimensions are not sufficient to fit the graph (see 
    1062 # MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the 
    1063 # depth value (the default), the graph is not depth-constrained. 
     1472DOTFILE_DIRS           = 
     1473 
     1474# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
     1475# nodes that will be shown in the graph. If the number of nodes in a graph 
     1476# becomes larger than this value, doxygen will truncate the graph, which is 
     1477# visualized by representing a node as a red box. Note that doxygen if the 
     1478# number of direct children of the root node in a graph is already larger than 
     1479# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
     1480# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 
     1481 
     1482DOT_GRAPH_MAX_NODES    = 50 
     1483 
     1484# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
     1485# graphs generated by dot. A depth value of 3 means that only nodes reachable 
     1486# from the root by following a path via at most 3 edges will be shown. Nodes 
     1487# that lay further from the root node will be omitted. Note that setting this 
     1488# option to 1 or 2 may greatly reduce the computation time needed for large 
     1489# code bases. Also note that the size of a graph can be further restricted by 
     1490# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 
    10641491 
    10651492MAX_DOT_GRAPH_DEPTH    = 0 
    10661493 
    1067 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will  
    1068 # generate a legend page explaining the meaning of the various boxes and  
     1494# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
     1495# background. This is disabled by default, because dot on Windows does not 
     1496# seem to support this out of the box. Warning: Depending on the platform used, 
     1497# enabling this option may lead to badly anti-aliased labels on the edges of 
     1498# a graph (i.e. they become hard to read). 
     1499 
     1500DOT_TRANSPARENT        = YES 
     1501 
     1502# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
     1503# files in one run (i.e. multiple -o and -T options on the command line). This 
     1504# makes dot run faster, but since only newer versions of dot (>1.8.10) 
     1505# support this, this feature is disabled by default. 
     1506 
     1507DOT_MULTI_TARGETS      = YES 
     1508 
     1509# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
     1510# generate a legend page explaining the meaning of the various boxes and 
    10691511# arrows in the dot generated graphs. 
    10701512 
    10711513GENERATE_LEGEND        = YES 
    10721514 
    1073 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will  
    1074 # remove the intermediate dot files that are used to generate  
     1515# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
     1516# remove the intermediate dot files that are used to generate 
    10751517# the various graphs. 
    10761518 
    10771519DOT_CLEANUP            = YES 
    1078  
    1079 #--------------------------------------------------------------------------- 
    1080 # Configuration::addtions related to the search engine    
    1081 #--------------------------------------------------------------------------- 
    1082  
    1083 # The SEARCHENGINE tag specifies whether or not a search engine should be  
    1084 # used. If set to NO the values of all tags below this one will be ignored. 
    1085  
    1086 SEARCHENGINE           = NO