Warning, /geant4/examples/extended/persistency/P03/Doxyfile is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.7.3
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 # This tag specifies the encoding used for all characters in the config file
0018 # that follow. The default is UTF-8 which is also the encoding used for all
0019 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
0020 # iconv built into libc) for the transcoding. See
0021 # http://www.gnu.org/software/libiconv for the list of possible encodings.
0022
0023 DOXYFILE_ENCODING = UTF-8
0024
0025 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
0026 # by quotes) that should identify the project.
0027
0028 PROJECT_NAME = "Geant4 examples"
0029
0030 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
0031 # This could be handy for archiving the generated documentation or
0032 # if some version control system is used.
0033
0034 PROJECT_NUMBER =
0035
0036 # Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
0037
0038 PROJECT_BRIEF =
0039
0040 # With the PROJECT_LOGO tag one can specify an logo or icon that is
0041 # included in the documentation. The maximum height of the logo should not
0042 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
0043 # Doxygen will copy the logo to the output directory.
0044
0045 PROJECT_LOGO =
0046
0047 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
0048 # base path where the generated documentation will be put.
0049 # If a relative path is entered, it will be relative to the location
0050 # where doxygen was started. If left blank the current directory will be used.
0051
0052 OUTPUT_DIRECTORY =
0053
0054 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
0055 # 4096 sub-directories (in 2 levels) under the output directory of each output
0056 # format and will distribute the generated files over these directories.
0057 # Enabling this option can be useful when feeding doxygen a huge amount of
0058 # source files, where putting all generated files in the same directory would
0059 # otherwise cause performance problems for the file system.
0060
0061 CREATE_SUBDIRS = NO
0062
0063 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
0064 # documentation generated by doxygen is written. Doxygen will use this
0065 # information to generate all constant output in the proper language.
0066 # The default language is English, other supported languages are:
0067 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
0068 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
0069 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
0070 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
0071 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
0072 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
0073
0074 OUTPUT_LANGUAGE = English
0075
0076 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
0077 # include brief member descriptions after the members that are listed in
0078 # the file and class documentation (similar to JavaDoc).
0079 # Set to NO to disable this.
0080
0081 BRIEF_MEMBER_DESC = YES
0082
0083 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
0084 # the brief description of a member or function before the detailed description.
0085 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0086 # brief descriptions will be completely suppressed.
0087
0088 REPEAT_BRIEF = YES
0089
0090 # This tag implements a quasi-intelligent brief description abbreviator
0091 # that is used to form the text in various listings. Each string
0092 # in this list, if found as the leading text of the brief description, will be
0093 # stripped from the text and the result after processing the whole list, is
0094 # used as the annotated text. Otherwise, the brief description is used as-is.
0095 # If left blank, the following values are used ("$name" is automatically
0096 # replaced with the name of the entity): "The $name class" "The $name widget"
0097 # "The $name file" "is" "provides" "specifies" "contains"
0098 # "represents" "a" "an" "the"
0099
0100 ABBREVIATE_BRIEF =
0101
0102 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
0103 # Doxygen will generate a detailed section even if there is only a brief
0104 # description.
0105
0106 ALWAYS_DETAILED_SEC = NO
0107
0108 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
0109 # inherited members of a class in the documentation of that class as if those
0110 # members were ordinary class members. Constructors, destructors and assignment
0111 # operators of the base classes will not be shown.
0112
0113 INLINE_INHERITED_MEMB = NO
0114
0115 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
0116 # path before files name in the file list and in the header files. If set
0117 # to NO the shortest path that makes the file name unique will be used.
0118
0119 FULL_PATH_NAMES = YES
0120
0121 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
0122 # can be used to strip a user-defined part of the path. Stripping is
0123 # only done if one of the specified strings matches the left-hand part of
0124 # the path. The tag can be used to show relative paths in the file list.
0125 # If left blank the directory from which doxygen is run is used as the
0126 # path to strip.
0127
0128 STRIP_FROM_PATH = /home/work/packages/geant4/geant4_ref/examples/
0129
0130 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
0131 # the path mentioned in the documentation of a class, which tells
0132 # the reader which header file to include in order to use a class.
0133 # If left blank only the name of the header file containing the class
0134 # definition is used. Otherwise one should specify the include paths that
0135 # are normally passed to the compiler using the -I flag.
0136
0137 STRIP_FROM_INC_PATH =
0138
0139 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
0140 # (but less readable) file names. This can be useful if your file system
0141 # doesn't support long names like on DOS, Mac, or CD-ROM.
0142
0143 SHORT_NAMES = NO
0144
0145 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
0146 # will interpret the first line (until the first dot) of a JavaDoc-style
0147 # comment as the brief description. If set to NO, the JavaDoc
0148 # comments will behave just like regular Qt-style comments
0149 # (thus requiring an explicit @brief command for a brief description.)
0150
0151 JAVADOC_AUTOBRIEF = YES
0152
0153 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
0154 # interpret the first line (until the first dot) of a Qt-style
0155 # comment as the brief description. If set to NO, the comments
0156 # will behave just like regular Qt-style comments (thus requiring
0157 # an explicit \brief command for a brief description.)
0158
0159 QT_AUTOBRIEF = NO
0160
0161 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
0162 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
0163 # comments) as a brief description. This used to be the default behaviour.
0164 # The new default is to treat a multi-line C++ comment block as a detailed
0165 # description. Set this tag to YES if you prefer the old behaviour instead.
0166
0167 MULTILINE_CPP_IS_BRIEF = NO
0168
0169 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
0170 # member inherits the documentation from any documented member that it
0171 # re-implements.
0172
0173 INHERIT_DOCS = YES
0174
0175 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
0176 # a new page for each member. If set to NO, the documentation of a member will
0177 # be part of the file/class/namespace that contains it.
0178
0179 SEPARATE_MEMBER_PAGES = NO
0180
0181 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
0182 # Doxygen uses this value to replace tabs by spaces in code fragments.
0183
0184 TAB_SIZE = 8
0185
0186 # This tag can be used to specify a number of aliases that acts
0187 # as commands in the documentation. An alias has the form "name=value".
0188 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
0189 # put the command \sideeffect (or @sideeffect) in the documentation, which
0190 # will result in a user-defined paragraph with heading "Side Effects:".
0191 # You can put \n's in the value part of an alias to insert newlines.
0192
0193 ALIASES =
0194
0195 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
0196 # sources only. Doxygen will then generate output that is more tailored for C.
0197 # For instance, some of the names that are used will be different. The list
0198 # of all members will be omitted, etc.
0199
0200 OPTIMIZE_OUTPUT_FOR_C = NO
0201
0202 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
0203 # sources only. Doxygen will then generate output that is more tailored for
0204 # Java. For instance, namespaces will be presented as packages, qualified
0205 # scopes will look different, etc.
0206
0207 OPTIMIZE_OUTPUT_JAVA = NO
0208
0209 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
0210 # sources only. Doxygen will then generate output that is more tailored for
0211 # Fortran.
0212
0213 OPTIMIZE_FOR_FORTRAN = NO
0214
0215 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
0216 # sources. Doxygen will then generate output that is tailored for
0217 # VHDL.
0218
0219 OPTIMIZE_OUTPUT_VHDL = NO
0220
0221 # Doxygen selects the parser to use depending on the extension of the files it
0222 # parses. With this tag you can assign which parser to use for a given extension.
0223 # Doxygen has a built-in mapping, but you can override or extend it using this
0224 # tag. The format is ext=language, where ext is a file extension, and language
0225 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
0226 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
0227 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
0228 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
0229 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
0230
0231 EXTENSION_MAPPING =
0232
0233 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
0234 # to include (a tag file for) the STL sources as input, then you should
0235 # set this tag to YES in order to let doxygen match functions declarations and
0236 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
0237 # func(std::string) {}). This also makes the inheritance and collaboration
0238 # diagrams that involve STL classes more complete and accurate.
0239
0240 BUILTIN_STL_SUPPORT = NO
0241
0242 # If you use Microsoft's C++/CLI language, you should set this option to YES to
0243 # enable parsing support.
0244
0245 CPP_CLI_SUPPORT = NO
0246
0247 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
0248 # Doxygen will parse them like normal C++ but will assume all classes use public
0249 # instead of private inheritance when no explicit protection keyword is present.
0250
0251 SIP_SUPPORT = NO
0252
0253 # For Microsoft's IDL there are propget and propput attributes to indicate getter
0254 # and setter methods for a property. Setting this option to YES (the default)
0255 # will make doxygen replace the get and set methods by a property in the
0256 # documentation. This will only work if the methods are indeed getting or
0257 # setting a simple type. If this is not the case, or you want to show the
0258 # methods anyway, you should set this option to NO.
0259
0260 IDL_PROPERTY_SUPPORT = YES
0261
0262 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
0263 # tag is set to YES, then doxygen will reuse the documentation of the first
0264 # member in the group (if any) for the other members of the group. By default
0265 # all members of a group must be documented explicitly.
0266
0267 DISTRIBUTE_GROUP_DOC = NO
0268
0269 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
0270 # the same type (for instance a group of public functions) to be put as a
0271 # subgroup of that type (e.g. under the Public Functions section). Set it to
0272 # NO to prevent subgrouping. Alternatively, this can be done per class using
0273 # the \nosubgrouping command.
0274
0275 SUBGROUPING = YES
0276
0277 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
0278 # is documented as struct, union, or enum with the name of the typedef. So
0279 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
0280 # with name TypeT. When disabled the typedef will appear as a member of a file,
0281 # namespace, or class. And the struct will be named TypeS. This can typically
0282 # be useful for C code in case the coding convention dictates that all compound
0283 # types are typedef'ed and only the typedef is referenced, never the tag name.
0284
0285 TYPEDEF_HIDES_STRUCT = NO
0286
0287 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
0288 # determine which symbols to keep in memory and which to flush to disk.
0289 # When the cache is full, less often used symbols will be written to disk.
0290 # For small to medium size projects (<1000 input files) the default value is
0291 # probably good enough. For larger projects a too small cache size can cause
0292 # doxygen to be busy swapping symbols to and from disk most of the time
0293 # causing a significant performance penalty.
0294 # If the system has enough physical memory increasing the cache will improve the
0295 # performance by keeping more symbols in memory. Note that the value works on
0296 # a logarithmic scale so increasing the size by one will roughly double the
0297 # memory usage. The cache size is given by this formula:
0298 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
0299 # corresponding to a cache size of 2^16 = 65536 symbols
0300
0301 SYMBOL_CACHE_SIZE = 0
0302
0303 #---------------------------------------------------------------------------
0304 # Build related configuration options
0305 #---------------------------------------------------------------------------
0306
0307 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
0308 # documentation are documented, even if no documentation was available.
0309 # Private class members and static file members will be hidden unless
0310 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
0311
0312 EXTRACT_ALL = YES
0313
0314 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
0315 # will be included in the documentation.
0316
0317 EXTRACT_PRIVATE = YES
0318
0319 # If the EXTRACT_STATIC tag is set to YES all static members of a file
0320 # will be included in the documentation.
0321
0322 EXTRACT_STATIC = YES
0323
0324 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
0325 # defined locally in source files will be included in the documentation.
0326 # If set to NO only classes defined in header files are included.
0327
0328 EXTRACT_LOCAL_CLASSES = YES
0329
0330 # This flag is only useful for Objective-C code. When set to YES local
0331 # methods, which are defined in the implementation section but not in
0332 # the interface are included in the documentation.
0333 # If set to NO (the default) only methods in the interface are included.
0334
0335 EXTRACT_LOCAL_METHODS = YES
0336
0337 # If this flag is set to YES, the members of anonymous namespaces will be
0338 # extracted and appear in the documentation as a namespace called
0339 # 'anonymous_namespace{file}', where file will be replaced with the base
0340 # name of the file that contains the anonymous namespace. By default
0341 # anonymous namespaces are hidden.
0342
0343 EXTRACT_ANON_NSPACES = NO
0344
0345 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
0346 # undocumented members of documented classes, files or namespaces.
0347 # If set to NO (the default) these members will be included in the
0348 # various overviews, but no documentation section is generated.
0349 # This option has no effect if EXTRACT_ALL is enabled.
0350
0351 HIDE_UNDOC_MEMBERS = NO
0352
0353 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
0354 # undocumented classes that are normally visible in the class hierarchy.
0355 # If set to NO (the default) these classes will be included in the various
0356 # overviews. This option has no effect if EXTRACT_ALL is enabled.
0357
0358 HIDE_UNDOC_CLASSES = NO
0359
0360 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
0361 # friend (class|struct|union) declarations.
0362 # If set to NO (the default) these declarations will be included in the
0363 # documentation.
0364
0365 HIDE_FRIEND_COMPOUNDS = NO
0366
0367 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
0368 # documentation blocks found inside the body of a function.
0369 # If set to NO (the default) these blocks will be appended to the
0370 # function's detailed documentation block.
0371
0372 HIDE_IN_BODY_DOCS = NO
0373
0374 # The INTERNAL_DOCS tag determines if documentation
0375 # that is typed after a \internal command is included. If the tag is set
0376 # to NO (the default) then the documentation will be excluded.
0377 # Set it to YES to include the internal documentation.
0378
0379 INTERNAL_DOCS = NO
0380
0381 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
0382 # file names in lower-case letters. If set to YES upper-case letters are also
0383 # allowed. This is useful if you have classes or files whose names only differ
0384 # in case and if your file system supports case sensitive file names. Windows
0385 # and Mac users are advised to set this option to NO.
0386
0387 CASE_SENSE_NAMES = YES
0388
0389 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
0390 # will show members with their full class and namespace scopes in the
0391 # documentation. If set to YES the scope will be hidden.
0392
0393 HIDE_SCOPE_NAMES = NO
0394
0395 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
0396 # will put a list of the files that are included by a file in the documentation
0397 # of that file.
0398
0399 SHOW_INCLUDE_FILES = YES
0400
0401 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
0402 # will list include files with double quotes in the documentation
0403 # rather than with sharp brackets.
0404
0405 FORCE_LOCAL_INCLUDES = NO
0406
0407 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
0408 # is inserted in the documentation for inline members.
0409
0410 INLINE_INFO = YES
0411
0412 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
0413 # will sort the (detailed) documentation of file and class members
0414 # alphabetically by member name. If set to NO the members will appear in
0415 # declaration order.
0416
0417 SORT_MEMBER_DOCS = NO
0418
0419 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
0420 # brief documentation of file, namespace and class members alphabetically
0421 # by member name. If set to NO (the default) the members will appear in
0422 # declaration order.
0423
0424 SORT_BRIEF_DOCS = NO
0425
0426 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
0427 # will sort the (brief and detailed) documentation of class members so that
0428 # constructors and destructors are listed first. If set to NO (the default)
0429 # the constructors will appear in the respective orders defined by
0430 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
0431 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
0432 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
0433
0434 SORT_MEMBERS_CTORS_1ST = NO
0435
0436 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
0437 # hierarchy of group names into alphabetical order. If set to NO (the default)
0438 # the group names will appear in their defined order.
0439
0440 SORT_GROUP_NAMES = NO
0441
0442 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
0443 # sorted by fully-qualified names, including namespaces. If set to
0444 # NO (the default), the class list will be sorted only by class name,
0445 # not including the namespace part.
0446 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
0447 # Note: This option applies only to the class list, not to the
0448 # alphabetical list.
0449
0450 SORT_BY_SCOPE_NAME = NO
0451
0452 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
0453 # match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
0454 # will still accept a match between prototype and implementation in such cases.
0455
0456 STRICT_PROTO_MATCHING = NO
0457
0458 # The GENERATE_TODOLIST tag can be used to enable (YES) or
0459 # disable (NO) the todo list. This list is created by putting \todo
0460 # commands in the documentation.
0461
0462 GENERATE_TODOLIST = YES
0463
0464 # The GENERATE_TESTLIST tag can be used to enable (YES) or
0465 # disable (NO) the test list. This list is created by putting \test
0466 # commands in the documentation.
0467
0468 GENERATE_TESTLIST = YES
0469
0470 # The GENERATE_BUGLIST tag can be used to enable (YES) or
0471 # disable (NO) the bug list. This list is created by putting \bug
0472 # commands in the documentation.
0473
0474 GENERATE_BUGLIST = YES
0475
0476 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
0477 # disable (NO) the deprecated list. This list is created by putting
0478 # \deprecated commands in the documentation.
0479
0480 GENERATE_DEPRECATEDLIST= YES
0481
0482 # The ENABLED_SECTIONS tag can be used to enable conditional
0483 # documentation sections, marked by \if sectionname ... \endif.
0484
0485 ENABLED_SECTIONS =
0486
0487 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
0488 # the initial value of a variable or macro consists of for it to appear in
0489 # the documentation. If the initializer consists of more lines than specified
0490 # here it will be hidden. Use a value of 0 to hide initializers completely.
0491 # The appearance of the initializer of individual variables and macros in the
0492 # documentation can be controlled using \showinitializer or \hideinitializer
0493 # command in the documentation regardless of this setting.
0494
0495 MAX_INITIALIZER_LINES = 30
0496
0497 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
0498 # at the bottom of the documentation of classes and structs. If set to YES the
0499 # list will mention the files that were used to generate the documentation.
0500
0501 SHOW_USED_FILES = YES
0502
0503 # If the sources in your project are distributed over multiple directories
0504 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
0505 # in the documentation. The default is NO.
0506
0507 SHOW_DIRECTORIES = NO
0508
0509 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
0510 # This will remove the Files entry from the Quick Index and from the
0511 # Folder Tree View (if specified). The default is YES.
0512
0513 SHOW_FILES = YES
0514
0515 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
0516 # Namespaces page.
0517 # This will remove the Namespaces entry from the Quick Index
0518 # and from the Folder Tree View (if specified). The default is YES.
0519
0520 SHOW_NAMESPACES = YES
0521
0522 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
0523 # doxygen should invoke to get the current version for each file (typically from
0524 # the version control system). Doxygen will invoke the program by executing (via
0525 # popen()) the command <command> <input-file>, where <command> is the value of
0526 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
0527 # provided by doxygen. Whatever the program writes to standard output
0528 # is used as the file version. See the manual for examples.
0529
0530 FILE_VERSION_FILTER =
0531
0532 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
0533 # by doxygen. The layout file controls the global structure of the generated
0534 # output files in an output format independent way. The create the layout file
0535 # that represents doxygen's defaults, run doxygen with the -l option.
0536 # You can optionally specify a file name after the option, if omitted
0537 # DoxygenLayout.xml will be used as the name of the layout file.
0538
0539 LAYOUT_FILE =
0540
0541 #---------------------------------------------------------------------------
0542 # configuration options related to warning and progress messages
0543 #---------------------------------------------------------------------------
0544
0545 # The QUIET tag can be used to turn on/off the messages that are generated
0546 # by doxygen. Possible values are YES and NO. If left blank NO is used.
0547
0548 QUIET = NO
0549
0550 # The WARNINGS tag can be used to turn on/off the warning messages that are
0551 # generated by doxygen. Possible values are YES and NO. If left blank
0552 # NO is used.
0553
0554 WARNINGS = YES
0555
0556 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
0557 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
0558 # automatically be disabled.
0559
0560 WARN_IF_UNDOCUMENTED = YES
0561
0562 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
0563 # potential errors in the documentation, such as not documenting some
0564 # parameters in a documented function, or documenting parameters that
0565 # don't exist or using markup commands wrongly.
0566
0567 WARN_IF_DOC_ERROR = YES
0568
0569 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
0570 # functions that are documented, but have no documentation for their parameters
0571 # or return value. If set to NO (the default) doxygen will only warn about
0572 # wrong or incomplete parameter documentation, but not about the absence of
0573 # documentation.
0574
0575 WARN_NO_PARAMDOC = NO
0576
0577 # The WARN_FORMAT tag determines the format of the warning messages that
0578 # doxygen can produce. The string should contain the $file, $line, and $text
0579 # tags, which will be replaced by the file and line number from which the
0580 # warning originated and the warning text. Optionally the format may contain
0581 # $version, which will be replaced by the version of the file (if it could
0582 # be obtained via FILE_VERSION_FILTER)
0583
0584 WARN_FORMAT = "$file:$line: $text"
0585
0586 # The WARN_LOGFILE tag can be used to specify a file to which warning
0587 # and error messages should be written. If left blank the output is written
0588 # to stderr.
0589
0590 WARN_LOGFILE =
0591
0592 #---------------------------------------------------------------------------
0593 # configuration options related to the input files
0594 #---------------------------------------------------------------------------
0595
0596 # The INPUT tag can be used to specify the files and/or directories that contain
0597 # documented source files. You may enter file names like "myfile.cpp" or
0598 # directories like "/usr/src/myproject". Separate the files or directories
0599 # with spaces.
0600
0601 # trunk
0602 #INPUT = Doxymain.h Doxymodules_basic.h \
0603 # Doxymodules_common.h Doxymodules_new.h \
0604 # ../basic/.README ../extended/.README \
0605 # ../basic/B1 ../basic/B2 ../basic/B3 ../basic/B4 \
0606 # ../extended/common ../extended/new
0607
0608 # release
0609 INPUT = .
0610
0611 # This tag can be used to specify the character encoding of the source files
0612 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
0613 # also the default input encoding. Doxygen uses libiconv (or the iconv built
0614 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
0615 # the list of possible encodings.
0616
0617 INPUT_ENCODING = UTF-8
0618
0619 # If the value of the INPUT tag contains directories, you can use the
0620 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0621 # and *.h) to filter out the source-files in the directories. If left
0622 # blank the following patterns are tested:
0623 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
0624 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
0625 # *.f90 *.f *.for *.vhd *.vhdl
0626
0627 FILE_PATTERNS = *.hh *.icc *.cc .README
0628
0629 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
0630 # should be searched for input files as well. Possible values are YES and NO.
0631 # If left blank NO is used.
0632
0633 RECURSIVE = YES
0634
0635 # The EXCLUDE tag can be used to specify files and/or directories that should
0636 # excluded from the INPUT source files. This way you can easily exclude a
0637 # subdirectory from a directory tree whose root is specified with the INPUT tag.
0638
0639 EXCLUDE = ../basic/B2/B2b/include/B2EventAction.hh \
0640 ../basic/B2/B2b/include/B2MagneticField.hh \
0641 ../basic/B2/B2b/include/B2PrimaryGeneratorAction.hh \
0642 ../basic/B2/B2b/include/B2RunAction.hh \
0643 ../basic/B2/B2b/include/B2TrackerHit.hh \
0644 ../basic/B2/B2b/include/B2TrackerSD.hh \
0645 ../basic/B2/B2b/src/B2EventAction.cc \
0646 ../basic/B2/B2b/src/B2MagneticField.cc \
0647 ../basic/B2/B2b/src/B2PrimaryGeneratorAction.cc \
0648 ../basic/B2/B2b/src/B2RunAction.cc \
0649 ../basic/B2/B2b/src/B2TrackerHit.cc \
0650 ../basic/B2/B2b/src/B2TrackerSD.cc \
0651 ../basic/B4/B4b/include/B4Analysis.hh \
0652 ../basic/B4/B4c/include/B4Analysis.hh \
0653 ../basic/B4/B4d/include/B4Analysis.hh \
0654 ../basic/B4/B4b/include/B4DetectorConstruction.hh \
0655 ../basic/B4/B4b/include/B4DetectorMessenger.hh \
0656 ../basic/B4/B4b/src/B4DetectorConstruction.cc \
0657 ../basic/B4/B4b/src/B4DetectorMessenger.cc \
0658 ../basic/B4/B4b/include/B4PrimaryGeneratorAction.hh \
0659 ../basic/B4/B4c/include/B4PrimaryGeneratorAction.hh \
0660 ../basic/B4/B4d/include/B4PrimaryGeneratorAction.hh \
0661 ../basic/B4/B4b/src/B4PrimaryGeneratorAction.cc \
0662 ../basic/B4/B4c/src/B4PrimaryGeneratorAction.cc \
0663 ../basic/B4/B4d/src/B4PrimaryGeneratorAction.cc \
0664 ../basic/B4/B4b/include/B4RunAction.hh \
0665 ../basic/B4/B4c/include/B4RunAction.hh \
0666 ../basic/B4/B4d/include/B4RunAction.hh \
0667 ../basic/B4/B4b/src/B4RunAction.cc \
0668 ../basic/B4/B4c/src/B4RunAction.cc \
0669 ../basic/B4/B4d/src/B4RunAction.cc
0670
0671 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
0672 # directories that are symbolic links (a Unix file system feature) are excluded
0673 # from the input.
0674
0675 EXCLUDE_SYMLINKS = NO
0676
0677 # If the value of the INPUT tag contains directories, you can use the
0678 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
0679 # certain files from those directories. Note that the wildcards are matched
0680 # against the file with absolute path, so to exclude all test directories
0681 # for example use the pattern */test/*
0682
0683 EXCLUDE_PATTERNS =
0684
0685 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
0686 # (namespaces, classes, functions, etc.) that should be excluded from the
0687 # output. The symbol name can be a fully qualified name, a word, or if the
0688 # wildcard * is used, a substring. Examples: ANamespace, AClass,
0689 # AClass::ANamespace, ANamespace::*Test
0690
0691 EXCLUDE_SYMBOLS =
0692
0693 # The EXAMPLE_PATH tag can be used to specify one or more files or
0694 # directories that contain example code fragments that are included (see
0695 # the \include command).
0696
0697 EXAMPLE_PATH =
0698
0699 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
0700 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0701 # and *.h) to filter out the source-files in the directories. If left
0702 # blank all files are included.
0703
0704 EXAMPLE_PATTERNS =
0705
0706 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
0707 # searched for input files to be used with the \include or \dontinclude
0708 # commands irrespective of the value of the RECURSIVE tag.
0709 # Possible values are YES and NO. If left blank NO is used.
0710
0711 EXAMPLE_RECURSIVE = NO
0712
0713 # The IMAGE_PATH tag can be used to specify one or more files or
0714 # directories that contain image that are included in the documentation (see
0715 # the \image command).
0716
0717 IMAGE_PATH = .
0718
0719 # The INPUT_FILTER tag can be used to specify a program that doxygen should
0720 # invoke to filter for each input file. Doxygen will invoke the filter program
0721 # by executing (via popen()) the command <filter> <input-file>, where <filter>
0722 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
0723 # input file. Doxygen will then use the output that the filter program writes
0724 # to standard output.
0725 # If FILTER_PATTERNS is specified, this tag will be
0726 # ignored.
0727
0728 INPUT_FILTER =
0729
0730 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
0731 # basis.
0732 # Doxygen will compare the file name with each pattern and apply the
0733 # filter if there is a match.
0734 # The filters are a list of the form:
0735 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
0736 # info on how filters are used. If FILTER_PATTERNS is empty or if
0737 # non of the patterns match the file name, INPUT_FILTER is applied.
0738
0739 FILTER_PATTERNS =
0740
0741 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
0742 # INPUT_FILTER) will be used to filter the input files when producing source
0743 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
0744
0745 FILTER_SOURCE_FILES = NO
0746
0747 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
0748 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
0749 # and it is also possible to disable source filtering for a specific pattern
0750 # using *.ext= (so without naming a filter). This option only has effect when
0751 # FILTER_SOURCE_FILES is enabled.
0752
0753 FILTER_SOURCE_PATTERNS =
0754
0755 #---------------------------------------------------------------------------
0756 # configuration options related to source browsing
0757 #---------------------------------------------------------------------------
0758
0759 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
0760 # be generated. Documented entities will be cross-referenced with these sources.
0761 # Note: To get rid of all source code in the generated output, make sure also
0762 # VERBATIM_HEADERS is set to NO.
0763
0764 SOURCE_BROWSER = YES
0765
0766 # Setting the INLINE_SOURCES tag to YES will include the body
0767 # of functions and classes directly in the documentation.
0768
0769 INLINE_SOURCES = YES
0770
0771 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
0772 # doxygen to hide any special comment blocks from generated source code
0773 # fragments. Normal C and C++ comments will always remain visible.
0774
0775 STRIP_CODE_COMMENTS = YES
0776
0777 # If the REFERENCED_BY_RELATION tag is set to YES
0778 # then for each documented function all documented
0779 # functions referencing it will be listed.
0780
0781 REFERENCED_BY_RELATION = NO
0782
0783 # If the REFERENCES_RELATION tag is set to YES
0784 # then for each documented function all documented entities
0785 # called/used by that function will be listed.
0786
0787 REFERENCES_RELATION = NO
0788
0789 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
0790 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
0791 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
0792 # link to the source code.
0793 # Otherwise they will link to the documentation.
0794
0795 REFERENCES_LINK_SOURCE = YES
0796
0797 # If the USE_HTAGS tag is set to YES then the references to source code
0798 # will point to the HTML generated by the htags(1) tool instead of doxygen
0799 # built-in source browser. The htags tool is part of GNU's global source
0800 # tagging system (see http://www.gnu.org/software/global/global.html). You
0801 # will need version 4.8.6 or higher.
0802
0803 USE_HTAGS = NO
0804
0805 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
0806 # will generate a verbatim copy of the header file for each class for
0807 # which an include is specified. Set to NO to disable this.
0808
0809 VERBATIM_HEADERS = YES
0810
0811 #---------------------------------------------------------------------------
0812 # configuration options related to the alphabetical class index
0813 #---------------------------------------------------------------------------
0814
0815 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
0816 # of all compounds will be generated. Enable this if the project
0817 # contains a lot of classes, structs, unions or interfaces.
0818
0819 ALPHABETICAL_INDEX = YES
0820
0821 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
0822 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
0823 # in which this list will be split (can be a number in the range [1..20])
0824
0825 COLS_IN_ALPHA_INDEX = 5
0826
0827 # In case all classes in a project start with a common prefix, all
0828 # classes will be put under the same header in the alphabetical index.
0829 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
0830 # should be ignored while generating the index headers.
0831
0832 IGNORE_PREFIX =
0833
0834 #---------------------------------------------------------------------------
0835 # configuration options related to the HTML output
0836 #---------------------------------------------------------------------------
0837
0838 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
0839 # generate HTML output.
0840
0841 GENERATE_HTML = YES
0842
0843 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
0844 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0845 # put in front of it. If left blank `html' will be used as the default path.
0846
0847 HTML_OUTPUT = html
0848
0849 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
0850 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
0851 # doxygen will generate files with .html extension.
0852
0853 HTML_FILE_EXTENSION = .html
0854
0855 # The HTML_HEADER tag can be used to specify a personal HTML header for
0856 # each generated HTML page. If it is left blank doxygen will generate a
0857 # standard header.
0858
0859 HTML_HEADER =
0860
0861 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
0862 # each generated HTML page. If it is left blank doxygen will generate a
0863 # standard footer.
0864
0865 HTML_FOOTER =
0866
0867 # If the HTML_TIMESTAMP tag is set to YES then the generated HTML
0868 # documentation will contain the timesstamp.
0869
0870 HTML_TIMESTAMP = NO
0871
0872 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
0873 # style sheet that is used by each HTML page. It can be used to
0874 # fine-tune the look of the HTML output. If the tag is left blank doxygen
0875 # will generate a default style sheet. Note that doxygen will try to copy
0876 # the style sheet file to the HTML output directory, so don't put your own
0877 # stylesheet in the HTML output directory as well, or it will be erased!
0878
0879 HTML_STYLESHEET =
0880
0881 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
0882 # Doxygen will adjust the colors in the stylesheet and background images
0883 # according to this color. Hue is specified as an angle on a colorwheel,
0884 # see http://en.wikipedia.org/wiki/Hue for more information.
0885 # For instance the value 0 represents red, 60 is yellow, 120 is green,
0886 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
0887 # The allowed range is 0 to 359.
0888
0889 HTML_COLORSTYLE_HUE = 220
0890
0891 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
0892 # the colors in the HTML output. For a value of 0 the output will use
0893 # grayscales only. A value of 255 will produce the most vivid colors.
0894
0895 HTML_COLORSTYLE_SAT = 100
0896
0897 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
0898 # the luminance component of the colors in the HTML output. Values below
0899 # 100 gradually make the output lighter, whereas values above 100 make
0900 # the output darker. The value divided by 100 is the actual gamma applied,
0901 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
0902 # and 100 does not change the gamma.
0903
0904 HTML_COLORSTYLE_GAMMA = 80
0905
0906 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
0907 # page will contain the date and time when the page was generated. Setting
0908 # this to NO can help when comparing the output of multiple runs.
0909
0910 HTML_TIMESTAMP = YES
0911
0912 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
0913 # files or namespaces will be aligned in HTML using tables. If set to
0914 # NO a bullet list will be used.
0915
0916 HTML_ALIGN_MEMBERS = YES
0917
0918 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
0919 # documentation will contain sections that can be hidden and shown after the
0920 # page has loaded. For this to work a browser that supports
0921 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
0922 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
0923
0924 HTML_DYNAMIC_SECTIONS = NO
0925
0926 # If the GENERATE_DOCSET tag is set to YES, additional index files
0927 # will be generated that can be used as input for Apple's Xcode 3
0928 # integrated development environment, introduced with OSX 10.5 (Leopard).
0929 # To create a documentation set, doxygen will generate a Makefile in the
0930 # HTML output directory. Running make will produce the docset in that
0931 # directory and running "make install" will install the docset in
0932 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
0933 # it at startup.
0934 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
0935 # for more information.
0936
0937 GENERATE_DOCSET = NO
0938
0939 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
0940 # feed. A documentation feed provides an umbrella under which multiple
0941 # documentation sets from a single provider (such as a company or product suite)
0942 # can be grouped.
0943
0944 DOCSET_FEEDNAME = "Doxygen generated docs"
0945
0946 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
0947 # should uniquely identify the documentation set bundle. This should be a
0948 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
0949 # will append .docset to the name.
0950
0951 DOCSET_BUNDLE_ID = org.doxygen.Project
0952
0953 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
0954 # the documentation publisher. This should be a reverse domain-name style
0955 # string, e.g. com.mycompany.MyDocSet.documentation.
0956
0957 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
0958
0959 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
0960
0961 DOCSET_PUBLISHER_NAME = Publisher
0962
0963 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
0964 # will be generated that can be used as input for tools like the
0965 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
0966 # of the generated HTML documentation.
0967
0968 GENERATE_HTMLHELP = NO
0969
0970 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
0971 # be used to specify the file name of the resulting .chm file. You
0972 # can add a path in front of the file if the result should not be
0973 # written to the html output directory.
0974
0975 CHM_FILE =
0976
0977 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
0978 # be used to specify the location (absolute path including file name) of
0979 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
0980 # the HTML help compiler on the generated index.hhp.
0981
0982 HHC_LOCATION =
0983
0984 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
0985 # controls if a separate .chi index file is generated (YES) or that
0986 # it should be included in the master .chm file (NO).
0987
0988 GENERATE_CHI = NO
0989
0990 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
0991 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
0992 # content.
0993
0994 CHM_INDEX_ENCODING =
0995
0996 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
0997 # controls whether a binary table of contents is generated (YES) or a
0998 # normal table of contents (NO) in the .chm file.
0999
1000 BINARY_TOC = NO
1001
1002 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1003 # to the contents of the HTML help documentation and to the tree view.
1004
1005 TOC_EXPAND = NO
1006
1007 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1008 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1009 # that can be used as input for Qt's qhelpgenerator to generate a
1010 # Qt Compressed Help (.qch) of the generated HTML documentation.
1011
1012 GENERATE_QHP = NO
1013
1014 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1015 # be used to specify the file name of the resulting .qch file.
1016 # The path specified is relative to the HTML output folder.
1017
1018 QCH_FILE =
1019
1020 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1021 # Qt Help Project output. For more information please see
1022 # http://doc.trolltech.com/qthelpproject.html#namespace
1023
1024 QHP_NAMESPACE = org.doxygen.Project
1025
1026 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1027 # Qt Help Project output. For more information please see
1028 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1029
1030 QHP_VIRTUAL_FOLDER = doc
1031
1032 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1033 # add. For more information please see
1034 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1035
1036 QHP_CUST_FILTER_NAME =
1037
1038 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1039 # custom filter to add. For more information please see
1040 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1041 # Qt Help Project / Custom Filters</a>.
1042
1043 QHP_CUST_FILTER_ATTRS =
1044
1045 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1046 # project's
1047 # filter section matches.
1048 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1049 # Qt Help Project / Filter Attributes</a>.
1050
1051 QHP_SECT_FILTER_ATTRS =
1052
1053 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1054 # be used to specify the location of Qt's qhelpgenerator.
1055 # If non-empty doxygen will try to run qhelpgenerator on the generated
1056 # .qhp file.
1057
1058 QHG_LOCATION =
1059
1060 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1061 # will be generated, which together with the HTML files, form an Eclipse help
1062 # plugin. To install this plugin and make it available under the help contents
1063 # menu in Eclipse, the contents of the directory containing the HTML and XML
1064 # files needs to be copied into the plugins directory of eclipse. The name of
1065 # the directory within the plugins directory should be the same as
1066 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1067 # the help appears.
1068
1069 GENERATE_ECLIPSEHELP = NO
1070
1071 # A unique identifier for the eclipse help plugin. When installing the plugin
1072 # the directory name containing the HTML and XML files should also have
1073 # this name.
1074
1075 ECLIPSE_DOC_ID = org.doxygen.Project
1076
1077 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1078 # top of each HTML page. The value NO (the default) enables the index and
1079 # the value YES disables it.
1080
1081 DISABLE_INDEX = NO
1082
1083 # This tag can be used to set the number of enum values (range [0,1..20])
1084 # that doxygen will group on one line in the generated HTML documentation.
1085 # Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
1086
1087 ENUM_VALUES_PER_LINE = 4
1088
1089 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1090 # structure should be generated to display hierarchical information.
1091 # If the tag value is set to YES, a side panel will be generated
1092 # containing a tree-like index structure (just like the one that
1093 # is generated for HTML Help). For this to work a browser that supports
1094 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1095 # Windows users are probably better off using the HTML help feature.
1096
1097 GENERATE_TREEVIEW = NO
1098
1099 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1100 # and Class Hierarchy pages using a tree view instead of an ordered list.
1101
1102 USE_INLINE_TREES = NO
1103
1104 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1105 # used to set the initial width (in pixels) of the frame in which the tree
1106 # is shown.
1107
1108 TREEVIEW_WIDTH = 250
1109
1110 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1111 # links to external symbols imported via tag files in a separate window.
1112
1113 EXT_LINKS_IN_WINDOW = NO
1114
1115 # Use this tag to change the font size of Latex formulas included
1116 # as images in the HTML documentation. The default is 10. Note that
1117 # when you change the font size after a successful doxygen run you need
1118 # to manually remove any form_*.png images from the HTML output directory
1119 # to force them to be regenerated.
1120
1121 FORMULA_FONTSIZE = 10
1122
1123 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1124 # generated for formulas are transparent PNGs. Transparent PNGs are
1125 # not supported properly for IE 6.0, but are supported on all modern browsers.
1126 # Note that when changing this option you need to delete any form_*.png files
1127 # in the HTML output before the changes have effect.
1128
1129 FORMULA_TRANSPARENT = YES
1130
1131 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1132 # (see http://www.mathjax.org) which uses client side Javascript for the
1133 # rendering instead of using prerendered bitmaps. Use this if you do not
1134 # have LaTeX installed or if you want to formulas look prettier in the HTML
1135 # output. When enabled you also need to install MathJax separately and
1136 # configure the path to it using the MATHJAX_RELPATH option.
1137
1138 USE_MATHJAX = NO
1139
1140 # When MathJax is enabled you need to specify the location relative to the
1141 # HTML output directory using the MATHJAX_RELPATH option. The destination
1142 # directory should contain the MathJax.js script. For instance, if the mathjax
1143 # directory is located at the same level as the HTML output directory, then
1144 # MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
1145 # MathJax, but it is strongly recommended to install a local copy of MathJax
1146 # before deployment.
1147
1148 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1149
1150 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1151 # for the HTML output. The underlying search engine uses javascript
1152 # and DHTML and should work on any modern browser. Note that when using
1153 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1154 # (GENERATE_DOCSET) there is already a search function so this one should
1155 # typically be disabled. For large projects the javascript based search engine
1156 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1157
1158 SEARCHENGINE = YES
1159
1160 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1161 # implemented using a PHP enabled web server instead of at the web client
1162 # using Javascript. Doxygen will generate the search PHP script and index
1163 # file to put on the web server. The advantage of the server
1164 # based approach is that it scales better to large projects and allows
1165 # full text search. The disadvantages are that it is more difficult to setup
1166 # and does not have live searching capabilities.
1167
1168 SERVER_BASED_SEARCH = NO
1169
1170 #---------------------------------------------------------------------------
1171 # configuration options related to the LaTeX output
1172 #---------------------------------------------------------------------------
1173
1174 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1175 # generate Latex output.
1176
1177 GENERATE_LATEX = NO
1178
1179 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1180 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1181 # put in front of it. If left blank `latex' will be used as the default path.
1182
1183 LATEX_OUTPUT = latex
1184
1185 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1186 # invoked. If left blank `latex' will be used as the default command name.
1187 # Note that when enabling USE_PDFLATEX this option is only used for
1188 # generating bitmaps for formulas in the HTML output, but not in the
1189 # Makefile that is written to the output directory.
1190
1191 LATEX_CMD_NAME = latex
1192
1193 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1194 # generate index for LaTeX. If left blank `makeindex' will be used as the
1195 # default command name.
1196
1197 MAKEINDEX_CMD_NAME = makeindex
1198
1199 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1200 # LaTeX documents. This may be useful for small projects and may help to
1201 # save some trees in general.
1202
1203 COMPACT_LATEX = NO
1204
1205 # The PAPER_TYPE tag can be used to set the paper type that is used
1206 # by the printer. Possible values are: a4, letter, legal and
1207 # executive. If left blank a4wide will be used.
1208
1209 PAPER_TYPE = a4
1210
1211 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1212 # packages that should be included in the LaTeX output.
1213
1214 EXTRA_PACKAGES =
1215
1216 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1217 # the generated latex document. The header should contain everything until
1218 # the first chapter. If it is left blank doxygen will generate a
1219 # standard header. Notice: only use this tag if you know what you are doing!
1220
1221 LATEX_HEADER =
1222
1223 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1224 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1225 # contain links (just like the HTML output) instead of page references
1226 # This makes the output suitable for online browsing using a pdf viewer.
1227
1228 PDF_HYPERLINKS = YES
1229
1230 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1231 # plain latex in the generated Makefile. Set this option to YES to get a
1232 # higher quality PDF documentation.
1233
1234 USE_PDFLATEX = YES
1235
1236 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1237 # command to the generated LaTeX files. This will instruct LaTeX to keep
1238 # running if errors occur, instead of asking the user for help.
1239 # This option is also used when generating formulas in HTML.
1240
1241 LATEX_BATCHMODE = NO
1242
1243 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1244 # include the index chapters (such as File Index, Compound Index, etc.)
1245 # in the output.
1246
1247 LATEX_HIDE_INDICES = NO
1248
1249 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1250 # source code with syntax highlighting in the LaTeX output.
1251 # Note that which sources are shown also depends on other settings
1252 # such as SOURCE_BROWSER.
1253
1254 LATEX_SOURCE_CODE = NO
1255
1256 #---------------------------------------------------------------------------
1257 # configuration options related to the RTF output
1258 #---------------------------------------------------------------------------
1259
1260 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1261 # The RTF output is optimized for Word 97 and may not look very pretty with
1262 # other RTF readers or editors.
1263
1264 GENERATE_RTF = NO
1265
1266 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1267 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1268 # put in front of it. If left blank `rtf' will be used as the default path.
1269
1270 RTF_OUTPUT = rtf
1271
1272 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1273 # RTF documents. This may be useful for small projects and may help to
1274 # save some trees in general.
1275
1276 COMPACT_RTF = NO
1277
1278 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1279 # will contain hyperlink fields. The RTF file will
1280 # contain links (just like the HTML output) instead of page references.
1281 # This makes the output suitable for online browsing using WORD or other
1282 # programs which support those fields.
1283 # Note: wordpad (write) and others do not support links.
1284
1285 RTF_HYPERLINKS = NO
1286
1287 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1288 # config file, i.e. a series of assignments. You only have to provide
1289 # replacements, missing definitions are set to their default value.
1290
1291 RTF_STYLESHEET_FILE =
1292
1293 # Set optional variables used in the generation of an rtf document.
1294 # Syntax is similar to doxygen's config file.
1295
1296 RTF_EXTENSIONS_FILE =
1297
1298 #---------------------------------------------------------------------------
1299 # configuration options related to the man page output
1300 #---------------------------------------------------------------------------
1301
1302 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1303 # generate man pages
1304
1305 GENERATE_MAN = NO
1306
1307 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1308 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1309 # put in front of it. If left blank `man' will be used as the default path.
1310
1311 MAN_OUTPUT = man
1312
1313 # The MAN_EXTENSION tag determines the extension that is added to
1314 # the generated man pages (default is the subroutine's section .3)
1315
1316 MAN_EXTENSION = .3
1317
1318 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1319 # then it will generate one additional man file for each entity
1320 # documented in the real man page(s). These additional files
1321 # only source the real man page, but without them the man command
1322 # would be unable to find the correct page. The default is NO.
1323
1324 MAN_LINKS = NO
1325
1326 #---------------------------------------------------------------------------
1327 # configuration options related to the XML output
1328 #---------------------------------------------------------------------------
1329
1330 # If the GENERATE_XML tag is set to YES Doxygen will
1331 # generate an XML file that captures the structure of
1332 # the code including all documentation.
1333
1334 GENERATE_XML = NO
1335
1336 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1337 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1338 # put in front of it. If left blank `xml' will be used as the default path.
1339
1340 XML_OUTPUT = xml
1341
1342 # The XML_SCHEMA tag can be used to specify an XML schema,
1343 # which can be used by a validating XML parser to check the
1344 # syntax of the XML files.
1345
1346 XML_SCHEMA =
1347
1348 # The XML_DTD tag can be used to specify an XML DTD,
1349 # which can be used by a validating XML parser to check the
1350 # syntax of the XML files.
1351
1352 XML_DTD =
1353
1354 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1355 # dump the program listings (including syntax highlighting
1356 # and cross-referencing information) to the XML output. Note that
1357 # enabling this will significantly increase the size of the XML output.
1358
1359 XML_PROGRAMLISTING = YES
1360
1361 #---------------------------------------------------------------------------
1362 # configuration options for the AutoGen Definitions output
1363 #---------------------------------------------------------------------------
1364
1365 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1366 # generate an AutoGen Definitions (see autogen.sf.net) file
1367 # that captures the structure of the code including all
1368 # documentation. Note that this feature is still experimental
1369 # and incomplete at the moment.
1370
1371 GENERATE_AUTOGEN_DEF = NO
1372
1373 #---------------------------------------------------------------------------
1374 # configuration options related to the Perl module output
1375 #---------------------------------------------------------------------------
1376
1377 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1378 # generate a Perl module file that captures the structure of
1379 # the code including all documentation. Note that this
1380 # feature is still experimental and incomplete at the
1381 # moment.
1382
1383 GENERATE_PERLMOD = NO
1384
1385 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1386 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1387 # to generate PDF and DVI output from the Perl module output.
1388
1389 PERLMOD_LATEX = NO
1390
1391 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1392 # nicely formatted so it can be parsed by a human reader.
1393 # This is useful
1394 # if you want to understand what is going on.
1395 # On the other hand, if this
1396 # tag is set to NO the size of the Perl module output will be much smaller
1397 # and Perl will parse it just the same.
1398
1399 PERLMOD_PRETTY = YES
1400
1401 # The names of the make variables in the generated doxyrules.make file
1402 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1403 # This is useful so different doxyrules.make files included by the same
1404 # Makefile don't overwrite each other's variables.
1405
1406 PERLMOD_MAKEVAR_PREFIX =
1407
1408 #---------------------------------------------------------------------------
1409 # Configuration options related to the preprocessor
1410 #---------------------------------------------------------------------------
1411
1412 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1413 # evaluate all C-preprocessor directives found in the sources and include
1414 # files.
1415
1416 ENABLE_PREPROCESSING = YES
1417
1418 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1419 # names in the source code. If set to NO (the default) only conditional
1420 # compilation will be performed. Macro expansion can be done in a controlled
1421 # way by setting EXPAND_ONLY_PREDEF to YES.
1422
1423 MACRO_EXPANSION = NO
1424
1425 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1426 # then the macro expansion is limited to the macros specified with the
1427 # PREDEFINED and EXPAND_AS_DEFINED tags.
1428
1429 EXPAND_ONLY_PREDEF = NO
1430
1431 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1432 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1433
1434 SEARCH_INCLUDES = YES
1435
1436 # The INCLUDE_PATH tag can be used to specify one or more directories that
1437 # contain include files that are not input files but should be processed by
1438 # the preprocessor.
1439
1440 INCLUDE_PATH =
1441
1442 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1443 # patterns (like *.h and *.hpp) to filter out the header-files in the
1444 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1445 # be used.
1446
1447 INCLUDE_FILE_PATTERNS =
1448
1449 # The PREDEFINED tag can be used to specify one or more macro names that
1450 # are defined before the preprocessor is started (similar to the -D option of
1451 # gcc). The argument of the tag is a list of macros of the form: name
1452 # or name=definition (no spaces). If the definition and the = are
1453 # omitted =1 is assumed. To prevent a macro definition from being
1454 # undefined via #undef or recursively expanded use the := operator
1455 # instead of the = operator.
1456
1457 PREDEFINED = G4_USE_HBOOK
1458
1459 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1460 # this tag can be used to specify a list of macro names that should be expanded.
1461 # The macro definition that is found in the sources will be used.
1462 # Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
1463
1464 EXPAND_AS_DEFINED =
1465
1466 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1467 # doxygen's preprocessor will remove all references to function-like macros
1468 # that are alone on a line, have an all uppercase name, and do not end with a
1469 # semicolon, because these will confuse the parser if not removed.
1470
1471 SKIP_FUNCTION_MACROS = YES
1472
1473 #---------------------------------------------------------------------------
1474 # Configuration::additions related to external references
1475 #---------------------------------------------------------------------------
1476
1477 # The TAGFILES option can be used to specify one or more tagfiles.
1478 # Optionally an initial location of the external documentation
1479 # can be added for each tagfile. The format of a tag file without
1480 # this location is as follows:
1481 #
1482 # TAGFILES = file1 file2 ...
1483 # Adding location for the tag files is done as follows:
1484 #
1485 # TAGFILES = file1=loc1 "file2 = loc2" ...
1486 # where "loc1" and "loc2" can be relative or absolute paths or
1487 # URLs. If a location is present for each tag, the installdox tool
1488 # does not have to be run to correct the links.
1489 # Note that each tag file must have a unique name
1490 # (where the name does NOT include the path)
1491 # If a tag file is not located in the directory in which doxygen
1492 # is run, you must also specify the path to the tagfile here.
1493
1494 # The geant4.tag file has to be downloaded from:
1495 # http://www-geant4.kek.jp/Reference/"version number"/geant4.tag
1496 # before generation of documentation
1497 #
1498 TAGFILES = geant4.tag=http://www-geant4.kek.jp/Reference/9.4.p02
1499
1500 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1501 # a tag file that is based on the input files it reads.
1502
1503 GENERATE_TAGFILE =
1504
1505 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1506 # in the class index. If set to NO only the inherited external classes
1507 # will be listed.
1508
1509 ALLEXTERNALS = NO
1510
1511 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1512 # in the modules index. If set to NO, only the current project's groups will
1513 # be listed.
1514
1515 EXTERNAL_GROUPS = YES
1516
1517 # The PERL_PATH should be the absolute path and name of the perl script
1518 # interpreter (i.e. the result of `which perl').
1519
1520 PERL_PATH = /usr/bin/perl
1521
1522 #---------------------------------------------------------------------------
1523 # Configuration options related to the dot tool
1524 #---------------------------------------------------------------------------
1525
1526 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1527 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1528 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1529 # this option also works with HAVE_DOT disabled, but it is recommended to
1530 # install and use dot, since it yields more powerful graphs.
1531
1532 CLASS_DIAGRAMS = YES
1533
1534 # You can define message sequence charts within doxygen comments using the \msc
1535 # command. Doxygen will then run the mscgen tool (see
1536 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1537 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1538 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1539 # default search path.
1540
1541 MSCGEN_PATH =
1542
1543 # If set to YES, the inheritance and collaboration graphs will hide
1544 # inheritance and usage relations if the target is undocumented
1545 # or is not a class.
1546
1547 HIDE_UNDOC_RELATIONS = YES
1548
1549 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1550 # available from the path. This tool is part of Graphviz, a graph visualization
1551 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1552 # have no effect if this option is set to NO (the default)
1553
1554 HAVE_DOT = NO
1555
1556 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1557 # allowed to run in parallel. When set to 0 (the default) doxygen will
1558 # base this on the number of processors available in the system. You can set it
1559 # explicitly to a value larger than 0 to get control over the balance
1560 # between CPU load and processing speed.
1561
1562 DOT_NUM_THREADS = 0
1563
1564 # By default doxygen will write a font called Helvetica to the output
1565 # directory and reference it in all dot files that doxygen generates.
1566 # When you want a differently looking font you can specify the font name
1567 # using DOT_FONTNAME. You need to make sure dot is able to find the font,
1568 # which can be done by putting it in a standard location or by setting the
1569 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1570 # containing the font.
1571
1572 DOT_FONTNAME = Helvetica
1573
1574 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1575 # The default size is 10pt.
1576
1577 DOT_FONTSIZE = 10
1578
1579 # By default doxygen will tell dot to use the output directory to look for the
1580 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1581 # different font using DOT_FONTNAME you can set the path where dot
1582 # can find it using this tag.
1583
1584 DOT_FONTPATH =
1585
1586 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1587 # will generate a graph for each documented class showing the direct and
1588 # indirect inheritance relations. Setting this tag to YES will force the
1589 # the CLASS_DIAGRAMS tag to NO.
1590
1591 CLASS_GRAPH = YES
1592
1593 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1594 # will generate a graph for each documented class showing the direct and
1595 # indirect implementation dependencies (inheritance, containment, and
1596 # class references variables) of the class with other documented classes.
1597
1598 COLLABORATION_GRAPH = YES
1599
1600 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1601 # will generate a graph for groups, showing the direct groups dependencies
1602
1603 GROUP_GRAPHS = YES
1604
1605 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1606 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1607 # Language.
1608
1609 UML_LOOK = NO
1610
1611 # If set to YES, the inheritance and collaboration graphs will show the
1612 # relations between templates and their instances.
1613
1614 TEMPLATE_RELATIONS = NO
1615
1616 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1617 # tags are set to YES then doxygen will generate a graph for each documented
1618 # file showing the direct and indirect include dependencies of the file with
1619 # other documented files.
1620
1621 INCLUDE_GRAPH = YES
1622
1623 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1624 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1625 # documented header file showing the documented files that directly or
1626 # indirectly include this file.
1627
1628 INCLUDED_BY_GRAPH = YES
1629
1630 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1631 # doxygen will generate a call dependency graph for every global function
1632 # or class method. Note that enabling this option will significantly increase
1633 # the time of a run. So in most cases it will be better to enable call graphs
1634 # for selected functions only using the \callgraph command.
1635
1636 CALL_GRAPH = NO
1637
1638 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1639 # doxygen will generate a caller dependency graph for every global function
1640 # or class method. Note that enabling this option will significantly increase
1641 # the time of a run. So in most cases it will be better to enable caller
1642 # graphs for selected functions only using the \callergraph command.
1643
1644 CALLER_GRAPH = NO
1645
1646 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1647 # will generate a graphical hierarchy of all classes instead of a textual one.
1648
1649 GRAPHICAL_HIERARCHY = YES
1650
1651 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1652 # then doxygen will show the dependencies a directory has on other directories
1653 # in a graphical way. The dependency relations are determined by the #include
1654 # relations between the files in the directories.
1655
1656 DIRECTORY_GRAPH = YES
1657
1658 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1659 # generated by dot. Possible values are png, svg, gif or svg.
1660 # If left blank png will be used.
1661
1662 DOT_IMAGE_FORMAT = png
1663
1664 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1665 # found. If left blank, it is assumed the dot tool can be found in the path.
1666
1667 DOT_PATH =
1668
1669 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1670 # contain dot files that are included in the documentation (see the
1671 # \dotfile command).
1672
1673 DOTFILE_DIRS =
1674
1675 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1676 # contain msc files that are included in the documentation (see the
1677 # \mscfile command).
1678
1679 MSCFILE_DIRS =
1680
1681 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1682 # nodes that will be shown in the graph. If the number of nodes in a graph
1683 # becomes larger than this value, doxygen will truncate the graph, which is
1684 # visualized by representing a node as a red box. Note that doxygen if the
1685 # number of direct children of the root node in a graph is already larger than
1686 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1687 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1688
1689 DOT_GRAPH_MAX_NODES = 50
1690
1691 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1692 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1693 # from the root by following a path via at most 3 edges will be shown. Nodes
1694 # that lay further from the root node will be omitted. Note that setting this
1695 # option to 1 or 2 may greatly reduce the computation time needed for large
1696 # code bases. Also note that the size of a graph can be further restricted by
1697 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1698
1699 MAX_DOT_GRAPH_DEPTH = 0
1700
1701 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1702 # background. This is disabled by default, because dot on Windows does not
1703 # seem to support this out of the box. Warning: Depending on the platform used,
1704 # enabling this option may lead to badly anti-aliased labels on the edges of
1705 # a graph (i.e. they become hard to read).
1706
1707 DOT_TRANSPARENT = NO
1708
1709 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1710 # files in one run (i.e. multiple -o and -T options on the command line). This
1711 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1712 # support this, this feature is disabled by default.
1713
1714 DOT_MULTI_TARGETS = NO
1715
1716 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1717 # generate a legend page explaining the meaning of the various boxes and
1718 # arrows in the dot generated graphs.
1719
1720 GENERATE_LEGEND = YES
1721
1722 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1723 # remove the intermediate dot files that are used to generate
1724 # the various graphs.
1725
1726 DOT_CLEANUP = YES