Doxyfile
changeset 625 60b5f566a258
parent 588 9f398d3d84a3
child 720 31037fbc5dd8
child 724 59b7f0c2c5c0
equal deleted inserted replaced
624:7da70fac2126 625:60b5f566a258
     1 # Doxyfile 1.2.16
     1 # Doxyfile 1.3.4
     2 
     2 
     3 # This file describes the settings to be used by the documentation system
     3 # This file describes the settings to be used by the documentation system
     4 # doxygen (www.doxygen.org) for a project
     4 # doxygen (www.doxygen.org) for a project
     5 #
     5 #
     6 # All text after a hash (#) is considered a comment and will be ignored
     6 # All text after a hash (#) is considered a comment and will be ignored
     9 # For lists items can also be appended using:
     9 # For lists items can also be appended using:
    10 #       TAG += value [value, ...]
    10 #       TAG += value [value, ...]
    11 # Values that contain spaces should be placed between quotes (" ")
    11 # Values that contain spaces should be placed between quotes (" ")
    12 
    12 
    13 #---------------------------------------------------------------------------
    13 #---------------------------------------------------------------------------
    14 # General configuration options
    14 # Project related configuration options
    15 #---------------------------------------------------------------------------
    15 #---------------------------------------------------------------------------
    16 
    16 
    17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
    17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
    18 # by quotes) that should identify the project.
    18 # by quotes) that should identify the project.
    19 
    19 
    21 
    21 
    22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
    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 
    23 # This could be handy for archiving the generated documentation or 
    24 # if some version control system is used.
    24 # if some version control system is used.
    25 
    25 
    26 PROJECT_NUMBER         = 0.1.9
    26 PROJECT_NUMBER         = 1.0.0
    27 
    27 
    28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    29 # base path where the generated documentation will be put. 
    29 # base path where the generated documentation will be put. 
    30 # If a relative path is entered, it will be relative to the location 
    30 # If a relative path is entered, it will be relative to the location 
    31 # where doxygen was started. If left blank the current directory will be used.
    31 # where doxygen was started. If left blank the current directory will be used.
    34 
    34 
    35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    36 # documentation generated by doxygen is written. Doxygen will use this 
    36 # documentation generated by doxygen is written. Doxygen will use this 
    37 # information to generate all constant output in the proper language. 
    37 # information to generate all constant output in the proper language. 
    38 # The default language is English, other supported languages are: 
    38 # The default language is English, other supported languages are: 
    39 # Brazilian, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
    39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
    40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean, 
    40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 
    41 # Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Slovene, 
    41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 
    42 # Spanish, Swedish and Ukrainian.
    42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
    43 
    43 
    44 OUTPUT_LANGUAGE        = English
    44 OUTPUT_LANGUAGE        = English
       
    45 
       
    46 # This tag can be used to specify the encoding used in the generated output. 
       
    47 # The encoding is not always determined by the language that is chosen, 
       
    48 # but also whether or not the output is meant for Windows or non-Windows users. 
       
    49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
       
    50 # forces the Windows encoding (this is the default for the Windows binary), 
       
    51 # whereas setting the tag to NO uses a Unix-style encoding (the default for 
       
    52 # all platforms other than Windows).
       
    53 
       
    54 USE_WINDOWS_ENCODING   = NO
       
    55 
       
    56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
       
    57 # include brief member descriptions after the members that are listed in 
       
    58 # the file and class documentation (similar to JavaDoc). 
       
    59 # Set to NO to disable this.
       
    60 
       
    61 BRIEF_MEMBER_DESC      = YES
       
    62 
       
    63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
       
    64 # the brief description of a member or function before the detailed description. 
       
    65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
       
    66 # brief descriptions will be completely suppressed.
       
    67 
       
    68 REPEAT_BRIEF           = YES
       
    69 
       
    70 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
       
    71 # Doxygen will generate a detailed section even if there is only a brief 
       
    72 # description.
       
    73 
       
    74 ALWAYS_DETAILED_SEC    = NO
       
    75 
       
    76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
       
    77 # members of a class in the documentation of that class as if those members were 
       
    78 # ordinary class members. Constructors, destructors and assignment operators of 
       
    79 # the base classes will not be shown.
       
    80 
       
    81 INLINE_INHERITED_MEMB  = NO
       
    82 
       
    83 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
       
    84 # path before files name in the file list and in the header files. If set 
       
    85 # to NO the shortest path that makes the file name unique will be used.
       
    86 
       
    87 FULL_PATH_NAMES        = NO
       
    88 
       
    89 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
       
    90 # can be used to strip a user-defined part of the path. Stripping is 
       
    91 # only done if one of the specified strings matches the left-hand part of 
       
    92 # the path. It is allowed to use relative paths in the argument list.
       
    93 
       
    94 STRIP_FROM_PATH        = 
       
    95 
       
    96 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
       
    97 # (but less readable) file names. This can be useful is your file systems 
       
    98 # doesn't support long names like on DOS, Mac, or CD-ROM.
       
    99 
       
   100 SHORT_NAMES            = NO
       
   101 
       
   102 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
       
   103 # will interpret the first line (until the first dot) of a JavaDoc-style 
       
   104 # comment as the brief description. If set to NO, the JavaDoc 
       
   105 # comments will behave just like the Qt-style comments (thus requiring an 
       
   106 # explict @brief command for a brief description.
       
   107 
       
   108 JAVADOC_AUTOBRIEF      = NO
       
   109 
       
   110 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
       
   111 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
       
   112 # comments) as a brief description. This used to be the default behaviour. 
       
   113 # The new default is to treat a multi-line C++ comment block as a detailed 
       
   114 # description. Set this tag to YES if you prefer the old behaviour instead.
       
   115 
       
   116 MULTILINE_CPP_IS_BRIEF = NO
       
   117 
       
   118 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
       
   119 # will output the detailed description near the top, like JavaDoc.
       
   120 # If set to NO, the detailed description appears after the member 
       
   121 # documentation.
       
   122 
       
   123 DETAILS_AT_TOP         = NO
       
   124 
       
   125 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
       
   126 # member inherits the documentation from any documented member that it 
       
   127 # reimplements.
       
   128 
       
   129 INHERIT_DOCS           = YES
       
   130 
       
   131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
       
   132 # tag is set to YES, then doxygen will reuse the documentation of the first 
       
   133 # member in the group (if any) for the other members of the group. By default 
       
   134 # all members of a group must be documented explicitly.
       
   135 
       
   136 DISTRIBUTE_GROUP_DOC   = NO
       
   137 
       
   138 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
       
   139 # Doxygen uses this value to replace tabs by spaces in code fragments.
       
   140 
       
   141 TAB_SIZE               = 4
       
   142 
       
   143 # This tag can be used to specify a number of aliases that acts 
       
   144 # as commands in the documentation. An alias has the form "name=value". 
       
   145 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
       
   146 # put the command \sideeffect (or @sideeffect) in the documentation, which 
       
   147 # will result in a user-defined paragraph with heading "Side Effects:". 
       
   148 # You can put \n's in the value part of an alias to insert newlines.
       
   149 
       
   150 ALIASES                = 
       
   151 
       
   152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
       
   153 # only. Doxygen will then generate output that is more tailored for C. 
       
   154 # For instance, some of the names that are used will be different. The list 
       
   155 # of all members will be omitted, etc.
       
   156 
       
   157 OPTIMIZE_OUTPUT_FOR_C  = YES
       
   158 
       
   159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
       
   160 # only. Doxygen will then generate output that is more tailored for Java. 
       
   161 # For instance, namespaces will be presented as packages, qualified scopes 
       
   162 # will look different, etc.
       
   163 
       
   164 OPTIMIZE_OUTPUT_JAVA   = NO
       
   165 
       
   166 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
       
   167 # the same type (for instance a group of public functions) to be put as a 
       
   168 # subgroup of that type (e.g. under the Public Functions section). Set it to 
       
   169 # NO to prevent subgrouping. Alternatively, this can be done per class using 
       
   170 # the \nosubgrouping command.
       
   171 
       
   172 SUBGROUPING            = YES
       
   173 
       
   174 #---------------------------------------------------------------------------
       
   175 # Build related configuration options
       
   176 #---------------------------------------------------------------------------
    45 
   177 
    46 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
   178 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
    47 # documentation are documented, even if no documentation was available. 
   179 # documentation are documented, even if no documentation was available. 
    48 # Private class members and static file members will be hidden unless 
   180 # Private class members and static file members will be hidden unless 
    49 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
   181 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    74 
   206 
    75 HIDE_UNDOC_MEMBERS     = NO
   207 HIDE_UNDOC_MEMBERS     = NO
    76 
   208 
    77 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
   209 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
    78 # undocumented classes that are normally visible in the class hierarchy. 
   210 # undocumented classes that are normally visible in the class hierarchy. 
    79 # If set to NO (the default) these class will be included in the various 
   211 # If set to NO (the default) these classes will be included in the various 
    80 # overviews. This option has no effect if EXTRACT_ALL is enabled.
   212 # overviews. This option has no effect if EXTRACT_ALL is enabled.
    81 
   213 
    82 HIDE_UNDOC_CLASSES     = NO
   214 HIDE_UNDOC_CLASSES     = NO
    83 
   215 
    84 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
   216 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
    85 # include brief member descriptions after the members that are listed in 
   217 # friend (class|struct|union) declarations. 
    86 # the file and class documentation (similar to JavaDoc). 
   218 # If set to NO (the default) these declarations will be included in the 
    87 # Set to NO to disable this.
   219 # documentation.
    88 
   220 
    89 BRIEF_MEMBER_DESC      = YES
   221 HIDE_FRIEND_COMPOUNDS  = NO
    90 
   222 
    91 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
   223 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
    92 # the brief description of a member or function before the detailed description. 
   224 # documentation blocks found inside the body of a function. 
    93 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
   225 # If set to NO (the default) these blocks will be appended to the 
    94 # brief descriptions will be completely suppressed.
   226 # function's detailed documentation block.
    95 
   227 
    96 REPEAT_BRIEF           = YES
   228 HIDE_IN_BODY_DOCS      = NO
    97 
       
    98 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
       
    99 # Doxygen will generate a detailed section even if there is only a brief 
       
   100 # description.
       
   101 
       
   102 ALWAYS_DETAILED_SEC    = NO
       
   103 
       
   104 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
       
   105 # members of a class in the documentation of that class as if those members were 
       
   106 # ordinary class members. Constructors, destructors and assignment operators of 
       
   107 # the base classes will not be shown.
       
   108 
       
   109 INLINE_INHERITED_MEMB  = NO
       
   110 
       
   111 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
       
   112 # path before files name in the file list and in the header files. If set 
       
   113 # to NO the shortest path that makes the file name unique will be used.
       
   114 
       
   115 FULL_PATH_NAMES        = NO
       
   116 
       
   117 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
       
   118 # can be used to strip a user defined part of the path. Stripping is 
       
   119 # only done if one of the specified strings matches the left-hand part of 
       
   120 # the path. It is allowed to use relative paths in the argument list.
       
   121 
       
   122 STRIP_FROM_PATH        = 
       
   123 
   229 
   124 # The INTERNAL_DOCS tag determines if documentation 
   230 # The INTERNAL_DOCS tag determines if documentation 
   125 # that is typed after a \internal command is included. If the tag is set 
   231 # that is typed after a \internal command is included. If the tag is set 
   126 # to NO (the default) then the documentation will be excluded. 
   232 # to NO (the default) then the documentation will be excluded. 
   127 # Set it to YES to include the internal documentation.
   233 # Set it to YES to include the internal documentation.
   128 
   234 
   129 INTERNAL_DOCS          = NO
   235 INTERNAL_DOCS          = NO
   130 
   236 
   131 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
       
   132 # doxygen to hide any special comment blocks from generated source code 
       
   133 # fragments. Normal C and C++ comments will always remain visible.
       
   134 
       
   135 STRIP_CODE_COMMENTS    = YES
       
   136 
       
   137 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
   237 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
   138 # file names in lower case letters. If set to YES upper case letters are also 
   238 # file names in lower-case letters. If set to YES upper-case letters are also 
   139 # allowed. This is useful if you have classes or files whose names only differ 
   239 # allowed. This is useful if you have classes or files whose names only differ 
   140 # in case and if your file system supports case sensitive file names. Windows 
   240 # in case and if your file system supports case sensitive file names. Windows 
   141 # users are adviced to set this option to NO.
   241 # users are advised to set this option to NO.
   142 
   242 
   143 CASE_SENSE_NAMES       = YES
   243 CASE_SENSE_NAMES       = YES
   144 
       
   145 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
       
   146 # (but less readable) file names. This can be useful is your file systems 
       
   147 # doesn't support long names like on DOS, Mac, or CD-ROM.
       
   148 
       
   149 SHORT_NAMES            = NO
       
   150 
   244 
   151 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
   245 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
   152 # will show members with their full class and namespace scopes in the 
   246 # will show members with their full class and namespace scopes in the 
   153 # documentation. If set to YES the scope will be hidden.
   247 # documentation. If set to YES the scope will be hidden.
   154 
   248 
   155 HIDE_SCOPE_NAMES       = NO
   249 HIDE_SCOPE_NAMES       = NO
   156 
   250 
   157 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
       
   158 # will generate a verbatim copy of the header file for each class for 
       
   159 # which an include is specified. Set to NO to disable this.
       
   160 
       
   161 VERBATIM_HEADERS       = YES
       
   162 
       
   163 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
   251 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
   164 # will put list of the files that are included by a file in the documentation 
   252 # will put a list of the files that are included by a file in the documentation 
   165 # of that file.
   253 # of that file.
   166 
   254 
   167 SHOW_INCLUDE_FILES     = YES
   255 SHOW_INCLUDE_FILES     = YES
   168 
       
   169 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
       
   170 # will interpret the first line (until the first dot) of a JavaDoc-style 
       
   171 # comment as the brief description. If set to NO, the JavaDoc 
       
   172 # comments  will behave just like the Qt-style comments (thus requiring an 
       
   173 # explict @brief command for a brief description.
       
   174 
       
   175 JAVADOC_AUTOBRIEF      = NO
       
   176 
       
   177 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
       
   178 # will output the detailed description near the top, like JavaDoc.
       
   179 # If set to NO, the detailed description appears after the member 
       
   180 # documentation.
       
   181 
       
   182 DETAILS_AT_TOP         = NO
       
   183 
       
   184 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
       
   185 # member inherits the documentation from any documented member that it 
       
   186 # reimplements.
       
   187 
       
   188 INHERIT_DOCS           = YES
       
   189 
   256 
   190 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
   257 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
   191 # is inserted in the documentation for inline members.
   258 # is inserted in the documentation for inline members.
   192 
   259 
   193 INLINE_INFO            = YES
   260 INLINE_INFO            = YES
   197 # alphabetically by member name. If set to NO the members will appear in 
   264 # alphabetically by member name. If set to NO the members will appear in 
   198 # declaration order.
   265 # declaration order.
   199 
   266 
   200 SORT_MEMBER_DOCS       = YES
   267 SORT_MEMBER_DOCS       = YES
   201 
   268 
   202 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
       
   203 # tag is set to YES, then doxygen will reuse the documentation of the first 
       
   204 # member in the group (if any) for the other members of the group. By default 
       
   205 # all members of a group must be documented explicitly.
       
   206 
       
   207 DISTRIBUTE_GROUP_DOC   = NO
       
   208 
       
   209 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
       
   210 # Doxygen uses this value to replace tabs by spaces in code fragments.
       
   211 
       
   212 TAB_SIZE               = 4
       
   213 
       
   214 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
   269 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
   215 # disable (NO) the todo list. This list is created by putting \todo 
   270 # disable (NO) the todo list. This list is created by putting \todo 
   216 # commands in the documentation.
   271 # commands in the documentation.
   217 
   272 
   218 GENERATE_TODOLIST      = YES
   273 GENERATE_TODOLIST      = YES
   227 # disable (NO) the bug list. This list is created by putting \bug 
   282 # disable (NO) the bug list. This list is created by putting \bug 
   228 # commands in the documentation.
   283 # commands in the documentation.
   229 
   284 
   230 GENERATE_BUGLIST       = YES
   285 GENERATE_BUGLIST       = YES
   231 
   286 
   232 # This tag can be used to specify a number of aliases that acts 
   287 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
   233 # as commands in the documentation. An alias has the form "name=value". 
   288 # disable (NO) the deprecated list. This list is created by putting 
   234 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
   289 # \deprecated commands in the documentation.
   235 # put the command \sideeffect (or @sideeffect) in the documentation, which 
   290 
   236 # will result in a user defined paragraph with heading "Side Effects:". 
   291 GENERATE_DEPRECATEDLIST= YES
   237 # You can put \n's in the value part of an alias to insert newlines.
       
   238 
       
   239 ALIASES                = 
       
   240 
   292 
   241 # The ENABLED_SECTIONS tag can be used to enable conditional 
   293 # The ENABLED_SECTIONS tag can be used to enable conditional 
   242 # documentation sections, marked by \if sectionname ... \endif.
   294 # documentation sections, marked by \if sectionname ... \endif.
   243 
   295 
   244 ENABLED_SECTIONS       = 
   296 ENABLED_SECTIONS       = 
   245 
   297 
   246 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
   298 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
   247 # the initial value of a variable or define consist of for it to appear in 
   299 # the initial value of a variable or define consists of for it to appear in 
   248 # the documentation. If the initializer consists of more lines than specified 
   300 # the documentation. If the initializer consists of more lines than specified 
   249 # here it will be hidden. Use a value of 0 to hide initializers completely. 
   301 # here it will be hidden. Use a value of 0 to hide initializers completely. 
   250 # The appearance of the initializer of individual variables and defines in the 
   302 # The appearance of the initializer of individual variables and defines in the 
   251 # documentation can be controlled using \showinitializer or \hideinitializer 
   303 # documentation can be controlled using \showinitializer or \hideinitializer 
   252 # command in the documentation regardless of this setting.
   304 # command in the documentation regardless of this setting.
   253 
   305 
   254 MAX_INITIALIZER_LINES  = 30
   306 MAX_INITIALIZER_LINES  = 30
   255 
   307 
   256 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
       
   257 # only. Doxygen will then generate output that is more tailored for C. 
       
   258 # For instance some of the names that are used will be different. The list 
       
   259 # of all members will be omitted, etc.
       
   260 
       
   261 OPTIMIZE_OUTPUT_FOR_C  = YES
       
   262 
       
   263 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
       
   264 # only. Doxygen will then generate output that is more tailored for Java. 
       
   265 # For instance namespaces will be presented as packages, qualified scopes 
       
   266 # will look different, etc.
       
   267 
       
   268 OPTIMIZE_OUTPUT_JAVA   = NO
       
   269 
       
   270 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
   308 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
   271 # at the bottom of the documentation of classes and structs. If set to YES the 
   309 # at the bottom of the documentation of classes and structs. If set to YES the 
   272 # list will mention the files that were used to generate the documentation.
   310 # list will mention the files that were used to generate the documentation.
   273 
   311 
   274 SHOW_USED_FILES        = YES
   312 SHOW_USED_FILES        = YES
   291 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
   329 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
   292 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
   330 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
   293 # automatically be disabled.
   331 # automatically be disabled.
   294 
   332 
   295 WARN_IF_UNDOCUMENTED   = YES
   333 WARN_IF_UNDOCUMENTED   = YES
       
   334 
       
   335 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
       
   336 # potential errors in the documentation, such as not documenting some 
       
   337 # parameters in a documented function, or documenting parameters that 
       
   338 # don't exist or using markup commands wrongly.
       
   339 
       
   340 WARN_IF_DOC_ERROR      = YES
   296 
   341 
   297 # The WARN_FORMAT tag determines the format of the warning messages that 
   342 # The WARN_FORMAT tag determines the format of the warning messages that 
   298 # doxygen can produce. The string should contain the $file, $line, and $text 
   343 # doxygen can produce. The string should contain the $file, $line, and $text 
   299 # tags, which will be replaced by the file and line number from which the 
   344 # tags, which will be replaced by the file and line number from which the 
   300 # warning originated and the warning text.
   345 # warning originated and the warning text.
   321 # If the value of the INPUT tag contains directories, you can use the 
   366 # If the value of the INPUT tag contains directories, you can use the 
   322 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
   367 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
   323 # and *.h) to filter out the source-files in the directories. If left 
   368 # and *.h) to filter out the source-files in the directories. If left 
   324 # blank the following patterns are tested: 
   369 # blank the following patterns are tested: 
   325 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
   370 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
   326 # *.h++ *.idl *.odl
   371 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
   327 
   372 
   328 FILE_PATTERNS          = 
   373 FILE_PATTERNS          = 
   329 
   374 
   330 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
   375 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
   331 # should be searched for input files as well. Possible values are YES and NO. 
   376 # should be searched for input files as well. Possible values are YES and NO. 
   385 
   430 
   386 INPUT_FILTER           = 
   431 INPUT_FILTER           = 
   387 
   432 
   388 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
   433 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
   389 # INPUT_FILTER) will be used to filter the input files when producing source 
   434 # INPUT_FILTER) will be used to filter the input files when producing source 
   390 # files to browse.
   435 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
   391 
   436 
   392 FILTER_SOURCE_FILES    = NO
   437 FILTER_SOURCE_FILES    = NO
   393 
   438 
   394 #---------------------------------------------------------------------------
   439 #---------------------------------------------------------------------------
   395 # configuration options related to source browsing
   440 # configuration options related to source browsing
   402 
   447 
   403 # Setting the INLINE_SOURCES tag to YES will include the body 
   448 # Setting the INLINE_SOURCES tag to YES will include the body 
   404 # of functions and classes directly in the documentation.
   449 # of functions and classes directly in the documentation.
   405 
   450 
   406 INLINE_SOURCES         = NO
   451 INLINE_SOURCES         = NO
       
   452 
       
   453 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
       
   454 # doxygen to hide any special comment blocks from generated source code 
       
   455 # fragments. Normal C and C++ comments will always remain visible.
       
   456 
       
   457 STRIP_CODE_COMMENTS    = YES
   407 
   458 
   408 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
   459 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
   409 # then for each documented function all documented 
   460 # then for each documented function all documented 
   410 # functions referencing it will be listed.
   461 # functions referencing it will be listed.
   411 
   462 
   414 # If the REFERENCES_RELATION tag is set to YES (the default) 
   465 # If the REFERENCES_RELATION tag is set to YES (the default) 
   415 # then for each documented function all documented entities 
   466 # then for each documented function all documented entities 
   416 # called/used by that function will be listed.
   467 # called/used by that function will be listed.
   417 
   468 
   418 REFERENCES_RELATION    = YES
   469 REFERENCES_RELATION    = YES
       
   470 
       
   471 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
       
   472 # will generate a verbatim copy of the header file for each class for 
       
   473 # which an include is specified. Set to NO to disable this.
       
   474 
       
   475 VERBATIM_HEADERS       = YES
   419 
   476 
   420 #---------------------------------------------------------------------------
   477 #---------------------------------------------------------------------------
   421 # configuration options related to the alphabetical class index
   478 # configuration options related to the alphabetical class index
   422 #---------------------------------------------------------------------------
   479 #---------------------------------------------------------------------------
   423 
   480 
   436 # In case all classes in a project start with a common prefix, all 
   493 # In case all classes in a project start with a common prefix, all 
   437 # classes will be put under the same header in the alphabetical index. 
   494 # classes will be put under the same header in the alphabetical index. 
   438 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
   495 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
   439 # should be ignored while generating the index headers.
   496 # should be ignored while generating the index headers.
   440 
   497 
   441 IGNORE_PREFIX          =
   498 IGNORE_PREFIX          = 
   442 
   499 
   443 #---------------------------------------------------------------------------
   500 #---------------------------------------------------------------------------
   444 # configuration options related to the HTML output
   501 # configuration options related to the HTML output
   445 #---------------------------------------------------------------------------
   502 #---------------------------------------------------------------------------
   446 
   503 
   471 # each generated HTML page. If it is left blank doxygen will generate a 
   528 # each generated HTML page. If it is left blank doxygen will generate a 
   472 # standard footer.
   529 # standard footer.
   473 
   530 
   474 HTML_FOOTER            = 
   531 HTML_FOOTER            = 
   475 
   532 
   476 # The HTML_STYLESHEET tag can be used to specify a user defined cascading 
   533 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
   477 # style sheet that is used by each HTML page. It can be used to 
   534 # style sheet that is used by each HTML page. It can be used to 
   478 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
   535 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
   479 # will generate a default style sheet
   536 # will generate a default style sheet
   480 
   537 
   481 HTML_STYLESHEET        = 
   538 HTML_STYLESHEET        = 
   491 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
   548 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
   492 # of the generated HTML documentation.
   549 # of the generated HTML documentation.
   493 
   550 
   494 GENERATE_HTMLHELP      = NO
   551 GENERATE_HTMLHELP      = NO
   495 
   552 
       
   553 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
       
   554 # be used to specify the file name of the resulting .chm file. You 
       
   555 # can add a path in front of the file if the result should not be 
       
   556 # written to the html output dir.
       
   557 
       
   558 CHM_FILE               = 
       
   559 
       
   560 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
       
   561 # be used to specify the location (absolute path including file name) of 
       
   562 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
       
   563 # the HTML help compiler on the generated index.hhp.
       
   564 
       
   565 HHC_LOCATION           = 
       
   566 
   496 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
   567 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
   497 # controls if a separate .chi index file is generated (YES) or that 
   568 # controls if a separate .chi index file is generated (YES) or that 
   498 # it should be included in the master .chm file (NO).
   569 # it should be included in the master .chm file (NO).
   499 
   570 
   500 GENERATE_CHI           = NO
   571 GENERATE_CHI           = NO
   504 # normal table of contents (NO) in the .chm file.
   575 # normal table of contents (NO) in the .chm file.
   505 
   576 
   506 BINARY_TOC             = NO
   577 BINARY_TOC             = NO
   507 
   578 
   508 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
   579 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
   509 # to the contents of the Html help documentation and to the tree view.
   580 # to the contents of the HTML help documentation and to the tree view.
   510 
   581 
   511 TOC_EXPAND             = NO
   582 TOC_EXPAND             = NO
   512 
   583 
   513 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
   584 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
   514 # top of each HTML page. The value NO (the default) enables the index and 
   585 # top of each HTML page. The value NO (the default) enables the index and 
   522 ENUM_VALUES_PER_LINE   = 4
   593 ENUM_VALUES_PER_LINE   = 4
   523 
   594 
   524 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
   595 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
   525 # generated containing a tree-like index structure (just like the one that 
   596 # generated containing a tree-like index structure (just like the one that 
   526 # is generated for HTML Help). For this to work a browser that supports 
   597 # is generated for HTML Help). For this to work a browser that supports 
   527 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, 
   598 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
   528 # or Internet explorer 4.0+). Note that for large projects the tree generation 
   599 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
   529 # can take a very long time. In such cases it is better to disable this feature. 
   600 # probably better off using the HTML help feature.
   530 # Windows users are probably better off using the HTML help feature.
       
   531 
   601 
   532 GENERATE_TREEVIEW      = NO
   602 GENERATE_TREEVIEW      = NO
   533 
   603 
   534 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
   604 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
   535 # used to set the initial width (in pixels) of the frame in which the tree 
   605 # used to set the initial width (in pixels) of the frame in which the tree 
   550 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
   620 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
   551 # put in front of it. If left blank `latex' will be used as the default path.
   621 # put in front of it. If left blank `latex' will be used as the default path.
   552 
   622 
   553 LATEX_OUTPUT           = latex
   623 LATEX_OUTPUT           = latex
   554 
   624 
   555 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
   625 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
       
   626 # invoked. If left blank `latex' will be used as the default command name.
   556 
   627 
   557 LATEX_CMD_NAME         = latex
   628 LATEX_CMD_NAME         = latex
   558 
   629 
   559 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
   630 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
   560 # generate index for LaTeX. If left blank `makeindex' will be used as the 
   631 # generate index for LaTeX. If left blank `makeindex' will be used as the 
   603 # command to the generated LaTeX files. This will instruct LaTeX to keep 
   674 # command to the generated LaTeX files. This will instruct LaTeX to keep 
   604 # running if errors occur, instead of asking the user for help. 
   675 # running if errors occur, instead of asking the user for help. 
   605 # This option is also used when generating formulas in HTML.
   676 # This option is also used when generating formulas in HTML.
   606 
   677 
   607 LATEX_BATCHMODE        = NO
   678 LATEX_BATCHMODE        = NO
       
   679 
       
   680 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
       
   681 # include the index chapters (such as File Index, Compound Index, etc.) 
       
   682 # in the output.
       
   683 
       
   684 LATEX_HIDE_INDICES     = NO
   608 
   685 
   609 #---------------------------------------------------------------------------
   686 #---------------------------------------------------------------------------
   610 # configuration options related to the RTF output
   687 # configuration options related to the RTF output
   611 #---------------------------------------------------------------------------
   688 #---------------------------------------------------------------------------
   612 
   689 
   686 # feature is still experimental and incomplete at the 
   763 # feature is still experimental and incomplete at the 
   687 # moment.
   764 # moment.
   688 
   765 
   689 GENERATE_XML           = NO
   766 GENERATE_XML           = NO
   690 
   767 
       
   768 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
       
   769 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
       
   770 # put in front of it. If left blank `xml' will be used as the default path.
       
   771 
       
   772 XML_OUTPUT             = xml
       
   773 
       
   774 # The XML_SCHEMA tag can be used to specify an XML schema, 
       
   775 # which can be used by a validating XML parser to check the 
       
   776 # syntax of the XML files.
       
   777 
       
   778 XML_SCHEMA             = 
       
   779 
       
   780 # The XML_DTD tag can be used to specify an XML DTD, 
       
   781 # which can be used by a validating XML parser to check the 
       
   782 # syntax of the XML files.
       
   783 
       
   784 XML_DTD                = 
       
   785 
   691 #---------------------------------------------------------------------------
   786 #---------------------------------------------------------------------------
   692 # configuration options for the AutoGen Definitions output
   787 # configuration options for the AutoGen Definitions output
   693 #---------------------------------------------------------------------------
   788 #---------------------------------------------------------------------------
   694 
   789 
   695 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
   790 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
   699 # and incomplete at the moment.
   794 # and incomplete at the moment.
   700 
   795 
   701 GENERATE_AUTOGEN_DEF   = NO
   796 GENERATE_AUTOGEN_DEF   = NO
   702 
   797 
   703 #---------------------------------------------------------------------------
   798 #---------------------------------------------------------------------------
       
   799 # configuration options related to the Perl module output
       
   800 #---------------------------------------------------------------------------
       
   801 
       
   802 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
       
   803 # generate a Perl module file that captures the structure of 
       
   804 # the code including all documentation. Note that this 
       
   805 # feature is still experimental and incomplete at the 
       
   806 # moment.
       
   807 
       
   808 GENERATE_PERLMOD       = NO
       
   809 
       
   810 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
       
   811 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
       
   812 # to generate PDF and DVI output from the Perl module output.
       
   813 
       
   814 PERLMOD_LATEX          = NO
       
   815 
       
   816 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
       
   817 # nicely formatted so it can be parsed by a human reader.  This is useful 
       
   818 # if you want to understand what is going on.  On the other hand, if this 
       
   819 # tag is set to NO the size of the Perl module output will be much smaller 
       
   820 # and Perl will parse it just the same.
       
   821 
       
   822 PERLMOD_PRETTY         = YES
       
   823 
       
   824 # The names of the make variables in the generated doxyrules.make file 
       
   825 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
       
   826 # This is useful so different doxyrules.make files included by the same 
       
   827 # Makefile don't overwrite each other's variables.
       
   828 
       
   829 PERLMOD_MAKEVAR_PREFIX = 
       
   830 
       
   831 #---------------------------------------------------------------------------
   704 # Configuration options related to the preprocessor   
   832 # Configuration options related to the preprocessor   
   705 #---------------------------------------------------------------------------
   833 #---------------------------------------------------------------------------
   706 
   834 
   707 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
   835 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
   708 # evaluate all C-preprocessor directives found in the sources and include 
   836 # evaluate all C-preprocessor directives found in the sources and include 
   745 # are defined before the preprocessor is started (similar to the -D option of 
   873 # are defined before the preprocessor is started (similar to the -D option of 
   746 # gcc). The argument of the tag is a list of macros of the form: name 
   874 # gcc). The argument of the tag is a list of macros of the form: name 
   747 # or name=definition (no spaces). If the definition and the = are 
   875 # or name=definition (no spaces). If the definition and the = are 
   748 # omitted =1 is assumed.
   876 # omitted =1 is assumed.
   749 
   877 
   750 PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 __EXPORT__=
   878 PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 \
   751 
   879                          __EXPORT__=
   752 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
   880 
       
   881 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
   753 # this tag can be used to specify a list of macro names that should be expanded. 
   882 # this tag can be used to specify a list of macro names that should be expanded. 
   754 # The macro definition that is found in the sources will be used. 
   883 # The macro definition that is found in the sources will be used. 
   755 # Use the PREDEFINED tag if you want to use a different macro definition.
   884 # Use the PREDEFINED tag if you want to use a different macro definition.
   756 
   885 
   757 EXPAND_AS_DEFINED      = 
   886 EXPAND_AS_DEFINED      = 
   758 
   887 
   759 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
   888 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
   760 # doxygen's preprocessor will remove all function-like macros that are alone 
   889 # doxygen's preprocessor will remove all function-like macros that are alone 
   761 # on a line and do not end with a semicolon. Such function macros are typically 
   890 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
   762 # used for boiler-plate code, and will confuse the parser if not removed.
   891 # function macros are typically used for boiler-plate code, and will confuse the 
       
   892 # parser if not removed.
   763 
   893 
   764 SKIP_FUNCTION_MACROS   = YES
   894 SKIP_FUNCTION_MACROS   = YES
   765 
   895 
   766 #---------------------------------------------------------------------------
   896 #---------------------------------------------------------------------------
   767 # Configuration::addtions related to external references   
   897 # Configuration::addtions related to external references   
   768 #---------------------------------------------------------------------------
   898 #---------------------------------------------------------------------------
   769 
   899 
   770 # The TAGFILES tag can be used to specify one or more tagfiles.
   900 # The TAGFILES option can be used to specify one or more tagfiles. 
       
   901 # Optionally an initial location of the external documentation 
       
   902 # can be added for each tagfile. The format of a tag file without 
       
   903 # this location is as follows: 
       
   904 #   TAGFILES = file1 file2 ... 
       
   905 # Adding location for the tag files is done as follows: 
       
   906 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
       
   907 # where "loc1" and "loc2" can be relative or absolute paths or 
       
   908 # URLs. If a location is present for each tag, the installdox tool 
       
   909 # does not have to be run to correct the links.
       
   910 # Note that each tag file must have a unique name
       
   911 # (where the name does NOT include the path)
       
   912 # If a tag file is not located in the directory in which doxygen 
       
   913 # is run, you must also specify the path to the tagfile here.
   771 
   914 
   772 TAGFILES               = 
   915 TAGFILES               = 
   773 
   916 
   774 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
   917 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
   775 # a tag file that is based on the input files it reads.
   918 # a tag file that is based on the input files it reads.
   796 #---------------------------------------------------------------------------
   939 #---------------------------------------------------------------------------
   797 # Configuration options related to the dot tool   
   940 # Configuration options related to the dot tool   
   798 #---------------------------------------------------------------------------
   941 #---------------------------------------------------------------------------
   799 
   942 
   800 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
   943 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
   801 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 
   944 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 
   802 # super classes. Setting the tag to NO turns the diagrams off. Note that this 
   945 # super classes. Setting the tag to NO turns the diagrams off. Note that this 
   803 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
   946 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
   804 # recommended to install and use dot, since it yields more powerful graphs.
   947 # recommended to install and use dot, since it yields more powerful graphs.
   805 
   948 
   806 CLASS_DIAGRAMS         = NO
   949 CLASS_DIAGRAMS         = NO
   830 # indirect implementation dependencies (inheritance, containment, and 
   973 # indirect implementation dependencies (inheritance, containment, and 
   831 # class references variables) of the class with other documented classes.
   974 # class references variables) of the class with other documented classes.
   832 
   975 
   833 COLLABORATION_GRAPH    = NO
   976 COLLABORATION_GRAPH    = NO
   834 
   977 
       
   978 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
       
   979 # collaboration diagrams in a style similiar to the OMG's Unified Modeling 
       
   980 # Language.
       
   981 
       
   982 UML_LOOK               = NO
       
   983 
   835 # If set to YES, the inheritance and collaboration graphs will show the 
   984 # If set to YES, the inheritance and collaboration graphs will show the 
   836 # relations between templates and their instances.
   985 # relations between templates and their instances.
   837 
   986 
   838 TEMPLATE_RELATIONS     = NO
   987 TEMPLATE_RELATIONS     = NO
   839 
   988 
   848 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
   997 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
   849 # documented header file showing the documented files that directly or 
   998 # documented header file showing the documented files that directly or 
   850 # indirectly include this file.
   999 # indirectly include this file.
   851 
  1000 
   852 INCLUDED_BY_GRAPH      = YES
  1001 INCLUDED_BY_GRAPH      = YES
       
  1002 
       
  1003 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
       
  1004 # generate a call dependency graph for every global function or class method. 
       
  1005 # Note that enabling this option will significantly increase the time of a run. 
       
  1006 # So in most cases it will be better to enable call graphs for selected 
       
  1007 # functions only using the \callgraph command.
       
  1008 
       
  1009 CALL_GRAPH             = NO
   853 
  1010 
   854 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
  1011 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
   855 # will graphical hierarchy of all classes instead of a textual one.
  1012 # will graphical hierarchy of all classes instead of a textual one.
   856 
  1013 
   857 GRAPHICAL_HIERARCHY    = YES
  1014 GRAPHICAL_HIERARCHY    = YES
   887 # the specified constraint. Beware that most browsers cannot cope with very 
  1044 # the specified constraint. Beware that most browsers cannot cope with very 
   888 # large images.
  1045 # large images.
   889 
  1046 
   890 MAX_DOT_GRAPH_HEIGHT   = 1024
  1047 MAX_DOT_GRAPH_HEIGHT   = 1024
   891 
  1048 
       
  1049 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
       
  1050 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
       
  1051 # from the root by following a path via at most 3 edges will be shown. Nodes that 
       
  1052 # lay further from the root node will be omitted. Note that setting this option to 
       
  1053 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
       
  1054 # note that a graph may be further truncated if the graph's image dimensions are 
       
  1055 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
       
  1056 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
       
  1057 
       
  1058 MAX_DOT_GRAPH_DEPTH    = 0
       
  1059 
   892 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
  1060 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
   893 # generate a legend page explaining the meaning of the various boxes and 
  1061 # generate a legend page explaining the meaning of the various boxes and 
   894 # arrows in the dot generated graphs.
  1062 # arrows in the dot generated graphs.
   895 
  1063 
   896 GENERATE_LEGEND        = YES
  1064 GENERATE_LEGEND        = YES
   897 
  1065 
   898 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
  1066 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
   899 # remove the intermedate dot files that are used to generate 
  1067 # remove the intermediate dot files that are used to generate 
   900 # the various graphs.
  1068 # the various graphs.
   901 
  1069 
   902 DOT_CLEANUP            = YES
  1070 DOT_CLEANUP            = YES
   903 
  1071 
   904 #---------------------------------------------------------------------------
  1072 #---------------------------------------------------------------------------
   907 
  1075 
   908 # The SEARCHENGINE tag specifies whether or not a search engine should be 
  1076 # The SEARCHENGINE tag specifies whether or not a search engine should be 
   909 # used. If set to NO the values of all tags below this one will be ignored.
  1077 # used. If set to NO the values of all tags below this one will be ignored.
   910 
  1078 
   911 SEARCHENGINE           = NO
  1079 SEARCHENGINE           = NO
   912 
       
   913 # The CGI_NAME tag should be the name of the CGI script that 
       
   914 # starts the search engine (doxysearch) with the correct parameters. 
       
   915 # A script with this name will be generated by doxygen.
       
   916 
       
   917 CGI_NAME               = search.cgi
       
   918 
       
   919 # The CGI_URL tag should be the absolute URL to the directory where the 
       
   920 # cgi binaries are located. See the documentation of your http daemon for 
       
   921 # details.
       
   922 
       
   923 CGI_URL                = 
       
   924 
       
   925 # The DOC_URL tag should be the absolute URL to the directory where the 
       
   926 # documentation is located. If left blank the absolute path to the 
       
   927 # documentation, with file:// prepended to it, will be used.
       
   928 
       
   929 DOC_URL                = 
       
   930 
       
   931 # The DOC_ABSPATH tag should be the absolute path to the directory where the 
       
   932 # documentation is located. If left blank the directory on the local machine 
       
   933 # will be used.
       
   934 
       
   935 DOC_ABSPATH            = 
       
   936 
       
   937 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
       
   938 # is installed.
       
   939 
       
   940 BIN_ABSPATH            = /usr/local/bin/
       
   941 
       
   942 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
       
   943 # documentation generated for other projects. This allows doxysearch to search 
       
   944 # the documentation for these projects as well.
       
   945 
       
   946 EXT_DOC_PATHS          =