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