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