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