Changeset 3041 for trunk/psLib/src/Doxyfile
- Timestamp:
- Jan 18, 2005, 11:43:28 AM (22 years ago)
- File:
-
- 1 edited
-
trunk/psLib/src/Doxyfile (modified) (28 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/psLib/src/Doxyfile
r2145 r3041 24 24 # if some version control system is used. 25 25 26 PROJECT_NUMBER = V1. 2-R326 PROJECT_NUMBER = V1.3-R4 27 27 28 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) … … 221 221 HIDE_FRIEND_COMPOUNDS = NO 222 222 223 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 224 # documentation blocks found inside the body of a function. 225 # If set to NO (the default) these blocks will be appended to the 223 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 224 # documentation blocks found inside the body of a function. 225 # If set to NO (the default) these blocks will be appended to the 226 226 # function's detailed documentation block. 227 227 228 228 HIDE_IN_BODY_DOCS = NO 229 229 230 # The INTERNAL_DOCS tag determines if documentation 231 # that is typed after a \internal command is included. If the tag is set 230 # The INTERNAL_DOCS tag determines if documentation 231 # that is typed after a \internal command is included. If the tag is set 232 232 # to NO (the default) then the documentation will be excluded. 233 233 # Set it to YES to include the internal documentation. … … 235 235 INTERNAL_DOCS = NO 236 236 237 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 238 # file names in lower-case letters. If set to YES upper-case letters are also 239 # allowed. This is useful if you have classes or files whose names only differ 240 # in case and if your file system supports case sensitive file names. Windows 237 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 238 # file names in lower-case letters. If set to YES upper-case letters are also 239 # allowed. This is useful if you have classes or files whose names only differ 240 # in case and if your file system supports case sensitive file names. Windows 241 241 # users are advised to set this option to NO. 242 242 243 243 CASE_SENSE_NAMES = YES 244 244 245 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 246 # will show members with their full class and namespace scopes in the 245 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 246 # will show members with their full class and namespace scopes in the 247 247 # documentation. If set to YES the scope will be hidden. 248 248 249 249 HIDE_SCOPE_NAMES = NO 250 250 251 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 252 # will put a list of the files that are included by a file in the documentation 251 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 252 # will put a list of the files that are included by a file in the documentation 253 253 # of that file. 254 254 255 255 SHOW_INCLUDE_FILES = YES 256 256 257 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 257 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 258 258 # is inserted in the documentation for inline members. 259 259 260 260 INLINE_INFO = YES 261 261 262 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 263 # will sort the (detailed) documentation of file and class members 264 # alphabetically by member name. If set to NO the members will appear in 262 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 263 # will sort the (detailed) documentation of file and class members 264 # alphabetically by member name. If set to NO the members will appear in 265 265 # declaration order. 266 266 267 267 SORT_MEMBER_DOCS = YES 268 268 269 # The GENERATE_TODOLIST tag can be used to enable (YES) or 270 # disable (NO) the todo list. This list is created by putting \todo 269 # The GENERATE_TODOLIST tag can be used to enable (YES) or 270 # disable (NO) the todo list. This list is created by putting \todo 271 271 # commands in the documentation. 272 272 273 273 GENERATE_TODOLIST = YES 274 274 275 # The GENERATE_TESTLIST tag can be used to enable (YES) or 276 # disable (NO) the test list. This list is created by putting \test 275 # The GENERATE_TESTLIST tag can be used to enable (YES) or 276 # disable (NO) the test list. This list is created by putting \test 277 277 # commands in the documentation. 278 278 279 279 GENERATE_TESTLIST = YES 280 280 281 # The GENERATE_BUGLIST tag can be used to enable (YES) or 282 # disable (NO) the bug list. This list is created by putting \bug 281 # The GENERATE_BUGLIST tag can be used to enable (YES) or 282 # disable (NO) the bug list. This list is created by putting \bug 283 283 # commands in the documentation. 284 284 285 285 GENERATE_BUGLIST = YES 286 286 287 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 288 # disable (NO) the deprecated list. This list is created by putting 287 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 288 # disable (NO) the deprecated list. This list is created by putting 289 289 # \deprecated commands in the documentation. 290 290 291 291 GENERATE_DEPRECATEDLIST= YES 292 292 293 # The ENABLED_SECTIONS tag can be used to enable conditional 293 # The ENABLED_SECTIONS tag can be used to enable conditional 294 294 # documentation sections, marked by \if sectionname ... \endif. 295 295 296 296 ENABLED_SECTIONS = 297 297 298 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 299 # the initial value of a variable or define consists of for it to appear in 298 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 299 # the initial value of a variable or define consists of for it to appear in 300 300 # the documentation. If the initializer consists of more lines than specified 301 # here it will be hidden. Use a value of 0 to hide initializers completely. 302 # The appearance of the initializer of individual variables and defines in the 303 # documentation can be controlled using \showinitializer or \hideinitializer 301 # here it will be hidden. Use a value of 0 to hide initializers completely. 302 # The appearance of the initializer of individual variables and defines in the 303 # documentation can be controlled using \showinitializer or \hideinitializer 304 304 # command in the documentation regardless of this setting. 305 305 306 306 MAX_INITIALIZER_LINES = 30 307 307 308 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 309 # at the bottom of the documentation of classes and structs. If set to YES the 308 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 309 # at the bottom of the documentation of classes and structs. If set to YES the 310 310 # list will mention the files that were used to generate the documentation. 311 311 … … 316 316 #--------------------------------------------------------------------------- 317 317 318 # The QUIET tag can be used to turn on/off the messages that are generated 318 # The QUIET tag can be used to turn on/off the messages that are generated 319 319 # by doxygen. Possible values are YES and NO. If left blank NO is used. 320 320 321 321 QUIET = NO 322 322 323 # The WARNINGS tag can be used to turn on/off the warning messages that are 323 # The WARNINGS tag can be used to turn on/off the warning messages that are 324 324 # generated by doxygen. Possible values are YES and NO. If left blank 325 325 # NO is used. … … 327 327 WARNINGS = YES 328 328 329 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 330 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 329 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 330 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 331 331 # automatically be disabled. 332 332 333 333 WARN_IF_UNDOCUMENTED = YES 334 334 335 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 336 # potential errors in the documentation, such as not documenting some 337 # parameters in a documented function, or documenting parameters that 335 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 336 # potential errors in the documentation, such as not documenting some 337 # parameters in a documented function, or documenting parameters that 338 338 # don't exist or using markup commands wrongly. 339 339 340 340 WARN_IF_DOC_ERROR = YES 341 341 342 # The WARN_FORMAT tag determines the format of the warning messages that 343 # doxygen can produce. The string should contain the $file, $line, and $text 344 # tags, which will be replaced by the file and line number from which the 342 # The WARN_FORMAT tag determines the format of the warning messages that 343 # doxygen can produce. The string should contain the $file, $line, and $text 344 # tags, which will be replaced by the file and line number from which the 345 345 # warning originated and the warning text. 346 346 347 347 WARN_FORMAT = "$file:$line: $text" 348 348 349 # The WARN_LOGFILE tag can be used to specify a file to which warning 350 # and error messages should be written. If left blank the output is written 349 # The WARN_LOGFILE tag can be used to specify a file to which warning 350 # and error messages should be written. If left blank the output is written 351 351 # to stderr. 352 352 … … 357 357 #--------------------------------------------------------------------------- 358 358 359 # The INPUT tag can be used to specify the files and/or directories that contain 360 # documented source files. You may enter file names like "myfile.cpp" or 361 # directories like "/usr/src/myproject". Separate the files or directories 359 # The INPUT tag can be used to specify the files and/or directories that contain 360 # documented source files. You may enter file names like "myfile.cpp" or 361 # directories like "/usr/src/myproject". Separate the files or directories 362 362 # with spaces. 363 363 … … 370 370 astronomy 371 371 372 # If the value of the INPUT tag contains directories, you can use the 372 # If the value of the INPUT tag contains directories, you can use the 373 373 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 374 374 # and *.h) to filter out the source-files in the directories. If left … … 386 386 387 387 # The EXCLUDE tag can be used to specify files and/or directories that should 388 # excluded from the INPUT source files. This way you can easily exclude a 388 # excluded from the INPUT source files. This way you can easily exclude a 389 389 # subdirectory from a directory tree whose root is specified with the INPUT tag. 390 390 391 391 EXCLUDE = 392 392 393 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 393 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 394 394 # that are symbolic links (a Unix filesystem feature) are excluded from the input. 395 395 396 396 EXCLUDE_SYMLINKS = NO 397 397 398 # If the value of the INPUT tag contains directories, you can use the 399 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 398 # If the value of the INPUT tag contains directories, you can use the 399 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 400 400 # certain files from those directories. 401 401 … … 403 403 404 404 # The EXAMPLE_PATH tag can be used to specify one or more files or 405 # directories that contain example code fragments that are included (see 405 # directories that contain example code fragments that are included (see 406 406 # the \include command). 407 407 408 408 EXAMPLE_PATH = 409 409 410 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 411 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 412 # and *.h) to filter out the source-files in the directories. If left 410 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 411 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 412 # and *.h) to filter out the source-files in the directories. If left 413 413 # blank all files are included. 414 414 415 EXAMPLE_PATTERNS = 416 417 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 418 # searched for input files to be used with the \include or \dontinclude 419 # commands irrespective of the value of the RECURSIVE tag. 415 EXAMPLE_PATTERNS = 416 417 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 418 # searched for input files to be used with the \include or \dontinclude 419 # commands irrespective of the value of the RECURSIVE tag. 420 420 # Possible values are YES and NO. If left blank NO is used. 421 421 422 422 EXAMPLE_RECURSIVE = NO 423 423 424 # The IMAGE_PATH tag can be used to specify one or more files or 425 # directories that contain image that are included in the documentation (see 424 # The IMAGE_PATH tag can be used to specify one or more files or 425 # directories that contain image that are included in the documentation (see 426 426 # the \image command). 427 427 428 IMAGE_PATH = 429 430 # The INPUT_FILTER tag can be used to specify a program that doxygen should 431 # invoke to filter for each input file. Doxygen will invoke the filter program 432 # by executing (via popen()) the command <filter> <input-file>, where <filter> 433 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 434 # input file. Doxygen will then use the output that the filter program writes 428 IMAGE_PATH = 429 430 # The INPUT_FILTER tag can be used to specify a program that doxygen should 431 # invoke to filter for each input file. Doxygen will invoke the filter program 432 # by executing (via popen()) the command <filter> <input-file>, where <filter> 433 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 434 # input file. Doxygen will then use the output that the filter program writes 435 435 # to standard output. 436 436 437 INPUT_FILTER = 438 439 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 440 # INPUT_FILTER) will be used to filter the input files when producing source 437 INPUT_FILTER = 438 439 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 440 # INPUT_FILTER) will be used to filter the input files when producing source 441 441 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 442 442 … … 447 447 #--------------------------------------------------------------------------- 448 448 449 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 449 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 450 450 # be generated. Documented entities will be cross-referenced with these sources. 451 451 452 452 SOURCE_BROWSER = YES 453 453 454 # Setting the INLINE_SOURCES tag to YES will include the body 454 # Setting the INLINE_SOURCES tag to YES will include the body 455 455 # of functions and classes directly in the documentation. 456 456 457 457 INLINE_SOURCES = NO 458 458 459 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 460 # doxygen to hide any special comment blocks from generated source code 459 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 460 # doxygen to hide any special comment blocks from generated source code 461 461 # fragments. Normal C and C++ comments will always remain visible. 462 462 463 463 STRIP_CODE_COMMENTS = NO 464 464 465 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 466 # then for each documented function all documented 465 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 466 # then for each documented function all documented 467 467 # functions referencing it will be listed. 468 468 469 469 REFERENCED_BY_RELATION = YES 470 470 471 # If the REFERENCES_RELATION tag is set to YES (the default) 472 # then for each documented function all documented entities 471 # If the REFERENCES_RELATION tag is set to YES (the default) 472 # then for each documented function all documented entities 473 473 # called/used by that function will be listed. 474 474 475 475 REFERENCES_RELATION = YES 476 476 477 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 478 # will generate a verbatim copy of the header file for each class for 477 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 478 # will generate a verbatim copy of the header file for each class for 479 479 # which an include is specified. Set to NO to disable this. 480 480 … … 485 485 #--------------------------------------------------------------------------- 486 486 487 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 488 # of all compounds will be generated. Enable this if the project 487 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 488 # of all compounds will be generated. Enable this if the project 489 489 # contains a lot of classes, structs, unions or interfaces. 490 490 491 491 ALPHABETICAL_INDEX = YES 492 492 493 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 494 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 493 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 494 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 495 495 # in which this list will be split (can be a number in the range [1..20]) 496 496 497 497 COLS_IN_ALPHA_INDEX = 5 498 498 499 # In case all classes in a project start with a common prefix, all 500 # classes will be put under the same header in the alphabetical index. 501 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 499 # In case all classes in a project start with a common prefix, all 500 # classes will be put under the same header in the alphabetical index. 501 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 502 502 # should be ignored while generating the index headers. 503 503 504 IGNORE_PREFIX = 504 IGNORE_PREFIX = 505 505 506 506 #--------------------------------------------------------------------------- … … 508 508 #--------------------------------------------------------------------------- 509 509 510 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 510 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 511 511 # generate HTML output. 512 512 513 513 GENERATE_HTML = YES 514 514 515 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 516 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 515 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 516 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 517 517 # put in front of it. If left blank `html' will be used as the default path. 518 518 519 519 HTML_OUTPUT = html 520 520 521 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 522 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 521 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 522 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 523 523 # doxygen will generate files with .html extension. 524 524 525 525 HTML_FILE_EXTENSION = .html 526 526 527 # The HTML_HEADER tag can be used to specify a personal HTML header for 528 # each generated HTML page. If it is left blank doxygen will generate a 527 # The HTML_HEADER tag can be used to specify a personal HTML header for 528 # each generated HTML page. If it is left blank doxygen will generate a 529 529 # standard header. 530 530 531 HTML_HEADER = 532 533 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 534 # each generated HTML page. If it is left blank doxygen will generate a 531 HTML_HEADER = 532 533 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 534 # each generated HTML page. If it is left blank doxygen will generate a 535 535 # standard footer. 536 536 537 537 HTML_FOOTER = 538 538 539 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 540 # style sheet that is used by each HTML page. It can be used to 541 # fine-tune the look of the HTML output. If the tag is left blank doxygen 539 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 540 # style sheet that is used by each HTML page. It can be used to 541 # fine-tune the look of the HTML output. If the tag is left blank doxygen 542 542 # will generate a default style sheet 543 543 544 HTML_STYLESHEET = 545 546 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 547 # files or namespaces will be aligned in HTML using tables. If set to 544 HTML_STYLESHEET = 545 546 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 547 # files or namespaces will be aligned in HTML using tables. If set to 548 548 # NO a bullet list will be used. 549 549 550 550 HTML_ALIGN_MEMBERS = YES 551 551 552 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 553 # will be generated that can be used as input for tools like the 554 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 552 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 553 # will be generated that can be used as input for tools like the 554 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 555 555 # of the generated HTML documentation. 556 556 557 557 GENERATE_HTMLHELP = NO 558 558 559 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 560 # be used to specify the file name of the resulting .chm file. You 561 # can add a path in front of the file if the result should not be 559 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 560 # be used to specify the file name of the resulting .chm file. You 561 # can add a path in front of the file if the result should not be 562 562 # written to the html output dir. 563 563 564 CHM_FILE = 565 566 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 567 # be used to specify the location (absolute path including file name) of 568 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 564 CHM_FILE = 565 566 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 567 # be used to specify the location (absolute path including file name) of 568 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 569 569 # the HTML help compiler on the generated index.hhp. 570 570 571 HHC_LOCATION = 572 573 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 574 # controls if a separate .chi index file is generated (YES) or that 571 HHC_LOCATION = 572 573 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 574 # controls if a separate .chi index file is generated (YES) or that 575 575 # it should be included in the master .chm file (NO). 576 576 577 577 GENERATE_CHI = NO 578 578 579 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 580 # controls whether a binary table of contents is generated (YES) or a 579 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 580 # controls whether a binary table of contents is generated (YES) or a 581 581 # normal table of contents (NO) in the .chm file. 582 582 583 583 BINARY_TOC = NO 584 584 585 # The TOC_EXPAND flag can be set to YES to add extra items for group members 585 # The TOC_EXPAND flag can be set to YES to add extra items for group members 586 586 # to the contents of the HTML help documentation and to the tree view. 587 587 588 588 TOC_EXPAND = YES 589 589 590 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 591 # top of each HTML page. The value NO (the default) enables the index and 590 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 591 # top of each HTML page. The value NO (the default) enables the index and 592 592 # the value YES disables it. 593 593 594 594 DISABLE_INDEX = NO 595 595 596 # This tag can be used to set the number of enum values (range [1..20]) 596 # This tag can be used to set the number of enum values (range [1..20]) 597 597 # that doxygen will group on one line in the generated HTML documentation. 598 598 … … 600 600 601 601 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 602 # generated containing a tree-like index structure (just like the one that 603 # is generated for HTML Help). For this to work a browser that supports 604 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 605 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 602 # generated containing a tree-like index structure (just like the one that 603 # is generated for HTML Help). For this to work a browser that supports 604 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 605 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 606 606 # probably better off using the HTML help feature. 607 607 608 608 GENERATE_TREEVIEW = NO 609 609 610 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 611 # used to set the initial width (in pixels) of the frame in which the tree 610 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 611 # used to set the initial width (in pixels) of the frame in which the tree 612 612 # is shown. 613 613 … … 618 618 #--------------------------------------------------------------------------- 619 619 620 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 620 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 621 621 # generate Latex output. 622 622 623 623 GENERATE_LATEX = NO 624 624 625 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 626 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 625 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 626 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 627 627 # put in front of it. If left blank `latex' will be used as the default path. 628 628 629 629 LATEX_OUTPUT = latex 630 630 631 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 631 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 632 632 # invoked. If left blank `latex' will be used as the default command name. 633 633 634 634 LATEX_CMD_NAME = latex 635 635 636 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 637 # generate index for LaTeX. If left blank `makeindex' will be used as the 636 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 637 # generate index for LaTeX. If left blank `makeindex' will be used as the 638 638 # default command name. 639 639 640 640 MAKEINDEX_CMD_NAME = makeindex 641 641 642 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 643 # LaTeX documents. This may be useful for small projects and may help to 642 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 643 # LaTeX documents. This may be useful for small projects and may help to 644 644 # save some trees in general. 645 645 646 646 COMPACT_LATEX = YES 647 647 648 # The PAPER_TYPE tag can be used to set the paper type that is used 649 # by the printer. Possible values are: a4, a4wide, letter, legal and 648 # The PAPER_TYPE tag can be used to set the paper type that is used 649 # by the printer. Possible values are: a4, a4wide, letter, legal and 650 650 # executive. If left blank a4wide will be used. 651 651 652 652 PAPER_TYPE = letter 653 653 654 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 654 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 655 655 # packages that should be included in the LaTeX output. 656 656 657 657 EXTRA_PACKAGES = times 658 658 659 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 660 # the generated latex document. The header should contain everything until 661 # the first chapter. If it is left blank doxygen will generate a 659 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 660 # the generated latex document. The header should contain everything until 661 # the first chapter. If it is left blank doxygen will generate a 662 662 # standard header. Notice: only use this tag if you know what you are doing! 663 663 664 LATEX_HEADER = 665 666 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 667 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 668 # contain links (just like the HTML output) instead of page references 664 LATEX_HEADER = 665 666 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 667 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 668 # contain links (just like the HTML output) instead of page references 669 669 # This makes the output suitable for online browsing using a pdf viewer. 670 670 671 671 PDF_HYPERLINKS = YES 672 672 673 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 674 # plain latex in the generated Makefile. Set this option to YES to get a 673 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 674 # plain latex in the generated Makefile. Set this option to YES to get a 675 675 # higher quality PDF documentation. 676 676 677 677 USE_PDFLATEX = YES 678 678 679 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 680 # command to the generated LaTeX files. This will instruct LaTeX to keep 681 # running if errors occur, instead of asking the user for help. 679 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 680 # command to the generated LaTeX files. This will instruct LaTeX to keep 681 # running if errors occur, instead of asking the user for help. 682 682 # This option is also used when generating formulas in HTML. 683 683 684 684 LATEX_BATCHMODE = NO 685 685 686 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 687 # include the index chapters (such as File Index, Compound Index, etc.) 686 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 687 # include the index chapters (such as File Index, Compound Index, etc.) 688 688 # in the output. 689 689 … … 694 694 #--------------------------------------------------------------------------- 695 695 696 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 697 # The RTF output is optimised for Word 97 and may not look very pretty with 696 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 697 # The RTF output is optimised for Word 97 and may not look very pretty with 698 698 # other RTF readers or editors. 699 699 700 700 GENERATE_RTF = NO 701 701 702 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 703 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 702 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 703 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 704 704 # put in front of it. If left blank `rtf' will be used as the default path. 705 705 706 706 RTF_OUTPUT = rtf 707 707 708 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 708 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 709 709 # RTF documents. This may be useful for small projects and may help to 710 710 # save some trees in general. … … 712 712 COMPACT_RTF = NO 713 713 714 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 715 # will contain hyperlink fields. The RTF file will 716 # contain links (just like the HTML output) instead of page references. 717 # This makes the output suitable for online browsing using WORD or other 718 # programs which support those fields. 714 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 715 # will contain hyperlink fields. The RTF file will 716 # contain links (just like the HTML output) instead of page references. 717 # This makes the output suitable for online browsing using WORD or other 718 # programs which support those fields. 719 719 # Note: wordpad (write) and others do not support links. 720 720 721 721 RTF_HYPERLINKS = NO 722 722 723 # Load stylesheet definitions from file. Syntax is similar to doxygen's 724 # config file, i.e. a series of assigments. You only have to provide 723 # Load stylesheet definitions from file. Syntax is similar to doxygen's 724 # config file, i.e. a series of assigments. You only have to provide 725 725 # replacements, missing definitions are set to their default value. 726 726 727 RTF_STYLESHEET_FILE = 728 729 # Set optional variables used in the generation of an rtf document. 727 RTF_STYLESHEET_FILE = 728 729 # Set optional variables used in the generation of an rtf document. 730 730 # Syntax is similar to doxygen's config file. 731 731 732 RTF_EXTENSIONS_FILE = 732 RTF_EXTENSIONS_FILE = 733 733 734 734 #--------------------------------------------------------------------------- … … 736 736 #--------------------------------------------------------------------------- 737 737 738 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 738 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 739 739 # generate man pages 740 740 741 741 GENERATE_MAN = YES 742 742 743 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 744 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 743 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 744 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 745 745 # put in front of it. If left blank `man' will be used as the default path. 746 746 … … 752 752 MAN_EXTENSION = .3 753 753 754 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 755 # then it will generate one additional man file for each entity 756 # documented in the real man page(s). These additional files 757 # only source the real man page, but without them the man command 754 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 755 # then it will generate one additional man file for each entity 756 # documented in the real man page(s). These additional files 757 # only source the real man page, but without them the man command 758 758 # would be unable to find the correct page. The default is NO. 759 759 … … 764 764 #--------------------------------------------------------------------------- 765 765 766 # If the GENERATE_XML tag is set to YES Doxygen will 767 # generate an XML file that captures the structure of 768 # the code including all documentation. Note that this 769 # feature is still experimental and incomplete at the 766 # If the GENERATE_XML tag is set to YES Doxygen will 767 # generate an XML file that captures the structure of 768 # the code including all documentation. Note that this 769 # feature is still experimental and incomplete at the 770 770 # moment. 771 771 772 772 GENERATE_XML = NO 773 773 774 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 775 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 774 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 775 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 776 776 # put in front of it. If left blank `xml' will be used as the default path. 777 777 778 778 XML_OUTPUT = xml 779 779 780 # The XML_SCHEMA tag can be used to specify an XML schema, 781 # which can be used by a validating XML parser to check the 780 # The XML_SCHEMA tag can be used to specify an XML schema, 781 # which can be used by a validating XML parser to check the 782 782 # syntax of the XML files. 783 783 784 XML_SCHEMA = 785 786 # The XML_DTD tag can be used to specify an XML DTD, 787 # which can be used by a validating XML parser to check the 784 XML_SCHEMA = 785 786 # The XML_DTD tag can be used to specify an XML DTD, 787 # which can be used by a validating XML parser to check the 788 788 # syntax of the XML files. 789 789 790 XML_DTD = 790 XML_DTD = 791 791 792 792 #--------------------------------------------------------------------------- … … 794 794 #--------------------------------------------------------------------------- 795 795 796 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 797 # generate an AutoGen Definitions (see autogen.sf.net) file 798 # that captures the structure of the code including all 799 # documentation. Note that this feature is still experimental 796 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 797 # generate an AutoGen Definitions (see autogen.sf.net) file 798 # that captures the structure of the code including all 799 # documentation. Note that this feature is still experimental 800 800 # and incomplete at the moment. 801 801 … … 806 806 #--------------------------------------------------------------------------- 807 807 808 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 809 # generate a Perl module file that captures the structure of 810 # the code including all documentation. Note that this 811 # feature is still experimental and incomplete at the 808 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 809 # generate a Perl module file that captures the structure of 810 # the code including all documentation. Note that this 811 # feature is still experimental and incomplete at the 812 812 # moment. 813 813 814 814 GENERATE_PERLMOD = NO 815 815 816 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 817 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 816 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 817 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 818 818 # to generate PDF and DVI output from the Perl module output. 819 819 820 820 PERLMOD_LATEX = NO 821 821 822 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 823 # nicely formatted so it can be parsed by a human reader. This is useful 824 # if you want to understand what is going on. On the other hand, if this 825 # tag is set to NO the size of the Perl module output will be much smaller 822 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 823 # nicely formatted so it can be parsed by a human reader. This is useful 824 # if you want to understand what is going on. On the other hand, if this 825 # tag is set to NO the size of the Perl module output will be much smaller 826 826 # and Perl will parse it just the same. 827 827 828 828 PERLMOD_PRETTY = YES 829 829 830 # The names of the make variables in the generated doxyrules.make file 831 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 832 # This is useful so different doxyrules.make files included by the same 830 # The names of the make variables in the generated doxyrules.make file 831 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 832 # This is useful so different doxyrules.make files included by the same 833 833 # Makefile don't overwrite each other's variables. 834 834 835 PERLMOD_MAKEVAR_PREFIX = 835 PERLMOD_MAKEVAR_PREFIX = 836 836 837 837 #--------------------------------------------------------------------------- … … 845 845 ENABLE_PREPROCESSING = YES 846 846 847 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 848 # names in the source code. If set to NO (the default) only conditional 849 # compilation will be performed. Macro expansion can be done in a controlled 847 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 848 # names in the source code. If set to NO (the default) only conditional 849 # compilation will be performed. Macro expansion can be done in a controlled 850 850 # way by setting EXPAND_ONLY_PREDEF to YES. 851 851 852 852 MACRO_EXPANSION = NO 853 853 854 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 855 # then the macro expansion is limited to the macros specified with the 854 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 855 # then the macro expansion is limited to the macros specified with the 856 856 # PREDEFINED and EXPAND_AS_PREDEFINED tags. 857 857 858 858 EXPAND_ONLY_PREDEF = NO 859 859 860 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 860 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 861 861 # in the INCLUDE_PATH (see below) will be search if a #include is found. 862 862 863 863 SEARCH_INCLUDES = YES 864 864 865 # The INCLUDE_PATH tag can be used to specify one or more directories that 866 # contain include files that are not input files but should be processed by 865 # The INCLUDE_PATH tag can be used to specify one or more directories that 866 # contain include files that are not input files but should be processed by 867 867 # the preprocessor. 868 868 869 869 INCLUDE_PATH = 870 870 871 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 872 # patterns (like *.h and *.hpp) to filter out the header-files in the 873 # directories. If left blank, the patterns specified with FILE_PATTERNS will 871 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 872 # patterns (like *.h and *.hpp) to filter out the header-files in the 873 # directories. If left blank, the patterns specified with FILE_PATTERNS will 874 874 # be used. 875 875 876 INCLUDE_FILE_PATTERNS = 877 878 # The PREDEFINED tag can be used to specify one or more macro names that 876 INCLUDE_FILE_PATTERNS = 877 878 # The PREDEFINED tag can be used to specify one or more macro names that 879 879 # are defined before the preprocessor is started (similar to the -D option of 880 880 # gcc). The argument of the tag is a list of macros of the form: name … … 886 886 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 887 887 # this tag can be used to specify a list of macro names that should be expanded. 888 # The macro definition that is found in the sources will be used. 888 # The macro definition that is found in the sources will be used. 889 889 # Use the PREDEFINED tag if you want to use a different macro definition. 890 890 891 EXPAND_AS_DEFINED = 892 893 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 894 # doxygen's preprocessor will remove all function-like macros that are alone 895 # on a line, have an all uppercase name, and do not end with a semicolon. Such 896 # function macros are typically used for boiler-plate code, and will confuse the 891 EXPAND_AS_DEFINED = 892 893 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 894 # doxygen's preprocessor will remove all function-like macros that are alone 895 # on a line, have an all uppercase name, and do not end with a semicolon. Such 896 # function macros are typically used for boiler-plate code, and will confuse the 897 897 # parser if not removed. 898 898 … … 900 900 901 901 #--------------------------------------------------------------------------- 902 # Configuration::addtions related to external references 903 #--------------------------------------------------------------------------- 904 905 # The TAGFILES option can be used to specify one or more tagfiles. 906 # Optionally an initial location of the external documentation 907 # can be added for each tagfile. The format of a tag file without 908 # this location is as follows: 902 # Configuration::addtions related to external references 903 #--------------------------------------------------------------------------- 904 905 # The TAGFILES option can be used to specify one or more tagfiles. 906 # Optionally an initial location of the external documentation 907 # can be added for each tagfile. The format of a tag file without 908 # this location is as follows: 909 909 # TAGFILES = file1 file2 ... 910 # Adding location for the tag files is done as follows: 911 # TAGFILES = file1=loc1 "file2 = loc2" ... 912 # where "loc1" and "loc2" can be relative or absolute paths or 913 # URLs. If a location is present for each tag, the installdox tool 910 # Adding location for the tag files is done as follows: 911 # TAGFILES = file1=loc1 "file2 = loc2" ... 912 # where "loc1" and "loc2" can be relative or absolute paths or 913 # URLs. If a location is present for each tag, the installdox tool 914 914 # does not have to be run to correct the links. 915 915 # Note that each tag file must have a unique name 916 916 # (where the name does NOT include the path) 917 # If a tag file is not located in the directory in which doxygen 917 # If a tag file is not located in the directory in which doxygen 918 918 # is run, you must also specify the path to the tagfile here. 919 919 920 920 TAGFILES = 921 921 922 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 922 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 923 923 # a tag file that is based on the input files it reads. 924 924 925 925 GENERATE_TAGFILE = 926 926 927 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 928 # in the class index. If set to NO only the inherited external classes 927 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 928 # in the class index. If set to NO only the inherited external classes 929 929 # will be listed. 930 930 931 931 ALLEXTERNALS = NO 932 932 933 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 934 # in the modules index. If set to NO, only the current project's groups will 933 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 934 # in the modules index. If set to NO, only the current project's groups will 935 935 # be listed. 936 936 937 937 EXTERNAL_GROUPS = YES 938 938 939 # The PERL_PATH should be the absolute path and name of the perl script 939 # The PERL_PATH should be the absolute path and name of the perl script 940 940 # interpreter (i.e. the result of `which perl'). 941 941 … … 943 943 944 944 #--------------------------------------------------------------------------- 945 # Configuration options related to the dot tool 946 #--------------------------------------------------------------------------- 947 948 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 945 # Configuration options related to the dot tool 946 #--------------------------------------------------------------------------- 947 948 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 949 949 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 950 # super classes. Setting the tag to NO turns the diagrams off. Note that this 951 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is 950 # super classes. Setting the tag to NO turns the diagrams off. Note that this 951 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is 952 952 # recommended to install and use dot, since it yields more powerful graphs. 953 953 954 954 CLASS_DIAGRAMS = YES 955 955 956 # If set to YES, the inheritance and collaboration graphs will hide 957 # inheritance and usage relations if the target is undocumented 956 # If set to YES, the inheritance and collaboration graphs will hide 957 # inheritance and usage relations if the target is undocumented 958 958 # or is not a class. 959 959 960 960 HIDE_UNDOC_RELATIONS = YES 961 961 962 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 963 # available from the path. This tool is part of Graphviz, a graph visualization 964 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 962 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 963 # available from the path. This tool is part of Graphviz, a graph visualization 964 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 965 965 # have no effect if this option is set to NO (the default) 966 966 967 967 HAVE_DOT = YES 968 968 969 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 970 # will generate a graph for each documented class showing the direct and 971 # indirect inheritance relations. Setting this tag to YES will force the 969 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 970 # will generate a graph for each documented class showing the direct and 971 # indirect inheritance relations. Setting this tag to YES will force the 972 972 # the CLASS_DIAGRAMS tag to NO. 973 973 974 974 CLASS_GRAPH = YES 975 975 976 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 977 # will generate a graph for each documented class showing the direct and 978 # indirect implementation dependencies (inheritance, containment, and 976 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 977 # will generate a graph for each documented class showing the direct and 978 # indirect implementation dependencies (inheritance, containment, and 979 979 # class references variables) of the class with other documented classes. 980 980 981 981 COLLABORATION_GRAPH = YES 982 982 983 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 984 # collaboration diagrams in a style similiar to the OMG's Unified Modeling 983 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 984 # collaboration diagrams in a style similiar to the OMG's Unified Modeling 985 985 # Language. 986 986 … … 992 992 TEMPLATE_RELATIONS = YES 993 993 994 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 995 # tags are set to YES then doxygen will generate a graph for each documented 996 # file showing the direct and indirect include dependencies of the file with 994 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 995 # tags are set to YES then doxygen will generate a graph for each documented 996 # file showing the direct and indirect include dependencies of the file with 997 997 # other documented files. 998 998 999 999 INCLUDE_GRAPH = YES 1000 1000 1001 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1002 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1003 # documented header file showing the documented files that directly or 1001 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1002 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1003 # documented header file showing the documented files that directly or 1004 1004 # indirectly include this file. 1005 1005 1006 1006 INCLUDED_BY_GRAPH = YES 1007 1007 1008 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1009 # generate a call dependency graph for every global function or class method. 1010 # Note that enabling this option will significantly increase the time of a run. 1011 # So in most cases it will be better to enable call graphs for selected 1008 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1009 # generate a call dependency graph for every global function or class method. 1010 # Note that enabling this option will significantly increase the time of a run. 1011 # So in most cases it will be better to enable call graphs for selected 1012 1012 # functions only using the \callgraph command. 1013 1013 1014 1014 CALL_GRAPH = NO 1015 1015 1016 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1016 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1017 1017 # will graphical hierarchy of all classes instead of a textual one. 1018 1018 1019 1019 GRAPHICAL_HIERARCHY = YES 1020 1020 1021 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1021 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1022 1022 # generated by dot. Possible values are png, jpg, or gif 1023 1023 # If left blank png will be used. … … 1025 1025 DOT_IMAGE_FORMAT = png 1026 1026 1027 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1027 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1028 1028 # found. If left blank, it is assumed the dot tool can be found on the path. 1029 1029 1030 DOT_PATH = 1031 1032 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1033 # contain dot files that are included in the documentation (see the 1030 DOT_PATH = 1031 1032 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1033 # contain dot files that are included in the documentation (see the 1034 1034 # \dotfile command). 1035 1035 1036 DOTFILE_DIRS = 1037 1038 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1039 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1040 # this value, doxygen will try to truncate the graph, so that it fits within 1041 # the specified constraint. Beware that most browsers cannot cope with very 1036 DOTFILE_DIRS = 1037 1038 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1039 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1040 # this value, doxygen will try to truncate the graph, so that it fits within 1041 # the specified constraint. Beware that most browsers cannot cope with very 1042 1042 # large images. 1043 1043 1044 1044 MAX_DOT_GRAPH_WIDTH = 1024 1045 1045 1046 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1047 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1048 # this value, doxygen will try to truncate the graph, so that it fits within 1049 # the specified constraint. Beware that most browsers cannot cope with very 1046 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1047 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1048 # this value, doxygen will try to truncate the graph, so that it fits within 1049 # the specified constraint. Beware that most browsers cannot cope with very 1050 1050 # large images. 1051 1051 1052 1052 MAX_DOT_GRAPH_HEIGHT = 1024 1053 1053 1054 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1055 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1056 # from the root by following a path via at most 3 edges will be shown. Nodes that 1057 # lay further from the root node will be omitted. Note that setting this option to 1058 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 1059 # note that a graph may be further truncated if the graph's image dimensions are 1060 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 1054 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1055 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1056 # from the root by following a path via at most 3 edges will be shown. Nodes that 1057 # lay further from the root node will be omitted. Note that setting this option to 1058 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 1059 # note that a graph may be further truncated if the graph's image dimensions are 1060 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 1061 1061 # If 0 is used for the depth value (the default), the graph is not depth-constrained. 1062 1062 1063 1063 MAX_DOT_GRAPH_DEPTH = 0 1064 1064 1065 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1066 # generate a legend page explaining the meaning of the various boxes and 1065 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1066 # generate a legend page explaining the meaning of the various boxes and 1067 1067 # arrows in the dot generated graphs. 1068 1068 1069 1069 GENERATE_LEGEND = YES 1070 1070 1071 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1072 # remove the intermediate dot files that are used to generate 1071 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1072 # remove the intermediate dot files that are used to generate 1073 1073 # the various graphs. 1074 1074 … … 1076 1076 1077 1077 #--------------------------------------------------------------------------- 1078 # Configuration::addtions related to the search engine 1079 #--------------------------------------------------------------------------- 1080 1081 # The SEARCHENGINE tag specifies whether or not a search engine should be 1078 # Configuration::addtions related to the search engine 1079 #--------------------------------------------------------------------------- 1080 1081 # The SEARCHENGINE tag specifies whether or not a search engine should be 1082 1082 # used. If set to NO the values of all tags below this one will be ignored. 1083 1083
Note:
See TracChangeset
for help on using the changeset viewer.
