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