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