Emeric Vigier | 2f62582 | 2012-08-06 11:09:52 -0400 | [diff] [blame] | 1 | # Doxyfile 0.0.1 |
| 2 | # Generate doxy documentation in html and latex format. |
| 3 | |
| 4 | # This file describes the settings to be used by doxygen for a project |
| 5 | # |
| 6 | # All text after a hash (#) is considered a comment and will be ignored |
| 7 | # The format is: |
| 8 | # TAG = value [value, ...] |
| 9 | # Values that contain spaces should be placed between quotes (" ") |
| 10 | |
| 11 | #--------------------------------------------------------------------------- |
| 12 | # General configuration options |
| 13 | #--------------------------------------------------------------------------- |
| 14 | |
| 15 | # The PROJECT_NAME tag is a single word (or a sequence of word surrounded |
| 16 | # by quotes) that should identify the project. |
| 17 | |
| 18 | PROJECT_NAME =ccRTP |
| 19 | |
| 20 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
| 21 | # This could be handy for archiving the generated documentation or |
| 22 | # if some version control system is used. |
| 23 | |
| 24 | PROJECT_NUMBER = |
| 25 | |
| 26 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
| 27 | # base path where the generated documentation will be put. |
| 28 | # If a relative path is entered, it will be relative to the location |
| 29 | # where doxygen was started. If left blank the current directory will be used. |
| 30 | |
| 31 | OUTPUT_DIRECTORY =. |
| 32 | |
| 33 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
| 34 | # documentation generated by doxygen is written. Doxygen will use this |
| 35 | # information to generate all constant output in the proper language. |
| 36 | # The default language is English, other supported languages are: |
| 37 | # Dutch, French, Italian, Czech, Swedish, German and Japanese |
| 38 | |
| 39 | OUTPUT_LANGUAGE = English |
| 40 | |
| 41 | # The QUIET tag can be used to turn on/off the messages that are generated |
| 42 | # by doxygen. Possible values are YES and NO. If left blank NO is used. |
| 43 | |
| 44 | QUIET = NO |
| 45 | |
| 46 | # The WARNINGS tag can be used to turn on/off the warning messages that are |
| 47 | # generated by doxygen. Possible values are YES and NO. If left blank |
| 48 | # NO is used. |
| 49 | |
| 50 | WARNINGS = YES |
| 51 | |
| 52 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
| 53 | # top of each HTML page. The value NO (the default) enables the index and |
| 54 | # the value YES disables it. |
| 55 | |
| 56 | DISABLE_INDEX = NO |
| 57 | |
| 58 | # If the EXTRACT_ALL tag is set to YES all classes and functions will be |
| 59 | # included in the documentation, even if no documentation was available. |
| 60 | |
| 61 | EXTRACT_ALL = YES |
| 62 | |
| 63 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
| 64 | # will be included in the documentation. |
| 65 | |
| 66 | EXTRACT_PRIVATE = NO |
| 67 | |
| 68 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
| 69 | # undocumented members inside documented classes or files. |
| 70 | |
| 71 | HIDE_UNDOC_MEMBERS = NO |
| 72 | |
| 73 | # If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all |
| 74 | # undocumented classes. |
| 75 | |
| 76 | HIDE_UNDOC_CLASSES = NO |
| 77 | |
| 78 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
| 79 | # include brief member descriptions after the members that are listed in |
| 80 | # the file and class documentation (similar to JavaDoc). |
| 81 | # Set to NO to disable this. |
| 82 | |
| 83 | BRIEF_MEMBER_DESC = YES |
| 84 | |
| 85 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
| 86 | # the brief description of a member or function before the detailed description. |
| 87 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
| 88 | # brief descriptions will be completely suppressed. |
| 89 | |
| 90 | REPEAT_BRIEF = YES |
| 91 | |
| 92 | # If the ALWAYS_DETAILS_SEC and REPEAT_BRIEF tags are both set to YES then |
| 93 | # Doxygen will generate a detailed section even if there is only a brief |
| 94 | # description. |
| 95 | |
| 96 | ALWAYS_DETAILED_SEC = NO |
| 97 | |
| 98 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
| 99 | # path before files name in the file list and in the header files. If set |
| 100 | # to NO the shortest path that makes the file name unique will be used. |
| 101 | |
| 102 | FULL_PATH_NAMES = NO |
| 103 | |
| 104 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
| 105 | # can be used to strip a user defined part of the path. Stripping is |
| 106 | # only done if one of the specified strings matches the left-hand part of |
| 107 | # the path. |
| 108 | |
| 109 | STRIP_FROM_PATH = |
| 110 | |
| 111 | # The INTERNAL_DOCS tag determines if documentation |
| 112 | # that is typed after a \internal command is included. If the tag is set |
| 113 | # to NO (the default) then the documentation will be excluded. |
| 114 | # Set it to YES to include the internal documentation. |
| 115 | |
| 116 | INTERNAL_DOCS = NO |
| 117 | |
| 118 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
| 119 | # generate a class diagram (in Html and LaTeX) for classes with base or |
| 120 | # super classes. Setting the tag to NO turns the diagrams off. |
| 121 | |
| 122 | CLASS_DIAGRAMS = YES |
| 123 | |
| 124 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
| 125 | # be generated. Documented entities will be cross-referenced with these sources. |
| 126 | |
| 127 | SOURCE_BROWSER = NO |
| 128 | |
| 129 | # Setting the INLINE_SOURCES tag to YES will include the body |
| 130 | # of functions and classes directly in the documentation. |
| 131 | |
| 132 | INLINE_SOURCES = NO |
| 133 | |
| 134 | # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen |
| 135 | # will only generate file names in lower case letters. If set to |
| 136 | # YES upper case letters are also allowed. This is useful if you have |
| 137 | # classes or files whose names only differ in case and if your file system |
| 138 | # supports case sensitive file names. |
| 139 | |
| 140 | CASE_SENSE_NAMES = NO |
| 141 | |
| 142 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
| 143 | # will generate a verbatim copy of the header file for each class for |
| 144 | # which an include is specified. Set to NO to disable this. |
| 145 | |
| 146 | VERBATIM_HEADERS = YES |
| 147 | |
| 148 | # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen |
| 149 | # will interpret the first line (until the first dot) of a JavaDoc-style |
| 150 | # comment as the brief description. If set to NO, the Javadoc-style will |
| 151 | # behave just like the Qt-style comments. |
| 152 | |
| 153 | JAVADOC_AUTOBRIEF = YES |
| 154 | |
| 155 | # if the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
| 156 | # member inherits the documentation from any documented member that it |
| 157 | # reimplements. |
| 158 | |
| 159 | INHERIT_DOCS = NO |
| 160 | |
| 161 | # if the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
| 162 | # is inserted in the documentation for inline members. |
| 163 | |
| 164 | INLINE_INFO = YES |
| 165 | |
| 166 | # the TAB_SIZE tag can be used to set the number of spaces in a tab. |
| 167 | # Doxygen uses this value to replace tabs by spaces in code fragments. |
| 168 | |
| 169 | TAB_SIZE = 8 |
| 170 | |
| 171 | # The GENERATE_TODOLIST tag can be used to enable (YES) or |
| 172 | # disable (NO) the todo list. This list is created by putting \todo |
| 173 | # commands in the documentation. |
| 174 | |
| 175 | GENERATE_TODOLIST = NO |
| 176 | |
| 177 | # If the sources in your project are distributed over multiple directories |
| 178 | # then setting the SHOW_DIRECTORIES tag to YES will show the directory |
| 179 | # hierarchy in the documentation. |
| 180 | |
| 181 | SHOW_DIRECTORIES = NO |
| 182 | |
| 183 | #--------------------------------------------------------------------------- |
| 184 | # configuration options related to the input files |
| 185 | #--------------------------------------------------------------------------- |
| 186 | |
| 187 | # The INPUT tag can be used to specify the files and/or directories that contain |
| 188 | # documented source files. You may enter file names like "myfile.cpp" or |
| 189 | # directories like "/usr/src/myproject". Separate the files or directories |
| 190 | # with spaces. |
| 191 | |
| 192 | INPUT = ../w32/include/cc++ ../src ../src/ccrtp |
| 193 | |
| 194 | # If the value of the INPUT tag contains directories, you can use the |
| 195 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
| 196 | # and *.h) to filter out the source-files in the directories. If left |
| 197 | # blank all files are included. |
| 198 | |
| 199 | FILE_PATTERNS = *.h |
| 200 | |
| 201 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
| 202 | # should be searched for input files as well. Possible values are YES and NO. |
| 203 | # If left blank NO is used. |
| 204 | |
| 205 | RECURSIVE = NO |
| 206 | |
| 207 | # The EXCLUDE tag can be used to specify files and/or directories that should |
| 208 | # excluded from the INPUT source files. This way you can easily exclude a |
| 209 | # subdirectory from a directory tree whose root is specified with the INPUT tag. |
| 210 | |
| 211 | EXCLUDE = |
| 212 | |
| 213 | # If the value of the INPUT tag contains directories, you can use the |
| 214 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
| 215 | # certain files from those directories. |
| 216 | |
| 217 | EXCLUDE_PATTERNS = config.h macros.h namespace.h |
| 218 | |
| 219 | # The EXAMPLE_PATH tag can be used to specify one or more files or |
| 220 | # directories that contain example code fragments that are included (see |
| 221 | # the \include command). |
| 222 | |
| 223 | EXAMPLE_PATH = ../demo |
| 224 | |
| 225 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
| 226 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
| 227 | # and *.h) to filter out the source-files in the directories. If left |
| 228 | # blank all files are included. |
| 229 | |
| 230 | EXAMPLE_PATTERNS = |
| 231 | |
| 232 | # The IMAGE_PATH tag can be used to specify one or more files or |
| 233 | # directories that contain image that are included in the documentation (see |
| 234 | # the \image command). |
| 235 | |
| 236 | IMAGE_PATH = |
| 237 | |
| 238 | # The INPUT_FILTER tag can be used to specify a program that doxygen should |
| 239 | # invoke to filter for each input file. Doxygen will invoke the filter program |
| 240 | # by executing (via popen()) the command <filter> <input-file>, where <filter> |
| 241 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
| 242 | # input file. Doxygen will then use the output that the filter program writes |
| 243 | # to standard output. |
| 244 | |
| 245 | INPUT_FILTER = |
| 246 | |
| 247 | #--------------------------------------------------------------------------- |
| 248 | # configuration options related to the HTML output |
| 249 | #--------------------------------------------------------------------------- |
| 250 | |
| 251 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
| 252 | # generate HTML output |
| 253 | |
| 254 | GENERATE_HTML = YES |
| 255 | |
| 256 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
| 257 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| 258 | # put in front of it. If left blank `html' will be used as the default path. |
| 259 | |
| 260 | HTML_OUTPUT = |
| 261 | |
| 262 | # The HTML_HEADER tag can be used to specify a personal HTML header for |
| 263 | # each generated HTML page. If it is left blank doxygen will generate a |
| 264 | # standard header. |
| 265 | |
| 266 | HTML_HEADER = |
| 267 | |
| 268 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for |
| 269 | # each generated HTML page. If it is left blank doxygen will generate a |
| 270 | # standard footer. |
| 271 | |
| 272 | HTML_FOOTER = |
| 273 | |
| 274 | # The HTML_STYLESHEET tag can be used to specify a user defined cascading |
| 275 | # style sheet that is used by each HTML page. It can be used to |
| 276 | # fine-tune the look of the HTML output. If the tag is left blank doxygen |
| 277 | # will generate a default style sheet |
| 278 | |
| 279 | HTML_STYLESHEET = |
| 280 | |
| 281 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
| 282 | # files or namespaces will be aligned in HTML using tables. If set to |
| 283 | # NO a bullet list will be used. |
| 284 | |
| 285 | HTML_ALIGN_MEMBERS = YES |
| 286 | |
| 287 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
| 288 | # will be generated that can be used as input for tools like the |
| 289 | # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
| 290 | # of the generated HTML documentation. |
| 291 | |
| 292 | GENERATE_HTMLHELP = YES |
| 293 | |
| 294 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
| 295 | # of all compounds will be generated. Enable this if the project |
| 296 | # contains a lot of classes, structs, unions or interfaces. |
| 297 | |
| 298 | ALPHABETICAL_INDEX = YES |
| 299 | |
| 300 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
| 301 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
| 302 | # in which this list will be split (can be a number in the range [1..20]) |
| 303 | |
| 304 | COLS_IN_ALPHA_INDEX = 5 |
| 305 | |
| 306 | #--------------------------------------------------------------------------- |
| 307 | # configuration options related to the LaTeX output |
| 308 | #--------------------------------------------------------------------------- |
| 309 | |
| 310 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
| 311 | # generate Latex output. |
| 312 | |
| 313 | GENERATE_LATEX = YES |
| 314 | |
| 315 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
| 316 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| 317 | # put in front of it. If left blank `latex' will be used as the default path. |
| 318 | |
| 319 | LATEX_OUTPUT = |
| 320 | |
| 321 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
| 322 | # LaTeX documents. This may be useful for small projects and may help to |
| 323 | # save some trees in general. |
| 324 | |
| 325 | COMPACT_LATEX = NO |
| 326 | |
| 327 | # The PAPER_TYPE tag can be used to set the paper type that is used |
| 328 | # by the printer. Possible values are: a4, a4wide, letter, legal and |
| 329 | # executive. If left blank a4wide will be used. |
| 330 | |
| 331 | PAPER_TYPE = a4wide |
| 332 | |
| 333 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
| 334 | # packages that should be included in the LaTeX output. |
| 335 | |
| 336 | EXTRA_PACKAGES = |
| 337 | |
| 338 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
| 339 | # the generated latex document. The header should contain everything until |
| 340 | # the first chapter. If it is left blank doxygen will generate a |
| 341 | # standard header. Notice: only use this tag if you know what you are doing! |
| 342 | |
| 343 | LATEX_HEADER = |
| 344 | |
| 345 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
| 346 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will |
| 347 | # contain links (just like the HTML output) instead of page references |
| 348 | # This makes the output suitable for online browsing using a pdf viewer. |
| 349 | |
| 350 | PDF_HYPERLINKS = NO |
| 351 | |
| 352 | #--------------------------------------------------------------------------- |
| 353 | # configuration options related to the man page output |
| 354 | #--------------------------------------------------------------------------- |
| 355 | |
| 356 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
| 357 | # generate man pages |
| 358 | |
| 359 | GENERATE_MAN = YES |
| 360 | |
| 361 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. |
| 362 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| 363 | # put in front of it. If left blank `man' will be used as the default path. |
| 364 | |
| 365 | MAN_OUTPUT = |
| 366 | |
| 367 | # The MAN_EXTENSION tag determines the extension that is added to |
| 368 | # the generated man pages (default is the subroutine's section .3) |
| 369 | |
| 370 | MAN_EXTENSION = .3 |
| 371 | |
| 372 | #--------------------------------------------------------------------------- |
| 373 | # Configuration options related to the preprocessor |
| 374 | #--------------------------------------------------------------------------- |
| 375 | |
| 376 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
| 377 | # evaluate all C-preprocessor directives found in the sources and include |
| 378 | # files. |
| 379 | |
| 380 | ENABLE_PREPROCESSING = YES |
| 381 | |
| 382 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
| 383 | # names in the source code. If set to NO (the default) only conditional |
| 384 | # compilation will be performed. |
| 385 | |
| 386 | MACRO_EXPANSION = YES |
| 387 | |
| 388 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
| 389 | # in the INCLUDE_PATH (see below) will be search if a #include is found. |
| 390 | |
| 391 | SEARCH_INCLUDES = YES |
| 392 | |
| 393 | # The INCLUDE_PATH tag can be used to specify one or more directories that |
| 394 | # contain include files that are not input files but should be processed by |
| 395 | # the preprocessor. |
| 396 | |
| 397 | INCLUDE_PATH = . |
| 398 | |
| 399 | # The PREDEFINED tag can be used to specify one or more macro names that |
| 400 | # are defined before the preprocessor is started (similar to the -D option of |
| 401 | # gcc). The argument of the tag is a list of macros of the form: name |
| 402 | # or name=definition (no spaces). If the definition and the = are |
| 403 | # omitted =1 is assumed. |
| 404 | |
| 405 | PREDEFINED = |
| 406 | |
| 407 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
| 408 | # then the macro expansion is limited to the macros specified with the |
| 409 | # PREDEFINED tag. |
| 410 | |
| 411 | EXPAND_ONLY_PREDEF = NO |
| 412 | |
| 413 | #--------------------------------------------------------------------------- |
| 414 | # Configuration options related to external references |
| 415 | #--------------------------------------------------------------------------- |
| 416 | |
| 417 | # The TAGFILES tag can be used to specify one or more tagfiles. |
| 418 | |
| 419 | TAGFILES = |
| 420 | |
| 421 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
| 422 | # a tag file that is based on the input files it reads. |
| 423 | |
| 424 | GENERATE_TAGFILE = |
| 425 | |
| 426 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed |
| 427 | # in the class index. If set to NO only the inherited external classes |
| 428 | # will be listed. |
| 429 | |
| 430 | ALLEXTERNALS = NO |
| 431 | |
| 432 | # The PERL_PATH should be the absolute path and name of the perl script |
| 433 | # interpreter (i.e. the result of `which perl'). |
| 434 | |
| 435 | PERL_PATH = /usr/bin/perl |
| 436 | |
| 437 | #--------------------------------------------------------------------------- |
| 438 | # Configuration options related to the search engine |
| 439 | #--------------------------------------------------------------------------- |
| 440 | |
| 441 | # The SEARCHENGINE tag specifies whether or not a search engine should be |
| 442 | # used. If set to NO the values of all tags below this one will be ignored. |
| 443 | |
| 444 | SEARCHENGINE = NO |
| 445 | |
| 446 | # The CGI_NAME tag should be the name of the CGI script that |
| 447 | # starts the search engine (doxysearch) with the correct parameters. |
| 448 | # A script with this name will be generated by doxygen. |
| 449 | |
| 450 | CGI_NAME = search.cgi |
| 451 | |
| 452 | # The CGI_URL tag should be the absolute URL to the directory where the |
| 453 | # cgi binaries are located. See the documentation of your http daemon for |
| 454 | # details. |
| 455 | |
| 456 | CGI_URL = |
| 457 | |
| 458 | # The DOC_URL tag should be the absolute URL to the directory where the |
| 459 | # documentation is located. If left blank the absolute path to the |
| 460 | # documentation, with file:// prepended to it, will be used. |
| 461 | |
| 462 | DOC_URL = |
| 463 | |
| 464 | # The DOC_ABSPATH tag should be the absolute path to the directory where the |
| 465 | # documentation is located. If left blank the directory on the local machine |
| 466 | # will be used. |
| 467 | |
| 468 | DOC_ABSPATH = |
| 469 | |
| 470 | # The BIN_ABSPATH tag must point to the directory where the doxysearch binary |
| 471 | # is installed. |
| 472 | |
| 473 | BIN_ABSPATH = /usr/local/bin/ |
| 474 | |
| 475 | # The EXT_DOC_PATHS tag can be used to specify one or more paths to |
| 476 | # documentation generated for other projects. This allows doxysearch to search |
| 477 | # the documentation for these projects as well. |
| 478 | |
| 479 | EXT_DOC_PATHS = |