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