Warning, /geant4/source/visualization/OpenGL/Doxyfile is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.3.4
0002
0003 # This file describes the settings to be used by the documentation system
0004 # doxygen (www.doxygen.org) for a project
0005 #
0006 # All text after a hash (#) is considered a comment and will be ignored
0007 # The format is:
0008 # TAG = value [value, ...]
0009 # For lists items can also be appended using:
0010 # TAG += value [value, ...]
0011 # Values that contain spaces should be placed between quotes (" ")
0012
0013 #---------------------------------------------------------------------------
0014 # Project related configuration options
0015 #---------------------------------------------------------------------------
0016
0017 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
0018 # by quotes) that should identify the project.
0019
0020 PROJECT_NAME = G4OpenGL
0021
0022 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
0023 # This could be handy for archiving the generated documentation or
0024 # if some version control system is used.
0025
0026 PROJECT_NUMBER = vis-V05-01-01
0027
0028 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
0029 # base path where the generated documentation will be put.
0030 # If a relative path is entered, it will be relative to the location
0031 # where doxygen was started. If left blank the current directory will be used.
0032
0033 OUTPUT_DIRECTORY = $(G4WORKDIR)/tmp/$(G4SYSTEM)/G4OpenGL
0034
0035 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
0036 # documentation generated by doxygen is written. Doxygen will use this
0037 # information to generate all constant output in the proper language.
0038 # The default language is English, other supported languages are:
0039 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
0040 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
0041 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
0042 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
0043
0044 OUTPUT_LANGUAGE = English
0045
0046 # This tag can be used to specify the encoding used in the generated output.
0047 # The encoding is not always determined by the language that is chosen,
0048 # but also whether or not the output is meant for Windows or non-Windows users.
0049 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
0050 # forces the Windows encoding (this is the default for the Windows binary),
0051 # whereas setting the tag to NO uses a Unix-style encoding (the default for
0052 # all platforms other than Windows).
0053
0054 USE_WINDOWS_ENCODING = NO
0055
0056 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
0057 # include brief member descriptions after the members that are listed in
0058 # the file and class documentation (similar to JavaDoc).
0059 # Set to NO to disable this.
0060
0061 BRIEF_MEMBER_DESC = YES
0062
0063 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
0064 # the brief description of a member or function before the detailed description.
0065 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0066 # brief descriptions will be completely suppressed.
0067
0068 REPEAT_BRIEF = YES
0069
0070 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
0071 # Doxygen will generate a detailed section even if there is only a brief
0072 # description.
0073
0074 ALWAYS_DETAILED_SEC = NO
0075
0076 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
0077 # members of a class in the documentation of that class as if those members were
0078 # ordinary class members. Constructors, destructors and assignment operators of
0079 # the base classes will not be shown.
0080
0081 INLINE_INHERITED_MEMB = NO
0082
0083 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
0084 # path before files name in the file list and in the header files. If set
0085 # to NO the shortest path that makes the file name unique will be used.
0086
0087 FULL_PATH_NAMES = NO
0088
0089 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
0090 # can be used to strip a user-defined part of the path. Stripping is
0091 # only done if one of the specified strings matches the left-hand part of
0092 # the path. It is allowed to use relative paths in the argument list.
0093
0094 STRIP_FROM_PATH =
0095
0096 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
0097 # (but less readable) file names. This can be useful is your file systems
0098 # doesn't support long names like on DOS, Mac, or CD-ROM.
0099
0100 SHORT_NAMES = NO
0101
0102 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
0103 # will interpret the first line (until the first dot) of a JavaDoc-style
0104 # comment as the brief description. If set to NO, the JavaDoc
0105 # comments will behave just like the Qt-style comments (thus requiring an
0106 # explict @brief command for a brief description.
0107
0108 JAVADOC_AUTOBRIEF = NO
0109
0110 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
0111 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
0112 # comments) as a brief description. This used to be the default behaviour.
0113 # The new default is to treat a multi-line C++ comment block as a detailed
0114 # description. Set this tag to YES if you prefer the old behaviour instead.
0115
0116 MULTILINE_CPP_IS_BRIEF = NO
0117
0118 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
0119 # will output the detailed description near the top, like JavaDoc.
0120 # If set to NO, the detailed description appears after the member
0121 # documentation.
0122
0123 DETAILS_AT_TOP = NO
0124
0125 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
0126 # member inherits the documentation from any documented member that it
0127 # reimplements.
0128
0129 INHERIT_DOCS = YES
0130
0131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
0132 # tag is set to YES, then doxygen will reuse the documentation of the first
0133 # member in the group (if any) for the other members of the group. By default
0134 # all members of a group must be documented explicitly.
0135
0136 DISTRIBUTE_GROUP_DOC = NO
0137
0138 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
0139 # Doxygen uses this value to replace tabs by spaces in code fragments.
0140
0141 TAB_SIZE = 8
0142
0143 # This tag can be used to specify a number of aliases that acts
0144 # as commands in the documentation. An alias has the form "name=value".
0145 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
0146 # put the command \sideeffect (or @sideeffect) in the documentation, which
0147 # will result in a user-defined paragraph with heading "Side Effects:".
0148 # You can put \n's in the value part of an alias to insert newlines.
0149
0150 ALIASES =
0151
0152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
0153 # only. Doxygen will then generate output that is more tailored for C.
0154 # For instance, some of the names that are used will be different. The list
0155 # of all members will be omitted, etc.
0156
0157 OPTIMIZE_OUTPUT_FOR_C = NO
0158
0159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
0160 # only. Doxygen will then generate output that is more tailored for Java.
0161 # For instance, namespaces will be presented as packages, qualified scopes
0162 # will look different, etc.
0163
0164 OPTIMIZE_OUTPUT_JAVA = NO
0165
0166 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
0167 # the same type (for instance a group of public functions) to be put as a
0168 # subgroup of that type (e.g. under the Public Functions section). Set it to
0169 # NO to prevent subgrouping. Alternatively, this can be done per class using
0170 # the \nosubgrouping command.
0171
0172 SUBGROUPING = YES
0173
0174 #---------------------------------------------------------------------------
0175 # Build related configuration options
0176 #---------------------------------------------------------------------------
0177
0178 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
0179 # documentation are documented, even if no documentation was available.
0180 # Private class members and static file members will be hidden unless
0181 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
0182
0183 EXTRACT_ALL = YES
0184
0185 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
0186 # will be included in the documentation.
0187
0188 EXTRACT_PRIVATE = YES
0189
0190 # If the EXTRACT_STATIC tag is set to YES all static members of a file
0191 # will be included in the documentation.
0192
0193 EXTRACT_STATIC = YES
0194
0195 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
0196 # defined locally in source files will be included in the documentation.
0197 # If set to NO only classes defined in header files are included.
0198
0199 EXTRACT_LOCAL_CLASSES = YES
0200
0201 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
0202 # undocumented members of documented classes, files or namespaces.
0203 # If set to NO (the default) these members will be included in the
0204 # various overviews, but no documentation section is generated.
0205 # This option has no effect if EXTRACT_ALL is enabled.
0206
0207 HIDE_UNDOC_MEMBERS = NO
0208
0209 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
0210 # undocumented classes that are normally visible in the class hierarchy.
0211 # If set to NO (the default) these classes will be included in the various
0212 # overviews. This option has no effect if EXTRACT_ALL is enabled.
0213
0214 HIDE_UNDOC_CLASSES = NO
0215
0216 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
0217 # friend (class|struct|union) declarations.
0218 # If set to NO (the default) these declarations will be included in the
0219 # documentation.
0220
0221 HIDE_FRIEND_COMPOUNDS = NO
0222
0223 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
0224 # documentation blocks found inside the body of a function.
0225 # If set to NO (the default) these blocks will be appended to the
0226 # function's detailed documentation block.
0227
0228 HIDE_IN_BODY_DOCS = NO
0229
0230 # The INTERNAL_DOCS tag determines if documentation
0231 # that is typed after a \internal command is included. If the tag is set
0232 # to NO (the default) then the documentation will be excluded.
0233 # Set it to YES to include the internal documentation.
0234
0235 INTERNAL_DOCS = NO
0236
0237 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
0238 # file names in lower-case letters. If set to YES upper-case letters are also
0239 # allowed. This is useful if you have classes or files whose names only differ
0240 # in case and if your file system supports case sensitive file names. Windows
0241 # users are advised to set this option to NO.
0242
0243 CASE_SENSE_NAMES = YES
0244
0245 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
0246 # will show members with their full class and namespace scopes in the
0247 # documentation. If set to YES the scope will be hidden.
0248
0249 HIDE_SCOPE_NAMES = NO
0250
0251 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
0252 # will put a list of the files that are included by a file in the documentation
0253 # of that file.
0254
0255 SHOW_INCLUDE_FILES = YES
0256
0257 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
0258 # is inserted in the documentation for inline members.
0259
0260 INLINE_INFO = YES
0261
0262 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
0263 # will sort the (detailed) documentation of file and class members
0264 # alphabetically by member name. If set to NO the members will appear in
0265 # declaration order.
0266
0267 SORT_MEMBER_DOCS = YES
0268
0269 # The GENERATE_TODOLIST tag can be used to enable (YES) or
0270 # disable (NO) the todo list. This list is created by putting \todo
0271 # commands in the documentation.
0272
0273 GENERATE_TODOLIST = YES
0274
0275 # The GENERATE_TESTLIST tag can be used to enable (YES) or
0276 # disable (NO) the test list. This list is created by putting \test
0277 # commands in the documentation.
0278
0279 GENERATE_TESTLIST = YES
0280
0281 # The GENERATE_BUGLIST tag can be used to enable (YES) or
0282 # disable (NO) the bug list. This list is created by putting \bug
0283 # commands in the documentation.
0284
0285 GENERATE_BUGLIST = YES
0286
0287 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
0288 # disable (NO) the deprecated list. This list is created by putting
0289 # \deprecated commands in the documentation.
0290
0291 GENERATE_DEPRECATEDLIST= YES
0292
0293 # The ENABLED_SECTIONS tag can be used to enable conditional
0294 # documentation sections, marked by \if sectionname ... \endif.
0295
0296 ENABLED_SECTIONS =
0297
0298 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
0299 # the initial value of a variable or define consists of for it to appear in
0300 # the documentation. If the initializer consists of more lines than specified
0301 # here it will be hidden. Use a value of 0 to hide initializers completely.
0302 # The appearance of the initializer of individual variables and defines in the
0303 # documentation can be controlled using \showinitializer or \hideinitializer
0304 # command in the documentation regardless of this setting.
0305
0306 MAX_INITIALIZER_LINES = 30
0307
0308 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
0309 # at the bottom of the documentation of classes and structs. If set to YES the
0310 # list will mention the files that were used to generate the documentation.
0311
0312 SHOW_USED_FILES = YES
0313
0314 #---------------------------------------------------------------------------
0315 # configuration options related to warning and progress messages
0316 #---------------------------------------------------------------------------
0317
0318 # The QUIET tag can be used to turn on/off the messages that are generated
0319 # by doxygen. Possible values are YES and NO. If left blank NO is used.
0320
0321 QUIET = YES
0322
0323 # The WARNINGS tag can be used to turn on/off the warning messages that are
0324 # generated by doxygen. Possible values are YES and NO. If left blank
0325 # NO is used.
0326
0327 WARNINGS = YES
0328
0329 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
0330 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
0331 # automatically be disabled.
0332
0333 WARN_IF_UNDOCUMENTED = YES
0334
0335 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
0336 # potential errors in the documentation, such as not documenting some
0337 # parameters in a documented function, or documenting parameters that
0338 # don't exist or using markup commands wrongly.
0339
0340 WARN_IF_DOC_ERROR = YES
0341
0342 # The WARN_FORMAT tag determines the format of the warning messages that
0343 # doxygen can produce. The string should contain the $file, $line, and $text
0344 # tags, which will be replaced by the file and line number from which the
0345 # warning originated and the warning text.
0346
0347 WARN_FORMAT = "$file:$line: $text"
0348
0349 # The WARN_LOGFILE tag can be used to specify a file to which warning
0350 # and error messages should be written. If left blank the output is written
0351 # to stderr.
0352
0353 WARN_LOGFILE =
0354
0355 #---------------------------------------------------------------------------
0356 # configuration options related to the input files
0357 #---------------------------------------------------------------------------
0358
0359 # The INPUT tag can be used to specify the files and/or directories that contain
0360 # documented source files. You may enter file names like "myfile.cpp" or
0361 # directories like "/usr/src/myproject". Separate the files or directories
0362 # with spaces.
0363
0364 INPUT = include \
0365 src \
0366 ../management/include \
0367 ../management/src \
0368 ../modeling/include \
0369 ../modeling/src \
0370 ../../graphics_reps/include/G4VGraphicsScene.hh \
0371 ../../graphics_reps/include/G4VVisManager.hh \
0372 ../../graphics_reps/src/G4VVisManager.cc
0373
0374 # If the value of the INPUT tag contains directories, you can use the
0375 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0376 # and *.h) to filter out the source-files in the directories. If left
0377 # blank the following patterns are tested:
0378 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
0379 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
0380
0381 FILE_PATTERNS =
0382
0383 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
0384 # should be searched for input files as well. Possible values are YES and NO.
0385 # If left blank NO is used.
0386
0387 RECURSIVE = NO
0388
0389 # The EXCLUDE tag can be used to specify files and/or directories that should
0390 # excluded from the INPUT source files. This way you can easily exclude a
0391 # subdirectory from a directory tree whose root is specified with the INPUT tag.
0392
0393 EXCLUDE =
0394
0395 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
0396 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
0397
0398 EXCLUDE_SYMLINKS = NO
0399
0400 # If the value of the INPUT tag contains directories, you can use the
0401 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
0402 # certain files from those directories.
0403
0404 EXCLUDE_PATTERNS = *Command*
0405
0406 # The EXAMPLE_PATH tag can be used to specify one or more files or
0407 # directories that contain example code fragments that are included (see
0408 # the \include command).
0409
0410 EXAMPLE_PATH =
0411
0412 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
0413 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0414 # and *.h) to filter out the source-files in the directories. If left
0415 # blank all files are included.
0416
0417 EXAMPLE_PATTERNS =
0418
0419 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
0420 # searched for input files to be used with the \include or \dontinclude
0421 # commands irrespective of the value of the RECURSIVE tag.
0422 # Possible values are YES and NO. If left blank NO is used.
0423
0424 EXAMPLE_RECURSIVE = NO
0425
0426 # The IMAGE_PATH tag can be used to specify one or more files or
0427 # directories that contain image that are included in the documentation (see
0428 # the \image command).
0429
0430 IMAGE_PATH =
0431
0432 # The INPUT_FILTER tag can be used to specify a program that doxygen should
0433 # invoke to filter for each input file. Doxygen will invoke the filter program
0434 # by executing (via popen()) the command <filter> <input-file>, where <filter>
0435 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
0436 # input file. Doxygen will then use the output that the filter program writes
0437 # to standard output.
0438
0439 INPUT_FILTER =
0440
0441 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
0442 # INPUT_FILTER) will be used to filter the input files when producing source
0443 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
0444
0445 FILTER_SOURCE_FILES = NO
0446
0447 #---------------------------------------------------------------------------
0448 # configuration options related to source browsing
0449 #---------------------------------------------------------------------------
0450
0451 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
0452 # be generated. Documented entities will be cross-referenced with these sources.
0453
0454 SOURCE_BROWSER = YES
0455
0456 # Setting the INLINE_SOURCES tag to YES will include the body
0457 # of functions and classes directly in the documentation.
0458
0459 INLINE_SOURCES = NO
0460
0461 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
0462 # doxygen to hide any special comment blocks from generated source code
0463 # fragments. Normal C and C++ comments will always remain visible.
0464
0465 STRIP_CODE_COMMENTS = YES
0466
0467 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
0468 # then for each documented function all documented
0469 # functions referencing it will be listed.
0470
0471 REFERENCED_BY_RELATION = YES
0472
0473 # If the REFERENCES_RELATION tag is set to YES (the default)
0474 # then for each documented function all documented entities
0475 # called/used by that function will be listed.
0476
0477 REFERENCES_RELATION = YES
0478
0479 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
0480 # will generate a verbatim copy of the header file for each class for
0481 # which an include is specified. Set to NO to disable this.
0482
0483 VERBATIM_HEADERS = YES
0484
0485 #---------------------------------------------------------------------------
0486 # configuration options related to the alphabetical class index
0487 #---------------------------------------------------------------------------
0488
0489 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
0490 # of all compounds will be generated. Enable this if the project
0491 # contains a lot of classes, structs, unions or interfaces.
0492
0493 ALPHABETICAL_INDEX = NO
0494
0495 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
0496 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
0497 # in which this list will be split (can be a number in the range [1..20])
0498
0499 COLS_IN_ALPHA_INDEX = 5
0500
0501 # In case all classes in a project start with a common prefix, all
0502 # classes will be put under the same header in the alphabetical index.
0503 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
0504 # should be ignored while generating the index headers.
0505
0506 IGNORE_PREFIX =
0507
0508 #---------------------------------------------------------------------------
0509 # configuration options related to the HTML output
0510 #---------------------------------------------------------------------------
0511
0512 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
0513 # generate HTML output.
0514
0515 GENERATE_HTML = YES
0516
0517 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
0518 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0519 # put in front of it. If left blank `html' will be used as the default path.
0520
0521 HTML_OUTPUT = html
0522
0523 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
0524 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
0525 # doxygen will generate files with .html extension.
0526
0527 HTML_FILE_EXTENSION = .html
0528
0529 # The HTML_HEADER tag can be used to specify a personal HTML header for
0530 # each generated HTML page. If it is left blank doxygen will generate a
0531 # standard header.
0532
0533 HTML_HEADER =
0534
0535 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
0536 # each generated HTML page. If it is left blank doxygen will generate a
0537 # standard footer.
0538
0539 HTML_FOOTER =
0540
0541 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
0542 # style sheet that is used by each HTML page. It can be used to
0543 # fine-tune the look of the HTML output. If the tag is left blank doxygen
0544 # will generate a default style sheet
0545
0546 HTML_STYLESHEET =
0547
0548 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
0549 # files or namespaces will be aligned in HTML using tables. If set to
0550 # NO a bullet list will be used.
0551
0552 HTML_ALIGN_MEMBERS = YES
0553
0554 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
0555 # will be generated that can be used as input for tools like the
0556 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
0557 # of the generated HTML documentation.
0558
0559 GENERATE_HTMLHELP = NO
0560
0561 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
0562 # be used to specify the file name of the resulting .chm file. You
0563 # can add a path in front of the file if the result should not be
0564 # written to the html output dir.
0565
0566 CHM_FILE =
0567
0568 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
0569 # be used to specify the location (absolute path including file name) of
0570 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
0571 # the HTML help compiler on the generated index.hhp.
0572
0573 HHC_LOCATION =
0574
0575 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
0576 # controls if a separate .chi index file is generated (YES) or that
0577 # it should be included in the master .chm file (NO).
0578
0579 GENERATE_CHI = NO
0580
0581 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
0582 # controls whether a binary table of contents is generated (YES) or a
0583 # normal table of contents (NO) in the .chm file.
0584
0585 BINARY_TOC = NO
0586
0587 # The TOC_EXPAND flag can be set to YES to add extra items for group members
0588 # to the contents of the HTML help documentation and to the tree view.
0589
0590 TOC_EXPAND = NO
0591
0592 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
0593 # top of each HTML page. The value NO (the default) enables the index and
0594 # the value YES disables it.
0595
0596 DISABLE_INDEX = NO
0597
0598 # This tag can be used to set the number of enum values (range [1..20])
0599 # that doxygen will group on one line in the generated HTML documentation.
0600
0601 ENUM_VALUES_PER_LINE = 4
0602
0603 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
0604 # generated containing a tree-like index structure (just like the one that
0605 # is generated for HTML Help). For this to work a browser that supports
0606 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
0607 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
0608 # probably better off using the HTML help feature.
0609
0610 GENERATE_TREEVIEW = NO
0611
0612 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
0613 # used to set the initial width (in pixels) of the frame in which the tree
0614 # is shown.
0615
0616 TREEVIEW_WIDTH = 250
0617
0618 #---------------------------------------------------------------------------
0619 # configuration options related to the LaTeX output
0620 #---------------------------------------------------------------------------
0621
0622 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
0623 # generate Latex output.
0624
0625 GENERATE_LATEX = YES
0626
0627 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
0628 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0629 # put in front of it. If left blank `latex' will be used as the default path.
0630
0631 LATEX_OUTPUT = latex
0632
0633 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
0634 # invoked. If left blank `latex' will be used as the default command name.
0635
0636 LATEX_CMD_NAME = latex
0637
0638 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
0639 # generate index for LaTeX. If left blank `makeindex' will be used as the
0640 # default command name.
0641
0642 MAKEINDEX_CMD_NAME = makeindex
0643
0644 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
0645 # LaTeX documents. This may be useful for small projects and may help to
0646 # save some trees in general.
0647
0648 COMPACT_LATEX = NO
0649
0650 # The PAPER_TYPE tag can be used to set the paper type that is used
0651 # by the printer. Possible values are: a4, a4wide, letter, legal and
0652 # executive. If left blank a4wide will be used.
0653
0654 PAPER_TYPE = a4wide
0655
0656 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
0657 # packages that should be included in the LaTeX output.
0658
0659 EXTRA_PACKAGES =
0660
0661 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
0662 # the generated latex document. The header should contain everything until
0663 # the first chapter. If it is left blank doxygen will generate a
0664 # standard header. Notice: only use this tag if you know what you are doing!
0665
0666 LATEX_HEADER =
0667
0668 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
0669 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
0670 # contain links (just like the HTML output) instead of page references
0671 # This makes the output suitable for online browsing using a pdf viewer.
0672
0673 PDF_HYPERLINKS = NO
0674
0675 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
0676 # plain latex in the generated Makefile. Set this option to YES to get a
0677 # higher quality PDF documentation.
0678
0679 USE_PDFLATEX = NO
0680
0681 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
0682 # command to the generated LaTeX files. This will instruct LaTeX to keep
0683 # running if errors occur, instead of asking the user for help.
0684 # This option is also used when generating formulas in HTML.
0685
0686 LATEX_BATCHMODE = NO
0687
0688 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
0689 # include the index chapters (such as File Index, Compound Index, etc.)
0690 # in the output.
0691
0692 LATEX_HIDE_INDICES = NO
0693
0694 #---------------------------------------------------------------------------
0695 # configuration options related to the RTF output
0696 #---------------------------------------------------------------------------
0697
0698 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
0699 # The RTF output is optimised for Word 97 and may not look very pretty with
0700 # other RTF readers or editors.
0701
0702 GENERATE_RTF = NO
0703
0704 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
0705 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0706 # put in front of it. If left blank `rtf' will be used as the default path.
0707
0708 RTF_OUTPUT = rtf
0709
0710 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
0711 # RTF documents. This may be useful for small projects and may help to
0712 # save some trees in general.
0713
0714 COMPACT_RTF = NO
0715
0716 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
0717 # will contain hyperlink fields. The RTF file will
0718 # contain links (just like the HTML output) instead of page references.
0719 # This makes the output suitable for online browsing using WORD or other
0720 # programs which support those fields.
0721 # Note: wordpad (write) and others do not support links.
0722
0723 RTF_HYPERLINKS = NO
0724
0725 # Load stylesheet definitions from file. Syntax is similar to doxygen's
0726 # config file, i.e. a series of assigments. You only have to provide
0727 # replacements, missing definitions are set to their default value.
0728
0729 RTF_STYLESHEET_FILE =
0730
0731 # Set optional variables used in the generation of an rtf document.
0732 # Syntax is similar to doxygen's config file.
0733
0734 RTF_EXTENSIONS_FILE =
0735
0736 #---------------------------------------------------------------------------
0737 # configuration options related to the man page output
0738 #---------------------------------------------------------------------------
0739
0740 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
0741 # generate man pages
0742
0743 GENERATE_MAN = NO
0744
0745 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
0746 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0747 # put in front of it. If left blank `man' will be used as the default path.
0748
0749 MAN_OUTPUT = man
0750
0751 # The MAN_EXTENSION tag determines the extension that is added to
0752 # the generated man pages (default is the subroutine's section .3)
0753
0754 MAN_EXTENSION = .3
0755
0756 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
0757 # then it will generate one additional man file for each entity
0758 # documented in the real man page(s). These additional files
0759 # only source the real man page, but without them the man command
0760 # would be unable to find the correct page. The default is NO.
0761
0762 MAN_LINKS = NO
0763
0764 #---------------------------------------------------------------------------
0765 # configuration options related to the XML output
0766 #---------------------------------------------------------------------------
0767
0768 # If the GENERATE_XML tag is set to YES Doxygen will
0769 # generate an XML file that captures the structure of
0770 # the code including all documentation. Note that this
0771 # feature is still experimental and incomplete at the
0772 # moment.
0773
0774 GENERATE_XML = NO
0775
0776 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
0777 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0778 # put in front of it. If left blank `xml' will be used as the default path.
0779
0780 XML_OUTPUT = xml
0781
0782 # The XML_SCHEMA tag can be used to specify an XML schema,
0783 # which can be used by a validating XML parser to check the
0784 # syntax of the XML files.
0785
0786 XML_SCHEMA =
0787
0788 # The XML_DTD tag can be used to specify an XML DTD,
0789 # which can be used by a validating XML parser to check the
0790 # syntax of the XML files.
0791
0792 XML_DTD =
0793
0794 #---------------------------------------------------------------------------
0795 # configuration options for the AutoGen Definitions output
0796 #---------------------------------------------------------------------------
0797
0798 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
0799 # generate an AutoGen Definitions (see autogen.sf.net) file
0800 # that captures the structure of the code including all
0801 # documentation. Note that this feature is still experimental
0802 # and incomplete at the moment.
0803
0804 GENERATE_AUTOGEN_DEF = NO
0805
0806 #---------------------------------------------------------------------------
0807 # configuration options related to the Perl module output
0808 #---------------------------------------------------------------------------
0809
0810 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
0811 # generate a Perl module file that captures the structure of
0812 # the code including all documentation. Note that this
0813 # feature is still experimental and incomplete at the
0814 # moment.
0815
0816 GENERATE_PERLMOD = NO
0817
0818 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
0819 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
0820 # to generate PDF and DVI output from the Perl module output.
0821
0822 PERLMOD_LATEX = NO
0823
0824 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
0825 # nicely formatted so it can be parsed by a human reader. This is useful
0826 # if you want to understand what is going on. On the other hand, if this
0827 # tag is set to NO the size of the Perl module output will be much smaller
0828 # and Perl will parse it just the same.
0829
0830 PERLMOD_PRETTY = YES
0831
0832 # The names of the make variables in the generated doxyrules.make file
0833 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
0834 # This is useful so different doxyrules.make files included by the same
0835 # Makefile don't overwrite each other's variables.
0836
0837 PERLMOD_MAKEVAR_PREFIX =
0838
0839 #---------------------------------------------------------------------------
0840 # Configuration options related to the preprocessor
0841 #---------------------------------------------------------------------------
0842
0843 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
0844 # evaluate all C-preprocessor directives found in the sources and include
0845 # files.
0846
0847 ENABLE_PREPROCESSING = YES
0848
0849 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
0850 # names in the source code. If set to NO (the default) only conditional
0851 # compilation will be performed. Macro expansion can be done in a controlled
0852 # way by setting EXPAND_ONLY_PREDEF to YES.
0853
0854 MACRO_EXPANSION = NO
0855
0856 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
0857 # then the macro expansion is limited to the macros specified with the
0858 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
0859
0860 EXPAND_ONLY_PREDEF = NO
0861
0862 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
0863 # in the INCLUDE_PATH (see below) will be search if a #include is found.
0864
0865 SEARCH_INCLUDES = YES
0866
0867 # The INCLUDE_PATH tag can be used to specify one or more directories that
0868 # contain include files that are not input files but should be processed by
0869 # the preprocessor.
0870
0871 INCLUDE_PATH =
0872
0873 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
0874 # patterns (like *.h and *.hpp) to filter out the header-files in the
0875 # directories. If left blank, the patterns specified with FILE_PATTERNS will
0876 # be used.
0877
0878 INCLUDE_FILE_PATTERNS =
0879
0880 # The PREDEFINED tag can be used to specify one or more macro names that
0881 # are defined before the preprocessor is started (similar to the -D option of
0882 # gcc). The argument of the tag is a list of macros of the form: name
0883 # or name=definition (no spaces). If the definition and the = are
0884 # omitted =1 is assumed.
0885
0886 PREDEFINED = G4VIS_USE_OPENGL=1 \
0887 G4VIS_USE_OPENGLX=1 \
0888 G4VIS_USE_OPENGLXM=1 \
0889 G4VIS_USE_OPENGLWIN32=1 \
0890 G4VIS_BUILD_OPENGL_DRIVER=1 \
0891 G4VIS_BUILD_OPENGLX_DRIVER=1 \
0892 G4VIS_BUILD_OPENGLXM_DRIVER=1 \
0893 G4VIS_BUILD_OPENGLWIN32_DRIVER=1
0894
0895 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
0896 # this tag can be used to specify a list of macro names that should be expanded.
0897 # The macro definition that is found in the sources will be used.
0898 # Use the PREDEFINED tag if you want to use a different macro definition.
0899
0900 EXPAND_AS_DEFINED =
0901
0902 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
0903 # doxygen's preprocessor will remove all function-like macros that are alone
0904 # on a line, have an all uppercase name, and do not end with a semicolon. Such
0905 # function macros are typically used for boiler-plate code, and will confuse the
0906 # parser if not removed.
0907
0908 SKIP_FUNCTION_MACROS = YES
0909
0910 #---------------------------------------------------------------------------
0911 # Configuration::addtions related to external references
0912 #---------------------------------------------------------------------------
0913
0914 # The TAGFILES option can be used to specify one or more tagfiles.
0915 # Optionally an initial location of the external documentation
0916 # can be added for each tagfile. The format of a tag file without
0917 # this location is as follows:
0918 # TAGFILES = file1 file2 ...
0919 # Adding location for the tag files is done as follows:
0920 # TAGFILES = file1=loc1 "file2 = loc2" ...
0921 # where "loc1" and "loc2" can be relative or absolute paths or
0922 # URLs. If a location is present for each tag, the installdox tool
0923 # does not have to be run to correct the links.
0924 # Note that each tag file must have a unique name
0925 # (where the name does NOT include the path)
0926 # If a tag file is not located in the directory in which doxygen
0927 # is run, you must also specify the path to the tagfile here.
0928
0929 TAGFILES =
0930
0931 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
0932 # a tag file that is based on the input files it reads.
0933
0934 GENERATE_TAGFILE =
0935
0936 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
0937 # in the class index. If set to NO only the inherited external classes
0938 # will be listed.
0939
0940 ALLEXTERNALS = NO
0941
0942 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
0943 # in the modules index. If set to NO, only the current project's groups will
0944 # be listed.
0945
0946 EXTERNAL_GROUPS = YES
0947
0948 # The PERL_PATH should be the absolute path and name of the perl script
0949 # interpreter (i.e. the result of `which perl').
0950
0951 PERL_PATH = /usr/bin/perl
0952
0953 #---------------------------------------------------------------------------
0954 # Configuration options related to the dot tool
0955 #---------------------------------------------------------------------------
0956
0957 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
0958 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
0959 # super classes. Setting the tag to NO turns the diagrams off. Note that this
0960 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
0961 # recommended to install and use dot, since it yields more powerful graphs.
0962
0963 CLASS_DIAGRAMS = YES
0964
0965 # If set to YES, the inheritance and collaboration graphs will hide
0966 # inheritance and usage relations if the target is undocumented
0967 # or is not a class.
0968
0969 HIDE_UNDOC_RELATIONS = YES
0970
0971 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
0972 # available from the path. This tool is part of Graphviz, a graph visualization
0973 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
0974 # have no effect if this option is set to NO (the default)
0975
0976 HAVE_DOT = NO
0977
0978 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
0979 # will generate a graph for each documented class showing the direct and
0980 # indirect inheritance relations. Setting this tag to YES will force the
0981 # the CLASS_DIAGRAMS tag to NO.
0982
0983 CLASS_GRAPH = YES
0984
0985 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
0986 # will generate a graph for each documented class showing the direct and
0987 # indirect implementation dependencies (inheritance, containment, and
0988 # class references variables) of the class with other documented classes.
0989
0990 COLLABORATION_GRAPH = YES
0991
0992 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
0993 # collaboration diagrams in a style similiar to the OMG's Unified Modeling
0994 # Language.
0995
0996 UML_LOOK = NO
0997
0998 # If set to YES, the inheritance and collaboration graphs will show the
0999 # relations between templates and their instances.
1000
1001 TEMPLATE_RELATIONS = YES
1002
1003 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1004 # tags are set to YES then doxygen will generate a graph for each documented
1005 # file showing the direct and indirect include dependencies of the file with
1006 # other documented files.
1007
1008 INCLUDE_GRAPH = YES
1009
1010 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1011 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1012 # documented header file showing the documented files that directly or
1013 # indirectly include this file.
1014
1015 INCLUDED_BY_GRAPH = YES
1016
1017 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1018 # generate a call dependency graph for every global function or class method.
1019 # Note that enabling this option will significantly increase the time of a run.
1020 # So in most cases it will be better to enable call graphs for selected
1021 # functions only using the \callgraph command.
1022
1023 CALL_GRAPH = NO
1024
1025 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1026 # will graphical hierarchy of all classes instead of a textual one.
1027
1028 GRAPHICAL_HIERARCHY = YES
1029
1030 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1031 # generated by dot. Possible values are png, jpg, or gif
1032 # If left blank png will be used.
1033
1034 DOT_IMAGE_FORMAT = gif
1035
1036 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1037 # found. If left blank, it is assumed the dot tool can be found on the path.
1038
1039 DOT_PATH =
1040
1041 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1042 # contain dot files that are included in the documentation (see the
1043 # \dotfile command).
1044
1045 DOTFILE_DIRS =
1046
1047 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1048 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1049 # this value, doxygen will try to truncate the graph, so that it fits within
1050 # the specified constraint. Beware that most browsers cannot cope with very
1051 # large images.
1052
1053 MAX_DOT_GRAPH_WIDTH = 1024
1054
1055 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1056 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1057 # this value, doxygen will try to truncate the graph, so that it fits within
1058 # the specified constraint. Beware that most browsers cannot cope with very
1059 # large images.
1060
1061 MAX_DOT_GRAPH_HEIGHT = 1024
1062
1063 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1064 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1065 # from the root by following a path via at most 3 edges will be shown. Nodes that
1066 # lay further from the root node will be omitted. Note that setting this option to
1067 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1068 # note that a graph may be further truncated if the graph's image dimensions are
1069 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1070 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1071
1072 MAX_DOT_GRAPH_DEPTH = 0
1073
1074 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1075 # generate a legend page explaining the meaning of the various boxes and
1076 # arrows in the dot generated graphs.
1077
1078 GENERATE_LEGEND = YES
1079
1080 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1081 # remove the intermediate dot files that are used to generate
1082 # the various graphs.
1083
1084 DOT_CLEANUP = YES
1085
1086 #---------------------------------------------------------------------------
1087 # Configuration::addtions related to the search engine
1088 #---------------------------------------------------------------------------
1089
1090 # The SEARCHENGINE tag specifies whether or not a search engine should be
1091 # used. If set to NO the values of all tags below this one will be ignored.
1092
1093 SEARCHENGINE = NO