terom@373: # Doxyfile 1.5.1 terom@373: terom@373: # This file describes the settings to be used by the documentation system terom@373: # doxygen (www.doxygen.org) for a project terom@373: # terom@373: # All text after a hash (#) is considered a comment and will be ignored terom@373: # The format is: terom@373: # TAG = value [value, ...] terom@373: # For lists items can also be appended using: terom@373: # TAG += value [value, ...] terom@373: # Values that contain spaces should be placed between quotes (" ") terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # Project related configuration options terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded terom@373: # by quotes) that should identify the project. terom@373: terom@373: PROJECT_NAME = Kishna Glista terom@373: terom@373: # The PROJECT_NUMBER tag can be used to enter a project or revision number. terom@373: # This could be handy for archiving the generated documentation or terom@373: # if some version control system is used. terom@373: terom@373: PROJECT_NUMBER = terom@373: terom@373: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) terom@373: # base path where the generated documentation will be put. terom@373: # If a relative path is entered, it will be relative to the location terom@373: # where doxygen was started. If left blank the current directory will be used. terom@373: terom@373: OUTPUT_DIRECTORY = terom@373: terom@373: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create terom@373: # 4096 sub-directories (in 2 levels) under the output directory of each output terom@373: # format and will distribute the generated files over these directories. terom@373: # Enabling this option can be useful when feeding doxygen a huge amount of terom@373: # source files, where putting all generated files in the same directory would terom@373: # otherwise cause performance problems for the file system. terom@373: terom@373: CREATE_SUBDIRS = NO terom@373: terom@373: # The OUTPUT_LANGUAGE tag is used to specify the language in which all terom@373: # documentation generated by doxygen is written. Doxygen will use this terom@373: # information to generate all constant output in the proper language. terom@373: # The default language is English, other supported languages are: terom@373: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, terom@373: # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, terom@373: # Italian, Japanese, Japanese-en (Japanese with English messages), Korean, terom@373: # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, terom@373: # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. terom@373: terom@373: OUTPUT_LANGUAGE = English terom@373: terom@373: # This tag can be used to specify the encoding used in the generated output. terom@373: # The encoding is not always determined by the language that is chosen, terom@373: # but also whether or not the output is meant for Windows or non-Windows users. terom@373: # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES terom@373: # forces the Windows encoding (this is the default for the Windows binary), terom@373: # whereas setting the tag to NO uses a Unix-style encoding (the default for terom@373: # all platforms other than Windows). terom@373: terom@373: USE_WINDOWS_ENCODING = NO terom@373: terom@373: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will terom@373: # include brief member descriptions after the members that are listed in terom@373: # the file and class documentation (similar to JavaDoc). terom@373: # Set to NO to disable this. terom@373: terom@373: BRIEF_MEMBER_DESC = YES terom@373: terom@373: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend terom@373: # the brief description of a member or function before the detailed description. terom@373: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the terom@373: # brief descriptions will be completely suppressed. terom@373: terom@373: REPEAT_BRIEF = YES terom@373: terom@373: # This tag implements a quasi-intelligent brief description abbreviator terom@373: # that is used to form the text in various listings. Each string terom@373: # in this list, if found as the leading text of the brief description, will be terom@373: # stripped from the text and the result after processing the whole list, is terom@373: # used as the annotated text. Otherwise, the brief description is used as-is. terom@373: # If left blank, the following values are used ("$name" is automatically terom@373: # replaced with the name of the entity): "The $name class" "The $name widget" terom@373: # "The $name file" "is" "provides" "specifies" "contains" terom@373: # "represents" "a" "an" "the" terom@373: terom@373: ABBREVIATE_BRIEF = terom@373: terom@373: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then terom@373: # Doxygen will generate a detailed section even if there is only a brief terom@373: # description. terom@373: terom@373: ALWAYS_DETAILED_SEC = NO terom@373: terom@373: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all terom@373: # inherited members of a class in the documentation of that class as if those terom@373: # members were ordinary class members. Constructors, destructors and assignment terom@373: # operators of the base classes will not be shown. terom@373: terom@373: INLINE_INHERITED_MEMB = NO terom@373: terom@373: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full terom@373: # path before files name in the file list and in the header files. If set terom@373: # to NO the shortest path that makes the file name unique will be used. terom@373: terom@373: FULL_PATH_NAMES = YES terom@373: terom@373: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag terom@373: # can be used to strip a user-defined part of the path. Stripping is terom@373: # only done if one of the specified strings matches the left-hand part of terom@373: # the path. The tag can be used to show relative paths in the file list. terom@373: # If left blank the directory from which doxygen is run is used as the terom@373: # path to strip. terom@373: terom@373: STRIP_FROM_PATH = terom@373: terom@373: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of terom@373: # the path mentioned in the documentation of a class, which tells terom@373: # the reader which header file to include in order to use a class. terom@373: # If left blank only the name of the header file containing the class terom@373: # definition is used. Otherwise one should specify the include paths that terom@373: # are normally passed to the compiler using the -I flag. terom@373: terom@373: STRIP_FROM_INC_PATH = terom@373: terom@373: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter terom@373: # (but less readable) file names. This can be useful is your file systems terom@373: # doesn't support long names like on DOS, Mac, or CD-ROM. terom@373: terom@373: SHORT_NAMES = NO terom@373: terom@373: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen terom@373: # will interpret the first line (until the first dot) of a JavaDoc-style terom@373: # comment as the brief description. If set to NO, the JavaDoc terom@373: # comments will behave just like the Qt-style comments (thus requiring an terom@373: # explicit @brief command for a brief description. terom@373: terom@373: JAVADOC_AUTOBRIEF = YES terom@373: terom@373: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen terom@373: # treat a multi-line C++ special comment block (i.e. a block of //! or /// terom@373: # comments) as a brief description. This used to be the default behaviour. terom@373: # The new default is to treat a multi-line C++ comment block as a detailed terom@373: # description. Set this tag to YES if you prefer the old behaviour instead. terom@373: terom@373: MULTILINE_CPP_IS_BRIEF = NO terom@373: terom@373: # If the DETAILS_AT_TOP tag is set to YES then Doxygen terom@373: # will output the detailed description near the top, like JavaDoc. terom@373: # If set to NO, the detailed description appears after the member terom@373: # documentation. terom@373: terom@373: DETAILS_AT_TOP = NO terom@373: terom@373: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented terom@373: # member inherits the documentation from any documented member that it terom@373: # re-implements. terom@373: terom@373: INHERIT_DOCS = YES terom@373: terom@373: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce terom@373: # a new page for each member. If set to NO, the documentation of a member will terom@373: # be part of the file/class/namespace that contains it. terom@373: terom@373: SEPARATE_MEMBER_PAGES = NO terom@373: terom@373: # The TAB_SIZE tag can be used to set the number of spaces in a tab. terom@373: # Doxygen uses this value to replace tabs by spaces in code fragments. terom@373: terom@373: TAB_SIZE = 8 terom@373: terom@373: # This tag can be used to specify a number of aliases that acts terom@373: # as commands in the documentation. An alias has the form "name=value". terom@373: # For example adding "sideeffect=\par Side Effects:\n" will allow you to terom@373: # put the command \sideeffect (or @sideeffect) in the documentation, which terom@373: # will result in a user-defined paragraph with heading "Side Effects:". terom@373: # You can put \n's in the value part of an alias to insert newlines. terom@373: terom@373: ALIASES = terom@373: terom@373: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C terom@373: # sources only. Doxygen will then generate output that is more tailored for C. terom@373: # For instance, some of the names that are used will be different. The list terom@373: # of all members will be omitted, etc. terom@373: terom@373: OPTIMIZE_OUTPUT_FOR_C = NO terom@373: terom@373: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java terom@373: # sources only. Doxygen will then generate output that is more tailored for Java. terom@373: # For instance, namespaces will be presented as packages, qualified scopes terom@373: # will look different, etc. terom@373: terom@373: OPTIMIZE_OUTPUT_JAVA = NO terom@373: terom@373: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to terom@373: # include (a tag file for) the STL sources as input, then you should terom@373: # set this tag to YES in order to let doxygen match functions declarations and terom@373: # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. terom@373: # func(std::string) {}). This also make the inheritance and collaboration terom@373: # diagrams that involve STL classes more complete and accurate. terom@373: terom@373: BUILTIN_STL_SUPPORT = NO terom@373: terom@373: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC terom@373: # tag is set to YES, then doxygen will reuse the documentation of the first terom@373: # member in the group (if any) for the other members of the group. By default terom@373: # all members of a group must be documented explicitly. terom@373: terom@373: DISTRIBUTE_GROUP_DOC = NO terom@373: terom@373: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of terom@373: # the same type (for instance a group of public functions) to be put as a terom@373: # subgroup of that type (e.g. under the Public Functions section). Set it to terom@373: # NO to prevent subgrouping. Alternatively, this can be done per class using terom@373: # the \nosubgrouping command. terom@373: terom@373: SUBGROUPING = YES terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # Build related configuration options terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in terom@373: # documentation are documented, even if no documentation was available. terom@373: # Private class members and static file members will be hidden unless terom@373: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES terom@373: terom@373: EXTRACT_ALL = NO terom@373: terom@373: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class terom@373: # will be included in the documentation. terom@373: terom@373: EXTRACT_PRIVATE = NO terom@373: terom@373: # If the EXTRACT_STATIC tag is set to YES all static members of a file terom@373: # will be included in the documentation. terom@373: terom@373: EXTRACT_STATIC = NO terom@373: terom@373: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) terom@373: # defined locally in source files will be included in the documentation. terom@373: # If set to NO only classes defined in header files are included. terom@373: terom@373: EXTRACT_LOCAL_CLASSES = YES terom@373: terom@373: # This flag is only useful for Objective-C code. When set to YES local terom@373: # methods, which are defined in the implementation section but not in terom@373: # the interface are included in the documentation. terom@373: # If set to NO (the default) only methods in the interface are included. terom@373: terom@373: EXTRACT_LOCAL_METHODS = NO terom@373: terom@373: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all terom@373: # undocumented members of documented classes, files or namespaces. terom@373: # If set to NO (the default) these members will be included in the terom@373: # various overviews, but no documentation section is generated. terom@373: # This option has no effect if EXTRACT_ALL is enabled. terom@373: terom@373: HIDE_UNDOC_MEMBERS = NO terom@373: terom@373: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all terom@373: # undocumented classes that are normally visible in the class hierarchy. terom@373: # If set to NO (the default) these classes will be included in the various terom@373: # overviews. This option has no effect if EXTRACT_ALL is enabled. terom@373: terom@373: HIDE_UNDOC_CLASSES = NO terom@373: terom@373: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all terom@373: # friend (class|struct|union) declarations. terom@373: # If set to NO (the default) these declarations will be included in the terom@373: # documentation. terom@373: terom@373: HIDE_FRIEND_COMPOUNDS = NO terom@373: terom@373: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any terom@373: # documentation blocks found inside the body of a function. terom@373: # If set to NO (the default) these blocks will be appended to the terom@373: # function's detailed documentation block. terom@373: terom@373: HIDE_IN_BODY_DOCS = NO terom@373: terom@373: # The INTERNAL_DOCS tag determines if documentation terom@373: # that is typed after a \internal command is included. If the tag is set terom@373: # to NO (the default) then the documentation will be excluded. terom@373: # Set it to YES to include the internal documentation. terom@373: terom@373: INTERNAL_DOCS = NO terom@373: terom@373: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate terom@373: # file names in lower-case letters. If set to YES upper-case letters are also terom@373: # allowed. This is useful if you have classes or files whose names only differ terom@373: # in case and if your file system supports case sensitive file names. Windows terom@373: # and Mac users are advised to set this option to NO. terom@373: terom@373: CASE_SENSE_NAMES = YES terom@373: terom@373: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen terom@373: # will show members with their full class and namespace scopes in the terom@373: # documentation. If set to YES the scope will be hidden. terom@373: terom@373: HIDE_SCOPE_NAMES = NO terom@373: terom@373: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen terom@373: # will put a list of the files that are included by a file in the documentation terom@373: # of that file. terom@373: terom@373: SHOW_INCLUDE_FILES = YES terom@373: terom@373: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] terom@373: # is inserted in the documentation for inline members. terom@373: terom@373: INLINE_INFO = YES terom@373: terom@373: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen terom@373: # will sort the (detailed) documentation of file and class members terom@373: # alphabetically by member name. If set to NO the members will appear in terom@373: # declaration order. terom@373: terom@373: SORT_MEMBER_DOCS = YES terom@373: terom@373: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the terom@373: # brief documentation of file, namespace and class members alphabetically terom@373: # by member name. If set to NO (the default) the members will appear in terom@373: # declaration order. terom@373: terom@373: SORT_BRIEF_DOCS = NO terom@373: terom@373: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be terom@373: # sorted by fully-qualified names, including namespaces. If set to terom@373: # NO (the default), the class list will be sorted only by class name, terom@373: # not including the namespace part. terom@373: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. terom@373: # Note: This option applies only to the class list, not to the terom@373: # alphabetical list. terom@373: terom@373: SORT_BY_SCOPE_NAME = NO terom@373: terom@373: # The GENERATE_TODOLIST tag can be used to enable (YES) or terom@373: # disable (NO) the todo list. This list is created by putting \todo terom@373: # commands in the documentation. terom@373: terom@373: GENERATE_TODOLIST = YES terom@373: terom@373: # The GENERATE_TESTLIST tag can be used to enable (YES) or terom@373: # disable (NO) the test list. This list is created by putting \test terom@373: # commands in the documentation. terom@373: terom@373: GENERATE_TESTLIST = YES terom@373: terom@373: # The GENERATE_BUGLIST tag can be used to enable (YES) or terom@373: # disable (NO) the bug list. This list is created by putting \bug terom@373: # commands in the documentation. terom@373: terom@373: GENERATE_BUGLIST = YES terom@373: terom@373: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or terom@373: # disable (NO) the deprecated list. This list is created by putting terom@373: # \deprecated commands in the documentation. terom@373: terom@373: GENERATE_DEPRECATEDLIST= YES terom@373: terom@373: # The ENABLED_SECTIONS tag can be used to enable conditional terom@373: # documentation sections, marked by \if sectionname ... \endif. terom@373: terom@373: ENABLED_SECTIONS = terom@373: terom@373: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines terom@373: # the initial value of a variable or define consists of for it to appear in terom@373: # the documentation. If the initializer consists of more lines than specified terom@373: # here it will be hidden. Use a value of 0 to hide initializers completely. terom@373: # The appearance of the initializer of individual variables and defines in the terom@373: # documentation can be controlled using \showinitializer or \hideinitializer terom@373: # command in the documentation regardless of this setting. terom@373: terom@373: MAX_INITIALIZER_LINES = 30 terom@373: terom@373: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated terom@373: # at the bottom of the documentation of classes and structs. If set to YES the terom@373: # list will mention the files that were used to generate the documentation. terom@373: terom@373: SHOW_USED_FILES = YES terom@373: terom@373: # If the sources in your project are distributed over multiple directories terom@373: # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy terom@373: # in the documentation. The default is NO. terom@373: terom@373: SHOW_DIRECTORIES = NO terom@373: terom@373: # The FILE_VERSION_FILTER tag can be used to specify a program or script that terom@373: # doxygen should invoke to get the current version for each file (typically from the terom@373: # version control system). Doxygen will invoke the program by executing (via terom@373: # popen()) the command , where is the value of terom@373: # the FILE_VERSION_FILTER tag, and is the name of an input file terom@373: # provided by doxygen. Whatever the program writes to standard output terom@373: # is used as the file version. See the manual for examples. terom@373: terom@373: FILE_VERSION_FILTER = terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to warning and progress messages terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # The QUIET tag can be used to turn on/off the messages that are generated terom@373: # by doxygen. Possible values are YES and NO. If left blank NO is used. terom@373: terom@373: QUIET = YES terom@373: terom@373: # The WARNINGS tag can be used to turn on/off the warning messages that are terom@373: # generated by doxygen. Possible values are YES and NO. If left blank terom@373: # NO is used. terom@373: terom@373: WARNINGS = YES terom@373: terom@373: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings terom@373: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will terom@373: # automatically be disabled. terom@373: terom@373: WARN_IF_UNDOCUMENTED = YES terom@373: terom@373: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for terom@373: # potential errors in the documentation, such as not documenting some terom@373: # parameters in a documented function, or documenting parameters that terom@373: # don't exist or using markup commands wrongly. terom@373: terom@373: WARN_IF_DOC_ERROR = YES terom@373: terom@373: # This WARN_NO_PARAMDOC option can be abled to get warnings for terom@373: # functions that are documented, but have no documentation for their parameters terom@373: # or return value. If set to NO (the default) doxygen will only warn about terom@373: # wrong or incomplete parameter documentation, but not about the absence of terom@373: # documentation. terom@373: terom@373: WARN_NO_PARAMDOC = NO terom@373: terom@373: # The WARN_FORMAT tag determines the format of the warning messages that terom@373: # doxygen can produce. The string should contain the $file, $line, and $text terom@373: # tags, which will be replaced by the file and line number from which the terom@373: # warning originated and the warning text. Optionally the format may contain terom@373: # $version, which will be replaced by the version of the file (if it could terom@373: # be obtained via FILE_VERSION_FILTER) terom@373: terom@373: WARN_FORMAT = "$file:$line: $text" terom@373: terom@373: # The WARN_LOGFILE tag can be used to specify a file to which warning terom@373: # and error messages should be written. If left blank the output is written terom@373: # to stderr. terom@373: terom@373: WARN_LOGFILE = terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to the input files terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # The INPUT tag can be used to specify the files and/or directories that contain terom@373: # documented source files. You may enter file names like "myfile.cpp" or terom@373: # directories like "/usr/src/myproject". Separate the files or directories terom@373: # with spaces. terom@373: terom@373: INPUT = kishna-glista.dox ../src terom@373: terom@373: # If the value of the INPUT tag contains directories, you can use the terom@373: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp terom@373: # and *.h) to filter out the source-files in the directories. If left terom@373: # blank the following patterns are tested: terom@373: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx terom@373: # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py terom@373: terom@373: FILE_PATTERNS = *.hh *.cc terom@373: terom@373: # The RECURSIVE tag can be used to turn specify whether or not subdirectories terom@373: # should be searched for input files as well. Possible values are YES and NO. terom@373: # If left blank NO is used. terom@373: terom@373: RECURSIVE = YES terom@373: terom@373: # The EXCLUDE tag can be used to specify files and/or directories that should terom@373: # excluded from the INPUT source files. This way you can easily exclude a terom@373: # subdirectory from a directory tree whose root is specified with the INPUT tag. terom@373: terom@373: EXCLUDE = terom@373: terom@373: # The EXCLUDE_SYMLINKS tag can be used select whether or not files or terom@373: # directories that are symbolic links (a Unix filesystem feature) are excluded terom@373: # from the input. terom@373: terom@373: EXCLUDE_SYMLINKS = NO terom@373: terom@373: # If the value of the INPUT tag contains directories, you can use the terom@373: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude terom@373: # certain files from those directories. Note that the wildcards are matched terom@373: # against the file with absolute path, so to exclude all test directories terom@373: # for example use the pattern */test/* terom@373: terom@373: EXCLUDE_PATTERNS = */.svn/* terom@373: terom@373: # The EXAMPLE_PATH tag can be used to specify one or more files or terom@373: # directories that contain example code fragments that are included (see terom@373: # the \include command). terom@373: terom@373: EXAMPLE_PATH = terom@373: terom@373: # If the value of the EXAMPLE_PATH tag contains directories, you can use the terom@373: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp terom@373: # and *.h) to filter out the source-files in the directories. If left terom@373: # blank all files are included. terom@373: terom@373: EXAMPLE_PATTERNS = terom@373: terom@373: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be terom@373: # searched for input files to be used with the \include or \dontinclude terom@373: # commands irrespective of the value of the RECURSIVE tag. terom@373: # Possible values are YES and NO. If left blank NO is used. terom@373: terom@373: EXAMPLE_RECURSIVE = NO terom@373: terom@373: # The IMAGE_PATH tag can be used to specify one or more files or terom@373: # directories that contain image that are included in the documentation (see terom@373: # the \image command). terom@373: terom@373: IMAGE_PATH = terom@373: terom@373: # The INPUT_FILTER tag can be used to specify a program that doxygen should terom@373: # invoke to filter for each input file. Doxygen will invoke the filter program terom@373: # by executing (via popen()) the command , where terom@373: # is the value of the INPUT_FILTER tag, and is the name of an terom@373: # input file. Doxygen will then use the output that the filter program writes terom@373: # to standard output. If FILTER_PATTERNS is specified, this tag will be terom@373: # ignored. terom@373: terom@373: INPUT_FILTER = terom@373: terom@373: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern terom@373: # basis. Doxygen will compare the file name with each pattern and apply the terom@373: # filter if there is a match. The filters are a list of the form: terom@373: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further terom@373: # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER terom@373: # is applied to all files. terom@373: terom@373: FILTER_PATTERNS = terom@373: terom@373: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using terom@373: # INPUT_FILTER) will be used to filter the input files when producing source terom@373: # files to browse (i.e. when SOURCE_BROWSER is set to YES). terom@373: terom@373: FILTER_SOURCE_FILES = NO terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to source browsing terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the SOURCE_BROWSER tag is set to YES then a list of source files will terom@373: # be generated. Documented entities will be cross-referenced with these sources. terom@373: # Note: To get rid of all source code in the generated output, make sure also terom@373: # VERBATIM_HEADERS is set to NO. terom@373: terom@373: SOURCE_BROWSER = NO terom@373: terom@373: # Setting the INLINE_SOURCES tag to YES will include the body terom@373: # of functions and classes directly in the documentation. terom@373: terom@373: INLINE_SOURCES = NO terom@373: terom@373: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct terom@373: # doxygen to hide any special comment blocks from generated source code terom@373: # fragments. Normal C and C++ comments will always remain visible. terom@373: terom@373: STRIP_CODE_COMMENTS = YES terom@373: terom@373: # If the REFERENCED_BY_RELATION tag is set to YES (the default) terom@373: # then for each documented function all documented terom@373: # functions referencing it will be listed. terom@373: terom@373: REFERENCED_BY_RELATION = YES terom@373: terom@373: # If the REFERENCES_RELATION tag is set to YES (the default) terom@373: # then for each documented function all documented entities terom@373: # called/used by that function will be listed. terom@373: terom@373: REFERENCES_RELATION = YES terom@373: terom@373: # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) terom@373: # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from terom@373: # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will terom@373: # link to the source code. Otherwise they will link to the documentstion. terom@373: terom@373: REFERENCES_LINK_SOURCE = YES terom@373: terom@373: # If the USE_HTAGS tag is set to YES then the references to source code terom@373: # will point to the HTML generated by the htags(1) tool instead of doxygen terom@373: # built-in source browser. The htags tool is part of GNU's global source terom@373: # tagging system (see http://www.gnu.org/software/global/global.html). You terom@373: # will need version 4.8.6 or higher. terom@373: terom@373: USE_HTAGS = NO terom@373: terom@373: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen terom@373: # will generate a verbatim copy of the header file for each class for terom@373: # which an include is specified. Set to NO to disable this. terom@373: terom@373: VERBATIM_HEADERS = YES terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to the alphabetical class index terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index terom@373: # of all compounds will be generated. Enable this if the project terom@373: # contains a lot of classes, structs, unions or interfaces. terom@373: terom@373: ALPHABETICAL_INDEX = NO terom@373: terom@373: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then terom@373: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns terom@373: # in which this list will be split (can be a number in the range [1..20]) terom@373: terom@373: COLS_IN_ALPHA_INDEX = 5 terom@373: terom@373: # In case all classes in a project start with a common prefix, all terom@373: # classes will be put under the same header in the alphabetical index. terom@373: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that terom@373: # should be ignored while generating the index headers. terom@373: terom@373: IGNORE_PREFIX = terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to the HTML output terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will terom@373: # generate HTML output. terom@373: terom@373: GENERATE_HTML = YES terom@373: terom@373: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. terom@373: # If a relative path is entered the value of OUTPUT_DIRECTORY will be terom@373: # put in front of it. If left blank `html' will be used as the default path. terom@373: terom@373: HTML_OUTPUT = html terom@373: terom@373: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for terom@373: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank terom@373: # doxygen will generate files with .html extension. terom@373: terom@373: HTML_FILE_EXTENSION = .html terom@373: terom@373: # The HTML_HEADER tag can be used to specify a personal HTML header for terom@373: # each generated HTML page. If it is left blank doxygen will generate a terom@373: # standard header. terom@373: terom@373: HTML_HEADER = terom@373: terom@373: # The HTML_FOOTER tag can be used to specify a personal HTML footer for terom@373: # each generated HTML page. If it is left blank doxygen will generate a terom@373: # standard footer. terom@373: terom@373: HTML_FOOTER = terom@373: terom@373: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading terom@373: # style sheet that is used by each HTML page. It can be used to terom@373: # fine-tune the look of the HTML output. If the tag is left blank doxygen terom@373: # will generate a default style sheet. Note that doxygen will try to copy terom@373: # the style sheet file to the HTML output directory, so don't put your own terom@373: # stylesheet in the HTML output directory as well, or it will be erased! terom@373: terom@373: HTML_STYLESHEET = terom@373: terom@373: # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, terom@373: # files or namespaces will be aligned in HTML using tables. If set to terom@373: # NO a bullet list will be used. terom@373: terom@373: HTML_ALIGN_MEMBERS = YES terom@373: terom@373: # If the GENERATE_HTMLHELP tag is set to YES, additional index files terom@373: # will be generated that can be used as input for tools like the terom@373: # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) terom@373: # of the generated HTML documentation. terom@373: terom@373: GENERATE_HTMLHELP = NO terom@373: terom@373: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can terom@373: # be used to specify the file name of the resulting .chm file. You terom@373: # can add a path in front of the file if the result should not be terom@373: # written to the html output directory. terom@373: terom@373: CHM_FILE = terom@373: terom@373: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can terom@373: # be used to specify the location (absolute path including file name) of terom@373: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run terom@373: # the HTML help compiler on the generated index.hhp. terom@373: terom@373: HHC_LOCATION = terom@373: terom@373: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag terom@373: # controls if a separate .chi index file is generated (YES) or that terom@373: # it should be included in the master .chm file (NO). terom@373: terom@373: GENERATE_CHI = NO terom@373: terom@373: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag terom@373: # controls whether a binary table of contents is generated (YES) or a terom@373: # normal table of contents (NO) in the .chm file. terom@373: terom@373: BINARY_TOC = NO terom@373: terom@373: # The TOC_EXPAND flag can be set to YES to add extra items for group members terom@373: # to the contents of the HTML help documentation and to the tree view. terom@373: terom@373: TOC_EXPAND = NO terom@373: terom@373: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at terom@373: # top of each HTML page. The value NO (the default) enables the index and terom@373: # the value YES disables it. terom@373: terom@373: DISABLE_INDEX = NO terom@373: terom@373: # This tag can be used to set the number of enum values (range [1..20]) terom@373: # that doxygen will group on one line in the generated HTML documentation. terom@373: terom@373: ENUM_VALUES_PER_LINE = 4 terom@373: terom@373: # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be terom@373: # generated containing a tree-like index structure (just like the one that terom@373: # is generated for HTML Help). For this to work a browser that supports terom@373: # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, terom@373: # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are terom@373: # probably better off using the HTML help feature. terom@373: terom@373: GENERATE_TREEVIEW = NO terom@373: terom@373: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be terom@373: # used to set the initial width (in pixels) of the frame in which the tree terom@373: # is shown. terom@373: terom@373: TREEVIEW_WIDTH = 250 terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to the LaTeX output terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will terom@373: # generate Latex output. terom@373: terom@373: GENERATE_LATEX = YES terom@373: terom@373: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. terom@373: # If a relative path is entered the value of OUTPUT_DIRECTORY will be terom@373: # put in front of it. If left blank `latex' will be used as the default path. terom@373: terom@373: LATEX_OUTPUT = latex terom@373: terom@373: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be terom@373: # invoked. If left blank `latex' will be used as the default command name. terom@373: terom@373: LATEX_CMD_NAME = latex terom@373: terom@373: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to terom@373: # generate index for LaTeX. If left blank `makeindex' will be used as the terom@373: # default command name. terom@373: terom@373: MAKEINDEX_CMD_NAME = makeindex terom@373: terom@373: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact terom@373: # LaTeX documents. This may be useful for small projects and may help to terom@373: # save some trees in general. terom@373: terom@373: COMPACT_LATEX = NO terom@373: terom@373: # The PAPER_TYPE tag can be used to set the paper type that is used terom@373: # by the printer. Possible values are: a4, a4wide, letter, legal and terom@373: # executive. If left blank a4wide will be used. terom@373: terom@373: PAPER_TYPE = a4wide terom@373: terom@373: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX terom@373: # packages that should be included in the LaTeX output. terom@373: terom@373: EXTRA_PACKAGES = terom@373: terom@373: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for terom@373: # the generated latex document. The header should contain everything until terom@373: # the first chapter. If it is left blank doxygen will generate a terom@373: # standard header. Notice: only use this tag if you know what you are doing! terom@373: terom@373: LATEX_HEADER = terom@373: terom@373: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated terom@373: # is prepared for conversion to pdf (using ps2pdf). The pdf file will terom@373: # contain links (just like the HTML output) instead of page references terom@373: # This makes the output suitable for online browsing using a pdf viewer. terom@373: terom@373: PDF_HYPERLINKS = NO terom@373: terom@373: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of terom@373: # plain latex in the generated Makefile. Set this option to YES to get a terom@373: # higher quality PDF documentation. terom@373: terom@373: USE_PDFLATEX = NO terom@373: terom@373: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. terom@373: # command to the generated LaTeX files. This will instruct LaTeX to keep terom@373: # running if errors occur, instead of asking the user for help. terom@373: # This option is also used when generating formulas in HTML. terom@373: terom@373: LATEX_BATCHMODE = NO terom@373: terom@373: # If LATEX_HIDE_INDICES is set to YES then doxygen will not terom@373: # include the index chapters (such as File Index, Compound Index, etc.) terom@373: # in the output. terom@373: terom@373: LATEX_HIDE_INDICES = NO terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to the RTF output terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output terom@373: # The RTF output is optimized for Word 97 and may not look very pretty with terom@373: # other RTF readers or editors. terom@373: terom@373: GENERATE_RTF = NO terom@373: terom@373: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. terom@373: # If a relative path is entered the value of OUTPUT_DIRECTORY will be terom@373: # put in front of it. If left blank `rtf' will be used as the default path. terom@373: terom@373: RTF_OUTPUT = rtf terom@373: terom@373: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact terom@373: # RTF documents. This may be useful for small projects and may help to terom@373: # save some trees in general. terom@373: terom@373: COMPACT_RTF = NO terom@373: terom@373: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated terom@373: # will contain hyperlink fields. The RTF file will terom@373: # contain links (just like the HTML output) instead of page references. terom@373: # This makes the output suitable for online browsing using WORD or other terom@373: # programs which support those fields. terom@373: # Note: wordpad (write) and others do not support links. terom@373: terom@373: RTF_HYPERLINKS = NO terom@373: terom@373: # Load stylesheet definitions from file. Syntax is similar to doxygen's terom@373: # config file, i.e. a series of assignments. You only have to provide terom@373: # replacements, missing definitions are set to their default value. terom@373: terom@373: RTF_STYLESHEET_FILE = terom@373: terom@373: # Set optional variables used in the generation of an rtf document. terom@373: # Syntax is similar to doxygen's config file. terom@373: terom@373: RTF_EXTENSIONS_FILE = terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to the man page output terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will terom@373: # generate man pages terom@373: terom@373: GENERATE_MAN = NO terom@373: terom@373: # The MAN_OUTPUT tag is used to specify where the man pages will be put. terom@373: # If a relative path is entered the value of OUTPUT_DIRECTORY will be terom@373: # put in front of it. If left blank `man' will be used as the default path. terom@373: terom@373: MAN_OUTPUT = man terom@373: terom@373: # The MAN_EXTENSION tag determines the extension that is added to terom@373: # the generated man pages (default is the subroutine's section .3) terom@373: terom@373: MAN_EXTENSION = .3 terom@373: terom@373: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, terom@373: # then it will generate one additional man file for each entity terom@373: # documented in the real man page(s). These additional files terom@373: # only source the real man page, but without them the man command terom@373: # would be unable to find the correct page. The default is NO. terom@373: terom@373: MAN_LINKS = NO terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to the XML output terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the GENERATE_XML tag is set to YES Doxygen will terom@373: # generate an XML file that captures the structure of terom@373: # the code including all documentation. terom@373: terom@373: GENERATE_XML = NO terom@373: terom@373: # The XML_OUTPUT tag is used to specify where the XML pages will be put. terom@373: # If a relative path is entered the value of OUTPUT_DIRECTORY will be terom@373: # put in front of it. If left blank `xml' will be used as the default path. terom@373: terom@373: XML_OUTPUT = xml terom@373: terom@373: # The XML_SCHEMA tag can be used to specify an XML schema, terom@373: # which can be used by a validating XML parser to check the terom@373: # syntax of the XML files. terom@373: terom@373: XML_SCHEMA = terom@373: terom@373: # The XML_DTD tag can be used to specify an XML DTD, terom@373: # which can be used by a validating XML parser to check the terom@373: # syntax of the XML files. terom@373: terom@373: XML_DTD = terom@373: terom@373: # If the XML_PROGRAMLISTING tag is set to YES Doxygen will terom@373: # dump the program listings (including syntax highlighting terom@373: # and cross-referencing information) to the XML output. Note that terom@373: # enabling this will significantly increase the size of the XML output. terom@373: terom@373: XML_PROGRAMLISTING = YES terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options for the AutoGen Definitions output terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will terom@373: # generate an AutoGen Definitions (see autogen.sf.net) file terom@373: # that captures the structure of the code including all terom@373: # documentation. Note that this feature is still experimental terom@373: # and incomplete at the moment. terom@373: terom@373: GENERATE_AUTOGEN_DEF = NO terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # configuration options related to the Perl module output terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the GENERATE_PERLMOD tag is set to YES Doxygen will terom@373: # generate a Perl module file that captures the structure of terom@373: # the code including all documentation. Note that this terom@373: # feature is still experimental and incomplete at the terom@373: # moment. terom@373: terom@373: GENERATE_PERLMOD = NO terom@373: terom@373: # If the PERLMOD_LATEX tag is set to YES Doxygen will generate terom@373: # the necessary Makefile rules, Perl scripts and LaTeX code to be able terom@373: # to generate PDF and DVI output from the Perl module output. terom@373: terom@373: PERLMOD_LATEX = NO terom@373: terom@373: # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be terom@373: # nicely formatted so it can be parsed by a human reader. This is useful terom@373: # if you want to understand what is going on. On the other hand, if this terom@373: # tag is set to NO the size of the Perl module output will be much smaller terom@373: # and Perl will parse it just the same. terom@373: terom@373: PERLMOD_PRETTY = YES terom@373: terom@373: # The names of the make variables in the generated doxyrules.make file terom@373: # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. terom@373: # This is useful so different doxyrules.make files included by the same terom@373: # Makefile don't overwrite each other's variables. terom@373: terom@373: PERLMOD_MAKEVAR_PREFIX = terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # Configuration options related to the preprocessor terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will terom@373: # evaluate all C-preprocessor directives found in the sources and include terom@373: # files. terom@373: terom@373: ENABLE_PREPROCESSING = YES terom@373: terom@373: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro terom@373: # names in the source code. If set to NO (the default) only conditional terom@373: # compilation will be performed. Macro expansion can be done in a controlled terom@373: # way by setting EXPAND_ONLY_PREDEF to YES. terom@373: terom@373: MACRO_EXPANSION = NO terom@373: terom@373: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES terom@373: # then the macro expansion is limited to the macros specified with the terom@373: # PREDEFINED and EXPAND_AS_DEFINED tags. terom@373: terom@373: EXPAND_ONLY_PREDEF = NO terom@373: terom@373: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files terom@373: # in the INCLUDE_PATH (see below) will be search if a #include is found. terom@373: terom@373: SEARCH_INCLUDES = YES terom@373: terom@373: # The INCLUDE_PATH tag can be used to specify one or more directories that terom@373: # contain include files that are not input files but should be processed by terom@373: # the preprocessor. terom@373: terom@373: INCLUDE_PATH = terom@373: terom@373: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard terom@373: # patterns (like *.h and *.hpp) to filter out the header-files in the terom@373: # directories. If left blank, the patterns specified with FILE_PATTERNS will terom@373: # be used. terom@373: terom@373: INCLUDE_FILE_PATTERNS = terom@373: terom@373: # The PREDEFINED tag can be used to specify one or more macro names that terom@373: # are defined before the preprocessor is started (similar to the -D option of terom@373: # gcc). The argument of the tag is a list of macros of the form: name terom@373: # or name=definition (no spaces). If the definition and the = are terom@373: # omitted =1 is assumed. To prevent a macro definition from being terom@373: # undefined via #undef or recursively expanded use the := operator terom@373: # instead of the = operator. terom@373: terom@373: PREDEFINED = terom@373: terom@373: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then terom@373: # this tag can be used to specify a list of macro names that should be expanded. terom@373: # The macro definition that is found in the sources will be used. terom@373: # Use the PREDEFINED tag if you want to use a different macro definition. terom@373: terom@373: EXPAND_AS_DEFINED = terom@373: terom@373: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then terom@373: # doxygen's preprocessor will remove all function-like macros that are alone terom@373: # on a line, have an all uppercase name, and do not end with a semicolon. Such terom@373: # function macros are typically used for boiler-plate code, and will confuse terom@373: # the parser if not removed. terom@373: terom@373: SKIP_FUNCTION_MACROS = YES terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # Configuration::additions related to external references terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # The TAGFILES option can be used to specify one or more tagfiles. terom@373: # Optionally an initial location of the external documentation terom@373: # can be added for each tagfile. The format of a tag file without terom@373: # this location is as follows: terom@373: # TAGFILES = file1 file2 ... terom@373: # Adding location for the tag files is done as follows: terom@373: # TAGFILES = file1=loc1 "file2 = loc2" ... terom@373: # where "loc1" and "loc2" can be relative or absolute paths or terom@373: # URLs. If a location is present for each tag, the installdox tool terom@373: # does not have to be run to correct the links. terom@373: # Note that each tag file must have a unique name terom@373: # (where the name does NOT include the path) terom@373: # If a tag file is not located in the directory in which doxygen terom@373: # is run, you must also specify the path to the tagfile here. terom@373: terom@373: TAGFILES = terom@373: terom@373: # When a file name is specified after GENERATE_TAGFILE, doxygen will create terom@373: # a tag file that is based on the input files it reads. terom@373: terom@373: GENERATE_TAGFILE = terom@373: terom@373: # If the ALLEXTERNALS tag is set to YES all external classes will be listed terom@373: # in the class index. If set to NO only the inherited external classes terom@373: # will be listed. terom@373: terom@373: ALLEXTERNALS = NO terom@373: terom@373: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed terom@373: # in the modules index. If set to NO, only the current project's groups will terom@373: # be listed. terom@373: terom@373: EXTERNAL_GROUPS = YES terom@373: terom@373: # The PERL_PATH should be the absolute path and name of the perl script terom@373: # interpreter (i.e. the result of `which perl'). terom@373: terom@373: PERL_PATH = /usr/bin/perl terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # Configuration options related to the dot tool terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will terom@373: # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base terom@373: # or super classes. Setting the tag to NO turns the diagrams off. Note that terom@373: # this option is superseded by the HAVE_DOT option below. This is only a terom@373: # fallback. It is recommended to install and use dot, since it yields more terom@373: # powerful graphs. terom@373: terom@373: CLASS_DIAGRAMS = YES terom@373: terom@373: # If set to YES, the inheritance and collaboration graphs will hide terom@373: # inheritance and usage relations if the target is undocumented terom@373: # or is not a class. terom@373: terom@373: HIDE_UNDOC_RELATIONS = YES terom@373: terom@373: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is terom@373: # available from the path. This tool is part of Graphviz, a graph visualization terom@373: # toolkit from AT&T and Lucent Bell Labs. The other options in this section terom@373: # have no effect if this option is set to NO (the default) terom@373: terom@373: HAVE_DOT = YES terom@373: terom@373: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen terom@373: # will generate a graph for each documented class showing the direct and terom@373: # indirect inheritance relations. Setting this tag to YES will force the terom@373: # the CLASS_DIAGRAMS tag to NO. terom@373: terom@373: CLASS_GRAPH = YES terom@373: terom@373: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen terom@373: # will generate a graph for each documented class showing the direct and terom@373: # indirect implementation dependencies (inheritance, containment, and terom@373: # class references variables) of the class with other documented classes. terom@373: terom@373: COLLABORATION_GRAPH = YES terom@373: terom@373: # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen terom@373: # will generate a graph for groups, showing the direct groups dependencies terom@373: terom@373: GROUP_GRAPHS = YES terom@373: terom@373: # If the UML_LOOK tag is set to YES doxygen will generate inheritance and terom@373: # collaboration diagrams in a style similar to the OMG's Unified Modeling terom@373: # Language. terom@373: terom@373: UML_LOOK = NO terom@373: terom@373: # If set to YES, the inheritance and collaboration graphs will show the terom@373: # relations between templates and their instances. terom@373: terom@373: TEMPLATE_RELATIONS = NO terom@373: terom@373: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT terom@373: # tags are set to YES then doxygen will generate a graph for each documented terom@373: # file showing the direct and indirect include dependencies of the file with terom@373: # other documented files. terom@373: terom@373: INCLUDE_GRAPH = YES terom@373: terom@373: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and terom@373: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each terom@373: # documented header file showing the documented files that directly or terom@373: # indirectly include this file. terom@373: terom@373: INCLUDED_BY_GRAPH = YES terom@373: terom@373: # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will terom@373: # generate a call dependency graph for every global function or class method. terom@373: # Note that enabling this option will significantly increase the time of a run. terom@373: # So in most cases it will be better to enable call graphs for selected terom@373: # functions only using the \callgraph command. terom@373: terom@373: CALL_GRAPH = NO terom@373: terom@373: # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will terom@373: # generate a caller dependency graph for every global function or class method. terom@373: # Note that enabling this option will significantly increase the time of a run. terom@373: # So in most cases it will be better to enable caller graphs for selected terom@373: # functions only using the \callergraph command. terom@373: terom@373: CALLER_GRAPH = NO terom@373: terom@373: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen terom@373: # will graphical hierarchy of all classes instead of a textual one. terom@373: terom@373: GRAPHICAL_HIERARCHY = YES terom@373: terom@373: # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES terom@373: # then doxygen will show the dependencies a directory has on other directories terom@373: # in a graphical way. The dependency relations are determined by the #include terom@373: # relations between the files in the directories. terom@373: terom@373: DIRECTORY_GRAPH = YES terom@373: terom@373: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images terom@373: # generated by dot. Possible values are png, jpg, or gif terom@373: # If left blank png will be used. terom@373: terom@373: DOT_IMAGE_FORMAT = png terom@373: terom@373: # The tag DOT_PATH can be used to specify the path where the dot tool can be terom@373: # found. If left blank, it is assumed the dot tool can be found in the path. terom@373: terom@373: DOT_PATH = terom@373: terom@373: # The DOTFILE_DIRS tag can be used to specify one or more directories that terom@373: # contain dot files that are included in the documentation (see the terom@373: # \dotfile command). terom@373: terom@373: DOTFILE_DIRS = terom@373: terom@373: # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width terom@373: # (in pixels) of the graphs generated by dot. If a graph becomes larger than terom@373: # this value, doxygen will try to truncate the graph, so that it fits within terom@373: # the specified constraint. Beware that most browsers cannot cope with very terom@373: # large images. terom@373: terom@373: MAX_DOT_GRAPH_WIDTH = 1024 terom@373: terom@373: # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height terom@373: # (in pixels) of the graphs generated by dot. If a graph becomes larger than terom@373: # this value, doxygen will try to truncate the graph, so that it fits within terom@373: # the specified constraint. Beware that most browsers cannot cope with very terom@373: # large images. terom@373: terom@373: MAX_DOT_GRAPH_HEIGHT = 1024 terom@373: terom@373: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the terom@373: # graphs generated by dot. A depth value of 3 means that only nodes reachable terom@373: # from the root by following a path via at most 3 edges will be shown. Nodes terom@373: # that lay further from the root node will be omitted. Note that setting this terom@373: # option to 1 or 2 may greatly reduce the computation time needed for large terom@373: # code bases. Also note that a graph may be further truncated if the graph's terom@373: # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH terom@373: # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), terom@373: # the graph is not depth-constrained. terom@373: terom@373: MAX_DOT_GRAPH_DEPTH = 0 terom@373: terom@373: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent terom@373: # background. This is disabled by default, which results in a white background. terom@373: # Warning: Depending on the platform used, enabling this option may lead to terom@373: # badly anti-aliased labels on the edges of a graph (i.e. they become hard to terom@373: # read). terom@373: terom@373: DOT_TRANSPARENT = NO terom@373: terom@373: # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output terom@373: # files in one run (i.e. multiple -o and -T options on the command line). This terom@373: # makes dot run faster, but since only newer versions of dot (>1.8.10) terom@373: # support this, this feature is disabled by default. terom@373: terom@373: DOT_MULTI_TARGETS = NO terom@373: terom@373: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will terom@373: # generate a legend page explaining the meaning of the various boxes and terom@373: # arrows in the dot generated graphs. terom@373: terom@373: GENERATE_LEGEND = YES terom@373: terom@373: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will terom@373: # remove the intermediate dot files that are used to generate terom@373: # the various graphs. terom@373: terom@373: DOT_CLEANUP = YES terom@373: terom@373: #--------------------------------------------------------------------------- terom@373: # Configuration::additions related to the search engine terom@373: #--------------------------------------------------------------------------- terom@373: terom@373: # The SEARCHENGINE tag specifies whether or not a search engine should be terom@373: # used. If set to NO the values of all tags below this one will be ignored. terom@373: terom@373: SEARCHENGINE = NO