| 1 |
# Doxyfile 1.2.4 |
|---|
| 2 |
|
|---|
| 3 |
# This file describes the settings to be used by doxygen for a project |
|---|
| 4 |
# |
|---|
| 5 |
# All text after a hash (#) is considered a comment and will be ignored |
|---|
| 6 |
# The format is: |
|---|
| 7 |
# TAG = value [value, ...] |
|---|
| 8 |
# For lists items can also be appended using: |
|---|
| 9 |
# TAG += value [value, ...] |
|---|
| 10 |
# Values that contain spaces should be placed between quotes (" ") |
|---|
| 11 |
|
|---|
| 12 |
#--------------------------------------------------------------------------- |
|---|
| 13 |
# General configuration options |
|---|
| 14 |
#--------------------------------------------------------------------------- |
|---|
| 15 |
|
|---|
| 16 |
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
|---|
| 17 |
# by quotes) that should identify the project. |
|---|
| 18 |
|
|---|
| 19 |
PROJECT_NAME = "Gadgeteer" |
|---|
| 20 |
|
|---|
| 21 |
# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
|---|
| 22 |
# This could be handy for archiving the generated documentation or |
|---|
| 23 |
# if some version control system is used. |
|---|
| 24 |
|
|---|
| 25 |
@INCLUDE = version.mk |
|---|
| 26 |
|
|---|
| 27 |
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
|---|
| 28 |
# base path where the generated documentation will be put. |
|---|
| 29 |
# If a relative path is entered, it will be relative to the location |
|---|
| 30 |
# where doxygen was started. If left blank the current directory will be used. |
|---|
| 31 |
|
|---|
| 32 |
OUTPUT_DIRECTORY = |
|---|
| 33 |
|
|---|
| 34 |
# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
|---|
| 35 |
# documentation generated by doxygen is written. Doxygen will use this |
|---|
| 36 |
# information to generate all constant output in the proper language. |
|---|
| 37 |
# The default language is English, other supported languages are: |
|---|
| 38 |
# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, |
|---|
| 39 |
# Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian, |
|---|
| 40 |
# Polish, Portuguese and Slovene. |
|---|
| 41 |
|
|---|
| 42 |
OUTPUT_LANGUAGE = English |
|---|
| 43 |
|
|---|
| 44 |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
|---|
| 45 |
# documentation are documented, even if no documentation was available. |
|---|
| 46 |
# Private class members and static file members will be hidden unless |
|---|
| 47 |
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
|---|
| 48 |
|
|---|
| 49 |
EXTRACT_ALL = YES |
|---|
| 50 |
|
|---|
| 51 |
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
|---|
| 52 |
# will be included in the documentation. |
|---|
| 53 |
|
|---|
| 54 |
EXTRACT_PRIVATE = NO |
|---|
| 55 |
|
|---|
| 56 |
# If the EXTRACT_STATIC tag is set to YES all static members of a file |
|---|
| 57 |
# will be included in the documentation. |
|---|
| 58 |
|
|---|
| 59 |
EXTRACT_STATIC = YES |
|---|
| 60 |
|
|---|
| 61 |
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
|---|
| 62 |
# undocumented members of documented classes, files or namespaces. |
|---|
| 63 |
# If set to NO (the default) these members will be included in the |
|---|
| 64 |
# various overviews, but no documentation section is generated. |
|---|
| 65 |
# This option has no effect if EXTRACT_ALL is enabled. |
|---|
| 66 |
|
|---|
| 67 |
HIDE_UNDOC_MEMBERS = NO |
|---|
| 68 |
|
|---|
| 69 |
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
|---|
| 70 |
# undocumented classes that are normally visible in the class hierarchy. |
|---|
| 71 |
# If set to NO (the default) these class will be included in the various |
|---|
| 72 |
# overviews. This option has no effect if EXTRACT_ALL is enabled. |
|---|
| 73 |
|
|---|
| 74 |
HIDE_UNDOC_CLASSES = NO |
|---|
| 75 |
|
|---|
| 76 |
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
|---|
| 77 |
# include brief member descriptions after the members that are listed in |
|---|
| 78 |
# the file and class documentation (similar to JavaDoc). |
|---|
| 79 |
# Set to NO to disable this. |
|---|
| 80 |
|
|---|
| 81 |
BRIEF_MEMBER_DESC = YES |
|---|
| 82 |
|
|---|
| 83 |
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
|---|
| 84 |
# the brief description of a member or function before the detailed description. |
|---|
| 85 |
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
|---|
| 86 |
# brief descriptions will be completely suppressed. |
|---|
| 87 |
|
|---|
| 88 |
REPEAT_BRIEF = YES |
|---|
| 89 |
|
|---|
| 90 |
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
|---|
| 91 |
# Doxygen will generate a detailed section even if there is only a brief |
|---|
| 92 |
# description. |
|---|
| 93 |
|
|---|
| 94 |
ALWAYS_DETAILED_SEC = YES |
|---|
| 95 |
|
|---|
| 96 |
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
|---|
| 97 |
# path before files name in the file list and in the header files. If set |
|---|
| 98 |
# to NO the shortest path that makes the file name unique will be used. |
|---|
| 99 |
|
|---|
| 100 |
FULL_PATH_NAMES = NO |
|---|
| 101 |
|
|---|
| 102 |
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
|---|
| 103 |
# can be used to strip a user defined part of the path. Stripping is |
|---|
| 104 |
# only done if one of the specified strings matches the left-hand part of |
|---|
| 105 |
# the path. It is allowed to use relative paths in the argument list. |
|---|
| 106 |
|
|---|
| 107 |
STRIP_FROM_PATH = |
|---|
| 108 |
|
|---|
| 109 |
# The INTERNAL_DOCS tag determines if documentation |
|---|
| 110 |
# that is typed after a \internal command is included. If the tag is set |
|---|
| 111 |
# to NO (the default) then the documentation will be excluded. |
|---|
| 112 |
# Set it to YES to include the internal documentation. |
|---|
| 113 |
|
|---|
| 114 |
INTERNAL_DOCS = NO |
|---|
| 115 |
|
|---|
| 116 |
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
|---|
| 117 |
# generate a class diagram (in Html and LaTeX) for classes with base or |
|---|
| 118 |
# super classes. Setting the tag to NO turns the diagrams off. |
|---|
| 119 |
|
|---|
| 120 |
CLASS_DIAGRAMS = YES |
|---|
| 121 |
|
|---|
| 122 |
# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
|---|
| 123 |
# be generated. Documented entities will be cross-referenced with these |
|---|
| 124 |
# sources. |
|---|
| 125 |
|
|---|
| 126 |
SOURCE_BROWSER = YES |
|---|
| 127 |
|
|---|
| 128 |
# Setting the INLINE_SOURCES tag to YES will include the body |
|---|
| 129 |
# of functions and classes directly in the documentation. |
|---|
| 130 |
|
|---|
| 131 |
INLINE_SOURCES = YES |
|---|
| 132 |
|
|---|
| 133 |
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
|---|
| 134 |
# doxygen to hide any special comment blocks from generated source code |
|---|
| 135 |
# fragments. Normal C and C++ comments will always remain visible. |
|---|
| 136 |
|
|---|
| 137 |
STRIP_CODE_COMMENTS = YES |
|---|
| 138 |
|
|---|
| 139 |
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
|---|
| 140 |
# file names in lower case letters. If set to YES upper case letters are also |
|---|
| 141 |
# allowed. This is useful if you have classes or files whose names only differ |
|---|
| 142 |
# in case and if your file system supports case sensitive file names. Windows |
|---|
| 143 |
# users are adviced to set this option to NO. |
|---|
| 144 |
|
|---|
| 145 |
CASE_SENSE_NAMES = YES |
|---|
| 146 |
|
|---|
| 147 |
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
|---|
| 148 |
# will show members with their full class and namespace scopes in the |
|---|
| 149 |
# documentation. If set to YES the scope will be hidden. |
|---|
| 150 |
|
|---|
| 151 |
HIDE_SCOPE_NAMES = NO |
|---|
| 152 |
|
|---|
| 153 |
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
|---|
| 154 |
# will generate a verbatim copy of the header file for each class for |
|---|
| 155 |
# which an include is specified. Set to NO to disable this. |
|---|
| 156 |
|
|---|
| 157 |
VERBATIM_HEADERS = YES |
|---|
| 158 |
|
|---|
| 159 |
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
|---|
| 160 |
# will put list of the files that are included by a file in the documentation |
|---|
| 161 |
# of that file. |
|---|
| 162 |
|
|---|
| 163 |
SHOW_INCLUDE_FILES = YES |
|---|
| 164 |
|
|---|
| 165 |
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
|---|
| 166 |
# will interpret the first line (until the first dot) of a JavaDoc-style |
|---|
| 167 |
# comment as the brief description. If set to NO, the JavaDoc |
|---|
| 168 |
# comments will behave just like the Qt-style comments (thus requiring an |
|---|
| 169 |
# explict @brief command for a brief description. |
|---|
| 170 |
|
|---|
| 171 |
JAVADOC_AUTOBRIEF = YES |
|---|
| 172 |
|
|---|
| 173 |
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
|---|
| 174 |
# member inherits the documentation from any documented member that it |
|---|
| 175 |
# reimplements. |
|---|
| 176 |
|
|---|
| 177 |
INHERIT_DOCS = YES |
|---|
| 178 |
|
|---|
| 179 |
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
|---|
| 180 |
# is inserted in the documentation for inline members. |
|---|
| 181 |
|
|---|
| 182 |
INLINE_INFO = YES |
|---|
| 183 |
|
|---|
| 184 |
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
|---|
| 185 |
# will sort the (detailed) documentation of file and class members |
|---|
| 186 |
# alphabetically by member name. If set to NO the members will appear in |
|---|
| 187 |
# declaration order. |
|---|
| 188 |
|
|---|
| 189 |
SORT_MEMBER_DOCS = NO |
|---|
| 190 |
|
|---|
| 191 |
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
|---|
| 192 |
# tag is set to YES, then doxygen will reuse the documentation of the first |
|---|
| 193 |
# member in the group (if any) for the other members of the group. By default |
|---|
| 194 |
# all members of a group must be documented explicitly. |
|---|
| 195 |
|
|---|
| 196 |
DISTRIBUTE_GROUP_DOC = NO |
|---|
| 197 |
|
|---|
| 198 |
# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
|---|
| 199 |
# Doxygen uses this value to replace tabs by spaces in code fragments. |
|---|
| 200 |
|
|---|
| 201 |
TAB_SIZE = 3 |
|---|
| 202 |
|
|---|
| 203 |
# The ENABLE_SECTIONS tag can be used to enable conditional |
|---|
| 204 |
# documentation sections, marked by \if sectionname ... \endif. |
|---|
| 205 |
|
|---|
| 206 |
ENABLED_SECTIONS = |
|---|
| 207 |
|
|---|
| 208 |
# The GENERATE_TODOLIST tag can be used to enable (YES) or |
|---|
| 209 |
# disable (NO) the todo list. This list is created by putting \todo |
|---|
| 210 |
# commands in the documentation. |
|---|
| 211 |
|
|---|
| 212 |
GENERATE_TODOLIST = YES |
|---|
| 213 |
|
|---|
| 214 |
# The GENERATE_TESTLIST tag can be used to enable (YES) or |
|---|
| 215 |
# disable (NO) the test list. This list is created by putting \test |
|---|
| 216 |
# commands in the documentation. |
|---|
| 217 |
|
|---|
| 218 |
GENERATE_TESTLIST = YES |
|---|
| 219 |
|
|---|
| 220 |
# This tag can be used to specify a number of aliases that acts |
|---|
| 221 |
# as commands in the documentation. An alias has the form "name=value". |
|---|
| 222 |
# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
|---|
| 223 |
# put the command \sideeffect (or @sideeffect) in the documentation, which |
|---|
| 224 |
# will result in a user defined paragraph with heading "Side Effects:". |
|---|
| 225 |
# You can put \n's in the value part of an alias to insert newlines. |
|---|
| 226 |
|
|---|
| 227 |
ALIASES = |
|---|
| 228 |
|
|---|
| 229 |
#--------------------------------------------------------------------------- |
|---|
| 230 |
# configuration options related to warning and progress messages |
|---|
| 231 |
#--------------------------------------------------------------------------- |
|---|
| 232 |
|
|---|
| 233 |
# The QUIET tag can be used to turn on/off the messages that are generated |
|---|
| 234 |
# by doxygen. Possible values are YES and NO. If left blank NO is used. |
|---|
| 235 |
|
|---|
| 236 |
QUIET = NO |
|---|
| 237 |
|
|---|
| 238 |
# The WARNINGS tag can be used to turn on/off the warning messages that are |
|---|
| 239 |
# generated by doxygen. Possible values are YES and NO. If left blank |
|---|
| 240 |
# NO is used. |
|---|
| 241 |
|
|---|
| 242 |
WARNINGS = YES |
|---|
| 243 |
|
|---|
| 244 |
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
|---|
| 245 |
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
|---|
| 246 |
# automatically be disabled. |
|---|
| 247 |
|
|---|
| 248 |
WARN_IF_UNDOCUMENTED = YES |
|---|
| 249 |
|
|---|
| 250 |
# The WARN_FORMAT tag determines the format of the warning messages that |
|---|
| 251 |
# doxygen can produce. The string should contain the $file, $line, and $text |
|---|
| 252 |
# tags, which will be replaced by the file and line number from which the |
|---|
| 253 |
# warning originated and the warning text. |
|---|
| 254 |
|
|---|
| 255 |
WARN_FORMAT = "$file:$line: $text" |
|---|
| 256 |
|
|---|
| 257 |
# The WARN_LOGFILE tag can be used to specify a file to which warning |
|---|
| 258 |
# and error messages should be written. If left blank the output is written |
|---|
| 259 |
# to stderr. |
|---|
| 260 |
|
|---|
| 261 |
WARN_LOGFILE = |
|---|
| 262 |
|
|---|
| 263 |
#--------------------------------------------------------------------------- |
|---|
| 264 |
# configuration options related to the input files |
|---|
| 265 |
#--------------------------------------------------------------------------- |
|---|
| 266 |
|
|---|
| 267 |
# The INPUT tag can be used to specify the files and/or directories that contain |
|---|
| 268 |
# documented source files. You may enter file names like "myfile.cpp" or |
|---|
| 269 |
# directories like "/usr/src/myproject". Separate the files or directories |
|---|
| 270 |
# with spaces. |
|---|
| 271 |
|
|---|
| 272 |
INPUT = ../gadget ../cluster ../plugins mainpage.doxy |
|---|
| 273 |
|
|---|
| 274 |
# If the value of the INPUT tag contains directories, you can use the |
|---|
| 275 |
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
|---|
| 276 |
# and *.h) to filter out the source-files in the directories. If left |
|---|
| 277 |
# blank all files are included. |
|---|
| 278 |
|
|---|
| 279 |
FILE_PATTERNS = *.h *.cpp *.mm |
|---|
| 280 |
|
|---|
| 281 |
# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
|---|
| 282 |
# should be searched for input files as well. Possible values are YES and NO. |
|---|
| 283 |
# If left blank NO is used. |
|---|
| 284 |
|
|---|
| 285 |
RECURSIVE = YES |
|---|
| 286 |
|
|---|
| 287 |
# The EXCLUDE tag can be used to specify files and/or directories that should |
|---|
| 288 |
# excluded from the INPUT source files. This way you can easily exclude a |
|---|
| 289 |
# subdirectory from a directory tree whose root is specified with the INPUT tag. |
|---|
| 290 |
EXCLUDE = Makefile.in .svn |
|---|
| 291 |
|
|---|
| 292 |
# If the value of the INPUT tag contains directories, you can use the |
|---|
| 293 |
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
|---|
| 294 |
# certain files from those directories. |
|---|
| 295 |
|
|---|
| 296 |
EXCLUDE_PATTERNS = *.in Entries Root Repository |
|---|
| 297 |
|
|---|
| 298 |
# The EXAMPLE_PATH tag can be used to specify one or more files or |
|---|
| 299 |
# directories that contain example code fragments that are included (see |
|---|
| 300 |
# the \include command). |
|---|
| 301 |
|
|---|
| 302 |
EXAMPLE_PATH = |
|---|
| 303 |
|
|---|
| 304 |
# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
|---|
| 305 |
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
|---|
| 306 |
# and *.h) to filter out the source-files in the directories. If left |
|---|
| 307 |
# blank all files are included. |
|---|
| 308 |
|
|---|
| 309 |
EXAMPLE_PATTERNS = |
|---|
| 310 |
|
|---|
| 311 |
# The IMAGE_PATH tag can be used to specify one or more files or |
|---|
| 312 |
# directories that contain image that are included in the documentation (see |
|---|
| 313 |
# the \image command). |
|---|
| 314 |
|
|---|
| 315 |
IMAGE_PATH = |
|---|
| 316 |
|
|---|
| 317 |
# The INPUT_FILTER tag can be used to specify a program that doxygen should |
|---|
| 318 |
# invoke to filter for each input file. Doxygen will invoke the filter program |
|---|
| 319 |
# by executing (via popen()) the command <filter> <input-file>, where <filter> |
|---|
| 320 |
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
|---|
| 321 |
# input file. Doxygen will then use the output that the filter program writes |
|---|
| 322 |
# to standard output. |
|---|
| 323 |
|
|---|
| 324 |
INPUT_FILTER = |
|---|
| 325 |
|
|---|
| 326 |
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
|---|
| 327 |
# INPUT_FILTER) will be used to filter the input files when producing source |
|---|
| 328 |
# files to browse. |
|---|
| 329 |
|
|---|
| 330 |
FILTER_SOURCE_FILES = NO |
|---|
| 331 |
|
|---|
| 332 |
#--------------------------------------------------------------------------- |
|---|
| 333 |
# configuration options related to the alphabetical class index |
|---|
| 334 |
#--------------------------------------------------------------------------- |
|---|
| 335 |
|
|---|
| 336 |
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
|---|
| 337 |
# of all compounds will be generated. Enable this if the project |
|---|
| 338 |
# contains a lot of classes, structs, unions or interfaces. |
|---|
| 339 |
|
|---|
| 340 |
ALPHABETICAL_INDEX = YES |
|---|
| 341 |
|
|---|
| 342 |
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
|---|
| 343 |
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
|---|
| 344 |
# in which this list will be split (can be a number in the range [1..20]) |
|---|
| 345 |
|
|---|
| 346 |
COLS_IN_ALPHA_INDEX = 3 |
|---|
| 347 |
|
|---|
| 348 |
# In case all classes in a project start with a common prefix, all |
|---|
| 349 |
# classes will be put under the same header in the alphabetical index. |
|---|
| 350 |
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
|---|
| 351 |
# should be ignored while generating the index headers. |
|---|
| 352 |
|
|---|
| 353 |
IGNORE_PREFIX = |
|---|
| 354 |
|
|---|
| 355 |
#--------------------------------------------------------------------------- |
|---|
| 356 |
# configuration options related to the HTML output |
|---|
| 357 |
#--------------------------------------------------------------------------- |
|---|
| 358 |
|
|---|
| 359 |
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
|---|
| 360 |
# generate HTML output. |
|---|
| 361 |
|
|---|
| 362 |
GENERATE_HTML = YES |
|---|
| 363 |
|
|---|
| 364 |
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
|---|
| 365 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|---|
| 366 |
# put in front of it. If left blank `html' will be used as the default path. |
|---|
| 367 |
|
|---|
| 368 |
HTML_OUTPUT = html |
|---|
| 369 |
|
|---|
| 370 |
# The HTML_HEADER tag can be used to specify a personal HTML header for |
|---|
| 371 |
# each generated HTML page. If it is left blank doxygen will generate a |
|---|
| 372 |
# standard header. |
|---|
| 373 |
|
|---|
| 374 |
HTML_HEADER = |
|---|
| 375 |
|
|---|
| 376 |
# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
|---|
| 377 |
# each generated HTML page. If it is left blank doxygen will generate a |
|---|
| 378 |
# standard footer. |
|---|
| 379 |
|
|---|
| 380 |
HTML_FOOTER = |
|---|
| 381 |
|
|---|
| 382 |
# The HTML_STYLESHEET tag can be used to specify a user defined cascading |
|---|
| 383 |
# style sheet that is used by each HTML page. It can be used to |
|---|
| 384 |
# fine-tune the look of the HTML output. If the tag is left blank doxygen |
|---|
| 385 |
# will generate a default style sheet |
|---|
| 386 |
|
|---|
| 387 |
HTML_STYLESHEET = |
|---|
| 388 |
|
|---|
| 389 |
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
|---|
| 390 |
# files or namespaces will be aligned in HTML using tables. If set to |
|---|
| 391 |
# NO a bullet list will be used. |
|---|
| 392 |
|
|---|
| 393 |
HTML_ALIGN_MEMBERS = YES |
|---|
| 394 |
|
|---|
| 395 |
# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
|---|
| 396 |
# will be generated that can be used as input for tools like the |
|---|
| 397 |
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
|---|
| 398 |
# of the generated HTML documentation. |
|---|
| 399 |
|
|---|
| 400 |
GENERATE_HTMLHELP = NO |
|---|
| 401 |
|
|---|
| 402 |
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
|---|
| 403 |
# top of each HTML page. The value NO (the default) enables the index and |
|---|
| 404 |
# the value YES disables it. |
|---|
| 405 |
|
|---|
| 406 |
DISABLE_INDEX = NO |
|---|
| 407 |
|
|---|
| 408 |
# This tag can be used to set the number of enum values (range [1..20]) |
|---|
| 409 |
# that doxygen will group on one line in the generated HTML documentation. |
|---|
| 410 |
|
|---|
| 411 |
ENUM_VALUES_PER_LINE = 4 |
|---|
| 412 |
|
|---|
| 413 |
# If the GENERATE_TREEVIEW tag is set to YES, a side pannel will be |
|---|
| 414 |
# generated containing a tree-like index structure (just like the one that |
|---|
| 415 |
# is generated for HTML Help). For this to work a browser that supports |
|---|
| 416 |
# JavaScript and frames is required (for instance Netscape 4.0+ |
|---|
| 417 |
# or Internet explorer 4.0+). |
|---|
| 418 |
|
|---|
| 419 |
GENERATE_TREEVIEW = YES |
|---|
| 420 |
|
|---|
| 421 |
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
|---|
| 422 |
# used to set the initial width (in pixels) of the frame in which the tree |
|---|
| 423 |
# is shown. |
|---|
| 424 |
|
|---|
| 425 |
TREEVIEW_WIDTH = 250 |
|---|
| 426 |
|
|---|
| 427 |
#--------------------------------------------------------------------------- |
|---|
| 428 |
# configuration options related to the LaTeX output |
|---|
| 429 |
#--------------------------------------------------------------------------- |
|---|
| 430 |
|
|---|
| 431 |
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
|---|
| 432 |
# generate Latex output. |
|---|
| 433 |
|
|---|
| 434 |
GENERATE_LATEX = NO |
|---|
| 435 |
|
|---|
| 436 |
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
|---|
| 437 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|---|
| 438 |
# put in front of it. If left blank `latex' will be used as the default path. |
|---|
| 439 |
|
|---|
| 440 |
LATEX_OUTPUT = latex |
|---|
| 441 |
|
|---|
| 442 |
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
|---|
| 443 |
# LaTeX documents. This may be useful for small projects and may help to |
|---|
| 444 |
# save some trees in general. |
|---|
| 445 |
|
|---|
| 446 |
COMPACT_LATEX = NO |
|---|
| 447 |
|
|---|
| 448 |
# The PAPER_TYPE tag can be used to set the paper type that is used |
|---|
| 449 |
# by the printer. Possible values are: a4, a4wide, letter, legal and |
|---|
| 450 |
# executive. If left blank a4wide will be used. |
|---|
| 451 |
|
|---|
| 452 |
PAPER_TYPE = letter |
|---|
| 453 |
|
|---|
| 454 |
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
|---|
| 455 |
# packages that should be included in the LaTeX output. |
|---|
| 456 |
|
|---|
| 457 |
EXTRA_PACKAGES = |
|---|
| 458 |
|
|---|
| 459 |
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
|---|
| 460 |
# the generated latex document. The header should contain everything until |
|---|
| 461 |
# the first chapter. If it is left blank doxygen will generate a |
|---|
| 462 |
# standard header. Notice: only use this tag if you know what you are doing! |
|---|
| 463 |
|
|---|
| 464 |
LATEX_HEADER = |
|---|
| 465 |
|
|---|
| 466 |
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
|---|
| 467 |
# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
|---|
| 468 |
# contain links (just like the HTML output) instead of page references |
|---|
| 469 |
# This makes the output suitable for online browsing using a pdf viewer. |
|---|
| 470 |
|
|---|
| 471 |
PDF_HYPERLINKS = NO |
|---|
| 472 |
|
|---|
| 473 |
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
|---|
| 474 |
# plain latex in the generated Makefile. Set this option to YES to get a |
|---|
| 475 |
# higher quality PDF documentation. |
|---|
| 476 |
|
|---|
| 477 |
USE_PDFLATEX = YES |
|---|
| 478 |
|
|---|
| 479 |
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
|---|
| 480 |
# command to the generated LaTeX files. This will instruct LaTeX to keep |
|---|
| 481 |
# running if errors occur, instead of asking the user for help. |
|---|
| 482 |
# This option is also used when generating formulas in HTML. |
|---|
| 483 |
|
|---|
| 484 |
LATEX_BATCHMODE = NO |
|---|
| 485 |
|
|---|
| 486 |
#--------------------------------------------------------------------------- |
|---|
| 487 |
# configuration options related to the RTF output |
|---|
| 488 |
#--------------------------------------------------------------------------- |
|---|
| 489 |
|
|---|
| 490 |
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
|---|
| 491 |
# The RTF output is optimised for Word 97 and may not look very pretty with |
|---|
| 492 |
# other RTF readers or editors. |
|---|
| 493 |
|
|---|
| 494 |
GENERATE_RTF = NO |
|---|
| 495 |
|
|---|
| 496 |
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
|---|
| 497 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|---|
| 498 |
# put in front of it. If left blank `rtf' will be used as the default path. |
|---|
| 499 |
|
|---|
| 500 |
RTF_OUTPUT = rtf |
|---|
| 501 |
|
|---|
| 502 |
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
|---|
| 503 |
# RTF documents. This may be useful for small projects and may help to |
|---|
| 504 |
# save some trees in general. |
|---|
| 505 |
|
|---|
| 506 |
COMPACT_RTF = NO |
|---|
| 507 |
|
|---|
| 508 |
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
|---|
| 509 |
# will contain hyperlink fields. The RTF file will |
|---|
| 510 |
# contain links (just like the HTML output) instead of page references. |
|---|
| 511 |
# This makes the output suitable for online browsing using a WORD or other. |
|---|
| 512 |
# programs which support those fields. |
|---|
| 513 |
# Note: wordpad (write) and others do not support links. |
|---|
| 514 |
|
|---|
| 515 |
RTF_HYPERLINKS = NO |
|---|
| 516 |
|
|---|
| 517 |
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
|---|
| 518 |
# config file, i.e. a series of assigments. You only have to provide |
|---|
| 519 |
# replacements, missing definitions are set to their default value. |
|---|
| 520 |
|
|---|
| 521 |
RTF_STYLESHEET_FILE = |
|---|
| 522 |
|
|---|
| 523 |
#--------------------------------------------------------------------------- |
|---|
| 524 |
# configuration options related to the man page output |
|---|
| 525 |
#--------------------------------------------------------------------------- |
|---|
| 526 |
|
|---|
| 527 |
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
|---|
| 528 |
# generate man pages |
|---|
| 529 |
|
|---|
| 530 |
GENERATE_MAN = NO |
|---|
| 531 |
|
|---|
| 532 |
# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
|---|
| 533 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|---|
| 534 |
# put in front of it. If left blank `man' will be used as the default path. |
|---|
| 535 |
|
|---|
| 536 |
MAN_OUTPUT = man |
|---|
| 537 |
|
|---|
| 538 |
# The MAN_EXTENSION tag determines the extension that is added to |
|---|
| 539 |
# the generated man pages (default is the subroutine's section .3) |
|---|
| 540 |
|
|---|
| 541 |
MAN_EXTENSION = .3 |
|---|
| 542 |
|
|---|
| 543 |
#--------------------------------------------------------------------------- |
|---|
| 544 |
# configuration options related to the XML output |
|---|
| 545 |
#--------------------------------------------------------------------------- |
|---|
| 546 |
|
|---|
| 547 |
# If the GENERATE_XML tag is set to YES Doxygen will |
|---|
| 548 |
# generate an XML file that captures the structure of |
|---|
| 549 |
# the code including all documentation. Warning: This feature |
|---|
| 550 |
# is still experimental and very incomplete. |
|---|
| 551 |
|
|---|
| 552 |
GENERATE_XML = NO |
|---|
| 553 |
|
|---|
| 554 |
#--------------------------------------------------------------------------- |
|---|
| 555 |
# Configuration options related to the preprocessor |
|---|
| 556 |
#--------------------------------------------------------------------------- |
|---|
| 557 |
|
|---|
| 558 |
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
|---|
| 559 |
# evaluate all C-preprocessor directives found in the sources and include |
|---|
| 560 |
# files. |
|---|
| 561 |
|
|---|
| 562 |
ENABLE_PREPROCESSING = YES |
|---|
| 563 |
|
|---|
| 564 |
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
|---|
| 565 |
# names in the source code. If set to NO (the default) only conditional |
|---|
| 566 |
# compilation will be performed. Macro expansion can be done in a controlled |
|---|
| 567 |
# way by setting EXPAND_ONLY_PREDEF to YES. |
|---|
| 568 |
|
|---|
| 569 |
MACRO_EXPANSION = NO |
|---|
| 570 |
|
|---|
| 571 |
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
|---|
| 572 |
# then the macro expansion is limited to the macros specified with the |
|---|
| 573 |
# PREDEFINED and EXPAND_AS_PREDEFINED tags. |
|---|
| 574 |
|
|---|
| 575 |
EXPAND_ONLY_PREDEF = NO |
|---|
| 576 |
|
|---|
| 577 |
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
|---|
| 578 |
# in the INCLUDE_PATH (see below) will be search if a #include is found. |
|---|
| 579 |
|
|---|
| 580 |
SEARCH_INCLUDES = YES |
|---|
| 581 |
|
|---|
| 582 |
# The INCLUDE_PATH tag can be used to specify one or more directories that |
|---|
| 583 |
# contain include files that are not input files but should be processed by |
|---|
| 584 |
# the preprocessor. |
|---|
| 585 |
|
|---|
| 586 |
INCLUDE_PATH = |
|---|
| 587 |
|
|---|
| 588 |
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
|---|
| 589 |
# patterns (like *.h and *.hpp) to filter out the header-files in the |
|---|
| 590 |
# directories. If left blank, the patterns specified with FILE_PATTERNS will |
|---|
| 591 |
# be used. |
|---|
| 592 |
|
|---|
| 593 |
INCLUDE_FILE_PATTERNS = |
|---|
| 594 |
|
|---|
| 595 |
# The PREDEFINED tag can be used to specify one or more macro names that |
|---|
| 596 |
# are defined before the preprocessor is started (similar to the -D option of |
|---|
| 597 |
# gcc). The argument of the tag is a list of macros of the form: name |
|---|
| 598 |
# or name=definition (no spaces). If the definition and the = are |
|---|
| 599 |
# omitted =1 is assumed. |
|---|
| 600 |
|
|---|
| 601 |
PREDEFINED = |
|---|
| 602 |
|
|---|
| 603 |
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then |
|---|
| 604 |
# this tag can be used to specify a list of macro names that should be expanded. |
|---|
| 605 |
# The macro definition that is found in the sources will be used. |
|---|
| 606 |
# Use the PREDEFINED tag if you want to use a different macro definition. |
|---|
| 607 |
|
|---|
| 608 |
EXPAND_AS_DEFINED = |
|---|
| 609 |
|
|---|
| 610 |
#--------------------------------------------------------------------------- |
|---|
| 611 |
# Configuration::addtions related to external references |
|---|
| 612 |
#--------------------------------------------------------------------------- |
|---|
| 613 |
|
|---|
| 614 |
# The TAGFILES tag can be used to specify one or more tagfiles. |
|---|
| 615 |
|
|---|
| 616 |
TAGFILES = |
|---|
| 617 |
|
|---|
| 618 |
# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
|---|
| 619 |
# a tag file that is based on the input files it reads. |
|---|
| 620 |
|
|---|
| 621 |
GENERATE_TAGFILE = |
|---|
| 622 |
|
|---|
| 623 |
# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
|---|
| 624 |
# in the class index. If set to NO only the inherited external classes |
|---|
| 625 |
# will be listed. |
|---|
| 626 |
|
|---|
| 627 |
ALLEXTERNALS = NO |
|---|
| 628 |
|
|---|
| 629 |
# The PERL_PATH should be the absolute path and name of the perl script |
|---|
| 630 |
# interpreter (i.e. the result of `which perl'). |
|---|
| 631 |
|
|---|
| 632 |
PERL_PATH = /usr/freeware/bin/perl |
|---|
| 633 |
|
|---|
| 634 |
#--------------------------------------------------------------------------- |
|---|
| 635 |
# Configuration options related to the dot tool |
|---|
| 636 |
#--------------------------------------------------------------------------- |
|---|
| 637 |
|
|---|
| 638 |
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
|---|
| 639 |
# available from the path. This tool is part of Graphviz, a graph visualization |
|---|
| 640 |
# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
|---|
| 641 |
# have no effect if this option is set to NO (the default) |
|---|
| 642 |
|
|---|
| 643 |
HAVE_DOT = YES |
|---|
| 644 |
|
|---|
| 645 |
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
|---|
| 646 |
# will generate a graph for each documented class showing the direct and |
|---|
| 647 |
# indirect inheritance relations. Setting this tag to YES will force the |
|---|
| 648 |
# the CLASS_DIAGRAMS tag to NO. |
|---|
| 649 |
|
|---|
| 650 |
CLASS_GRAPH = YES |
|---|
| 651 |
|
|---|
| 652 |
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
|---|
| 653 |
# will generate a graph for each documented class showing the direct and |
|---|
| 654 |
# indirect implementation dependencies (inheritance, containment, and |
|---|
| 655 |
# class references variables) of the class with other documented classes. |
|---|
| 656 |
|
|---|
| 657 |
COLLABORATION_GRAPH = YES |
|---|
| 658 |
|
|---|
| 659 |
# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to |
|---|
| 660 |
# YES then doxygen will generate a graph for each documented file showing |
|---|
| 661 |
# the direct and indirect include dependencies of the file with other |
|---|
| 662 |
# documented files. |
|---|
| 663 |
|
|---|
| 664 |
INCLUDE_GRAPH = YES |
|---|
| 665 |
|
|---|
| 666 |
# If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to |
|---|
| 667 |
# YES then doxygen will generate a graph for each documented header file showing |
|---|
| 668 |
# the documented files that directly or indirectly include this file |
|---|
| 669 |
|
|---|
| 670 |
INCLUDED_BY_GRAPH = YES |
|---|
| 671 |
|
|---|
| 672 |
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
|---|
| 673 |
# will graphical hierarchy of all classes instead of a textual one. |
|---|
| 674 |
|
|---|
| 675 |
GRAPHICAL_HIERARCHY = YES |
|---|
| 676 |
|
|---|
| 677 |
# The tag DOT_PATH can be used to specify the path where the dot tool can be |
|---|
| 678 |
# found. If left blank, it is assumed the dot tool can be found on the path. |
|---|
| 679 |
|
|---|
| 680 |
DOT_PATH = |
|---|
| 681 |
|
|---|
| 682 |
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width |
|---|
| 683 |
# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
|---|
| 684 |
# this value, doxygen will try to truncate the graph, so that it fits within |
|---|
| 685 |
# the specified constraint. Beware that most browsers cannot cope with very |
|---|
| 686 |
# large images. |
|---|
| 687 |
|
|---|
| 688 |
MAX_DOT_GRAPH_WIDTH = 1024 |
|---|
| 689 |
|
|---|
| 690 |
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height |
|---|
| 691 |
# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
|---|
| 692 |
# this value, doxygen will try to truncate the graph, so that it fits within |
|---|
| 693 |
# the specified constraint. Beware that most browsers cannot cope with very |
|---|
| 694 |
# large images. |
|---|
| 695 |
|
|---|
| 696 |
MAX_DOT_GRAPH_HEIGHT = 1024 |
|---|
| 697 |
|
|---|
| 698 |
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
|---|
| 699 |
# generate a legend page explaining the meaning of the various boxes and |
|---|
| 700 |
# arrows in the dot generated graphs. |
|---|
| 701 |
|
|---|
| 702 |
GENERATE_LEGEND = YES |
|---|
| 703 |
|
|---|
| 704 |
#--------------------------------------------------------------------------- |
|---|
| 705 |
# Configuration::addtions related to the search engine |
|---|
| 706 |
#--------------------------------------------------------------------------- |
|---|
| 707 |
|
|---|
| 708 |
# The SEARCHENGINE tag specifies whether or not a search engine should be |
|---|
| 709 |
# used. If set to NO the values of all tags below this one will be ignored. |
|---|
| 710 |
|
|---|
| 711 |
SEARCHENGINE = NO |
|---|