adamstark@60: # Doxyfile 1.8.2 adamstark@60: adamstark@60: # This file describes the settings to be used by the documentation system adamstark@60: # doxygen (www.doxygen.org) for a project adamstark@60: # adamstark@60: # All text after a hash (#) is considered a comment and will be ignored adamstark@60: # The format is: adamstark@60: # TAG = value [value, ...] adamstark@60: # For lists items can also be appended using: adamstark@60: # TAG += value [value, ...] adamstark@60: # Values that contain spaces should be placed between quotes (" ") adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # Project related configuration options adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # This tag specifies the encoding used for all characters in the config file adamstark@60: # that follow. The default is UTF-8 which is also the encoding used for all adamstark@60: # text before the first occurrence of this tag. Doxygen uses libiconv (or the adamstark@60: # iconv built into libc) for the transcoding. See adamstark@60: # http://www.gnu.org/software/libiconv for the list of possible encodings. adamstark@60: adamstark@60: DOXYFILE_ENCODING = UTF-8 adamstark@60: adamstark@60: # The PROJECT_NAME tag is a single word (or sequence of words) that should adamstark@60: # identify the project. Note that if you do not use Doxywizard you need adamstark@60: # to put quotes around the project name if it contains spaces. adamstark@60: adamstark@60: PROJECT_NAME = "BTrack - A Real-Time Beat Tracker" adamstark@60: adamstark@60: # The PROJECT_NUMBER tag can be used to enter a project or revision number. adamstark@60: # This could be handy for archiving the generated documentation or adamstark@60: # if some version control system is used. adamstark@60: adamstark@60: PROJECT_NUMBER = adamstark@60: adamstark@60: # Using the PROJECT_BRIEF tag one can provide an optional one line description adamstark@60: # for a project that appears at the top of each page and should give viewer adamstark@60: # a quick idea about the purpose of the project. Keep the description short. adamstark@60: adamstark@60: PROJECT_BRIEF = adamstark@60: adamstark@60: # With the PROJECT_LOGO tag one can specify an logo or icon that is adamstark@60: # included in the documentation. The maximum height of the logo should not adamstark@60: # exceed 55 pixels and the maximum width should not exceed 200 pixels. adamstark@60: # Doxygen will copy the logo to the output directory. adamstark@60: adamstark@60: PROJECT_LOGO = adamstark@60: adamstark@60: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) adamstark@60: # base path where the generated documentation will be put. adamstark@60: # If a relative path is entered, it will be relative to the location adamstark@60: # where doxygen was started. If left blank the current directory will be used. adamstark@60: adamstark@60: OUTPUT_DIRECTORY = doc adamstark@60: adamstark@60: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create adamstark@60: # 4096 sub-directories (in 2 levels) under the output directory of each output adamstark@60: # format and will distribute the generated files over these directories. adamstark@60: # Enabling this option can be useful when feeding doxygen a huge amount of adamstark@60: # source files, where putting all generated files in the same directory would adamstark@60: # otherwise cause performance problems for the file system. adamstark@60: adamstark@60: CREATE_SUBDIRS = NO adamstark@60: adamstark@60: # The OUTPUT_LANGUAGE tag is used to specify the language in which all adamstark@60: # documentation generated by doxygen is written. Doxygen will use this adamstark@60: # information to generate all constant output in the proper language. adamstark@60: # The default language is English, other supported languages are: adamstark@60: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, adamstark@60: # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, adamstark@60: # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English adamstark@60: # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, adamstark@60: # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, adamstark@60: # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. adamstark@60: adamstark@60: OUTPUT_LANGUAGE = English adamstark@60: adamstark@60: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will adamstark@60: # include brief member descriptions after the members that are listed in adamstark@60: # the file and class documentation (similar to JavaDoc). adamstark@60: # Set to NO to disable this. adamstark@60: adamstark@60: BRIEF_MEMBER_DESC = YES adamstark@60: adamstark@60: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend adamstark@60: # the brief description of a member or function before the detailed description. adamstark@60: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the adamstark@60: # brief descriptions will be completely suppressed. adamstark@60: adamstark@60: REPEAT_BRIEF = YES adamstark@60: adamstark@60: # This tag implements a quasi-intelligent brief description abbreviator adamstark@60: # that is used to form the text in various listings. Each string adamstark@60: # in this list, if found as the leading text of the brief description, will be adamstark@60: # stripped from the text and the result after processing the whole list, is adamstark@60: # used as the annotated text. Otherwise, the brief description is used as-is. adamstark@60: # If left blank, the following values are used ("$name" is automatically adamstark@60: # replaced with the name of the entity): "The $name class" "The $name widget" adamstark@60: # "The $name file" "is" "provides" "specifies" "contains" adamstark@60: # "represents" "a" "an" "the" adamstark@60: adamstark@60: ABBREVIATE_BRIEF = "The $name class" \ adamstark@60: "The $name widget" \ adamstark@60: "The $name file" \ adamstark@60: is \ adamstark@60: provides \ adamstark@60: specifies \ adamstark@60: contains \ adamstark@60: represents \ adamstark@60: a \ adamstark@60: an \ adamstark@60: the adamstark@60: adamstark@60: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then adamstark@60: # Doxygen will generate a detailed section even if there is only a brief adamstark@60: # description. adamstark@60: adamstark@60: ALWAYS_DETAILED_SEC = NO adamstark@60: adamstark@60: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all adamstark@60: # inherited members of a class in the documentation of that class as if those adamstark@60: # members were ordinary class members. Constructors, destructors and assignment adamstark@60: # operators of the base classes will not be shown. adamstark@60: adamstark@60: INLINE_INHERITED_MEMB = NO adamstark@60: adamstark@60: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full adamstark@60: # path before files name in the file list and in the header files. If set adamstark@60: # to NO the shortest path that makes the file name unique will be used. adamstark@60: adamstark@60: FULL_PATH_NAMES = YES adamstark@60: adamstark@60: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag adamstark@60: # can be used to strip a user-defined part of the path. Stripping is adamstark@60: # only done if one of the specified strings matches the left-hand part of adamstark@60: # the path. The tag can be used to show relative paths in the file list. adamstark@60: # If left blank the directory from which doxygen is run is used as the adamstark@60: # path to strip. Note that you specify absolute paths here, but also adamstark@60: # relative paths, which will be relative from the directory where doxygen is adamstark@60: # started. adamstark@60: adamstark@60: STRIP_FROM_PATH = adamstark@60: adamstark@60: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of adamstark@60: # the path mentioned in the documentation of a class, which tells adamstark@60: # the reader which header file to include in order to use a class. adamstark@60: # If left blank only the name of the header file containing the class adamstark@60: # definition is used. Otherwise one should specify the include paths that adamstark@60: # are normally passed to the compiler using the -I flag. adamstark@60: adamstark@60: STRIP_FROM_INC_PATH = adamstark@60: adamstark@60: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter adamstark@60: # (but less readable) file names. This can be useful if your file system adamstark@60: # doesn't support long names like on DOS, Mac, or CD-ROM. adamstark@60: adamstark@60: SHORT_NAMES = NO adamstark@60: adamstark@60: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen adamstark@60: # will interpret the first line (until the first dot) of a JavaDoc-style adamstark@60: # comment as the brief description. If set to NO, the JavaDoc adamstark@60: # comments will behave just like regular Qt-style comments adamstark@60: # (thus requiring an explicit @brief command for a brief description.) adamstark@60: adamstark@60: JAVADOC_AUTOBRIEF = NO adamstark@60: adamstark@60: # If the QT_AUTOBRIEF tag is set to YES then Doxygen will adamstark@60: # interpret the first line (until the first dot) of a Qt-style adamstark@60: # comment as the brief description. If set to NO, the comments adamstark@60: # will behave just like regular Qt-style comments (thus requiring adamstark@60: # an explicit \brief command for a brief description.) adamstark@60: adamstark@60: QT_AUTOBRIEF = NO adamstark@60: adamstark@60: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen adamstark@60: # treat a multi-line C++ special comment block (i.e. a block of //! or /// adamstark@60: # comments) as a brief description. This used to be the default behaviour. adamstark@60: # The new default is to treat a multi-line C++ comment block as a detailed adamstark@60: # description. Set this tag to YES if you prefer the old behaviour instead. adamstark@60: adamstark@60: MULTILINE_CPP_IS_BRIEF = NO adamstark@60: adamstark@60: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented adamstark@60: # member inherits the documentation from any documented member that it adamstark@60: # re-implements. adamstark@60: adamstark@60: INHERIT_DOCS = YES adamstark@60: adamstark@60: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce adamstark@60: # a new page for each member. If set to NO, the documentation of a member will adamstark@60: # be part of the file/class/namespace that contains it. adamstark@60: adamstark@60: SEPARATE_MEMBER_PAGES = NO adamstark@60: adamstark@60: # The TAB_SIZE tag can be used to set the number of spaces in a tab. adamstark@60: # Doxygen uses this value to replace tabs by spaces in code fragments. adamstark@60: adamstark@60: TAB_SIZE = 4 adamstark@60: adamstark@60: # This tag can be used to specify a number of aliases that acts adamstark@60: # as commands in the documentation. An alias has the form "name=value". adamstark@60: # For example adding "sideeffect=\par Side Effects:\n" will allow you to adamstark@60: # put the command \sideeffect (or @sideeffect) in the documentation, which adamstark@60: # will result in a user-defined paragraph with heading "Side Effects:". adamstark@60: # You can put \n's in the value part of an alias to insert newlines. adamstark@60: adamstark@60: ALIASES = adamstark@60: adamstark@60: # This tag can be used to specify a number of word-keyword mappings (TCL only). adamstark@60: # A mapping has the form "name=value". For example adding adamstark@60: # "class=itcl::class" will allow you to use the command class in the adamstark@60: # itcl::class meaning. adamstark@60: adamstark@60: TCL_SUBST = adamstark@60: adamstark@60: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C adamstark@60: # sources only. Doxygen will then generate output that is more tailored for C. adamstark@60: # For instance, some of the names that are used will be different. The list adamstark@60: # of all members will be omitted, etc. adamstark@60: adamstark@60: OPTIMIZE_OUTPUT_FOR_C = NO adamstark@60: adamstark@60: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java adamstark@60: # sources only. Doxygen will then generate output that is more tailored for adamstark@60: # Java. For instance, namespaces will be presented as packages, qualified adamstark@60: # scopes will look different, etc. adamstark@60: adamstark@60: OPTIMIZE_OUTPUT_JAVA = NO adamstark@60: adamstark@60: # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran adamstark@60: # sources only. Doxygen will then generate output that is more tailored for adamstark@60: # Fortran. adamstark@60: adamstark@60: OPTIMIZE_FOR_FORTRAN = NO adamstark@60: adamstark@60: # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL adamstark@60: # sources. Doxygen will then generate output that is tailored for adamstark@60: # VHDL. adamstark@60: adamstark@60: OPTIMIZE_OUTPUT_VHDL = NO adamstark@60: adamstark@60: # Doxygen selects the parser to use depending on the extension of the files it adamstark@60: # parses. With this tag you can assign which parser to use for a given adamstark@60: # extension. Doxygen has a built-in mapping, but you can override or extend it adamstark@60: # using this tag. The format is ext=language, where ext is a file extension, adamstark@60: # and language is one of the parsers supported by doxygen: IDL, Java, adamstark@60: # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, adamstark@60: # C++. For instance to make doxygen treat .inc files as Fortran files (default adamstark@60: # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note adamstark@60: # that for custom extensions you also need to set FILE_PATTERNS otherwise the adamstark@60: # files are not read by doxygen. adamstark@60: adamstark@60: EXTENSION_MAPPING = adamstark@60: adamstark@60: # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all adamstark@60: # comments according to the Markdown format, which allows for more readable adamstark@60: # documentation. See http://daringfireball.net/projects/markdown/ for details. adamstark@60: # The output of markdown processing is further processed by doxygen, so you adamstark@60: # can mix doxygen, HTML, and XML commands with Markdown formatting. adamstark@60: # Disable only in case of backward compatibilities issues. adamstark@60: adamstark@60: MARKDOWN_SUPPORT = YES adamstark@60: adamstark@60: # When enabled doxygen tries to link words that correspond to documented classes, adamstark@60: # or namespaces to their corresponding documentation. Such a link can be adamstark@60: # prevented in individual cases by by putting a % sign in front of the word or adamstark@60: # globally by setting AUTOLINK_SUPPORT to NO. adamstark@60: adamstark@60: AUTOLINK_SUPPORT = YES adamstark@60: adamstark@60: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want adamstark@60: # to include (a tag file for) the STL sources as input, then you should adamstark@60: # set this tag to YES in order to let doxygen match functions declarations and adamstark@60: # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. adamstark@60: # func(std::string) {}). This also makes the inheritance and collaboration adamstark@60: # diagrams that involve STL classes more complete and accurate. adamstark@60: adamstark@60: BUILTIN_STL_SUPPORT = NO adamstark@60: adamstark@60: # If you use Microsoft's C++/CLI language, you should set this option to YES to adamstark@60: # enable parsing support. adamstark@60: adamstark@60: CPP_CLI_SUPPORT = NO adamstark@60: adamstark@60: # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. adamstark@60: # Doxygen will parse them like normal C++ but will assume all classes use public adamstark@60: # instead of private inheritance when no explicit protection keyword is present. adamstark@60: adamstark@60: SIP_SUPPORT = NO adamstark@60: adamstark@60: # For Microsoft's IDL there are propget and propput attributes to indicate adamstark@60: # getter and setter methods for a property. Setting this option to YES (the adamstark@60: # default) will make doxygen replace the get and set methods by a property in adamstark@60: # the documentation. This will only work if the methods are indeed getting or adamstark@60: # setting a simple type. If this is not the case, or you want to show the adamstark@60: # methods anyway, you should set this option to NO. adamstark@60: adamstark@60: IDL_PROPERTY_SUPPORT = YES adamstark@60: adamstark@60: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC adamstark@60: # tag is set to YES, then doxygen will reuse the documentation of the first adamstark@60: # member in the group (if any) for the other members of the group. By default adamstark@60: # all members of a group must be documented explicitly. adamstark@60: adamstark@60: DISTRIBUTE_GROUP_DOC = NO adamstark@60: adamstark@60: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of adamstark@60: # the same type (for instance a group of public functions) to be put as a adamstark@60: # subgroup of that type (e.g. under the Public Functions section). Set it to adamstark@60: # NO to prevent subgrouping. Alternatively, this can be done per class using adamstark@60: # the \nosubgrouping command. adamstark@60: adamstark@60: SUBGROUPING = YES adamstark@60: adamstark@60: # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and adamstark@60: # unions are shown inside the group in which they are included (e.g. using adamstark@60: # @ingroup) instead of on a separate page (for HTML and Man pages) or adamstark@60: # section (for LaTeX and RTF). adamstark@60: adamstark@60: INLINE_GROUPED_CLASSES = NO adamstark@60: adamstark@60: # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and adamstark@60: # unions with only public data fields will be shown inline in the documentation adamstark@60: # of the scope in which they are defined (i.e. file, namespace, or group adamstark@60: # documentation), provided this scope is documented. If set to NO (the default), adamstark@60: # structs, classes, and unions are shown on a separate page (for HTML and Man adamstark@60: # pages) or section (for LaTeX and RTF). adamstark@60: adamstark@60: INLINE_SIMPLE_STRUCTS = NO adamstark@60: adamstark@60: # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum adamstark@60: # is documented as struct, union, or enum with the name of the typedef. So adamstark@60: # typedef struct TypeS {} TypeT, will appear in the documentation as a struct adamstark@60: # with name TypeT. When disabled the typedef will appear as a member of a file, adamstark@60: # namespace, or class. And the struct will be named TypeS. This can typically adamstark@60: # be useful for C code in case the coding convention dictates that all compound adamstark@60: # types are typedef'ed and only the typedef is referenced, never the tag name. adamstark@60: adamstark@60: TYPEDEF_HIDES_STRUCT = NO adamstark@60: adamstark@60: # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to adamstark@60: # determine which symbols to keep in memory and which to flush to disk. adamstark@60: # When the cache is full, less often used symbols will be written to disk. adamstark@60: # For small to medium size projects (<1000 input files) the default value is adamstark@60: # probably good enough. For larger projects a too small cache size can cause adamstark@60: # doxygen to be busy swapping symbols to and from disk most of the time adamstark@60: # causing a significant performance penalty. adamstark@60: # If the system has enough physical memory increasing the cache will improve the adamstark@60: # performance by keeping more symbols in memory. Note that the value works on adamstark@60: # a logarithmic scale so increasing the size by one will roughly double the adamstark@60: # memory usage. The cache size is given by this formula: adamstark@60: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, adamstark@60: # corresponding to a cache size of 2^16 = 65536 symbols. adamstark@60: adamstark@60: SYMBOL_CACHE_SIZE = 0 adamstark@60: adamstark@60: # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be adamstark@60: # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given adamstark@60: # their name and scope. Since this can be an expensive process and often the adamstark@60: # same symbol appear multiple times in the code, doxygen keeps a cache of adamstark@60: # pre-resolved symbols. If the cache is too small doxygen will become slower. adamstark@60: # If the cache is too large, memory is wasted. The cache size is given by this adamstark@60: # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, adamstark@60: # corresponding to a cache size of 2^16 = 65536 symbols. adamstark@60: adamstark@60: LOOKUP_CACHE_SIZE = 0 adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # Build related configuration options adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in adamstark@60: # documentation are documented, even if no documentation was available. adamstark@60: # Private class members and static file members will be hidden unless adamstark@60: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES adamstark@60: adamstark@60: EXTRACT_ALL = NO adamstark@60: adamstark@60: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class adamstark@60: # will be included in the documentation. adamstark@60: adamstark@60: EXTRACT_PRIVATE = NO adamstark@60: adamstark@60: # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal adamstark@60: # scope will be included in the documentation. adamstark@60: adamstark@60: EXTRACT_PACKAGE = NO adamstark@60: adamstark@60: # If the EXTRACT_STATIC tag is set to YES all static members of a file adamstark@60: # will be included in the documentation. adamstark@60: adamstark@60: EXTRACT_STATIC = NO adamstark@60: adamstark@60: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) adamstark@60: # defined locally in source files will be included in the documentation. adamstark@60: # If set to NO only classes defined in header files are included. adamstark@60: adamstark@60: EXTRACT_LOCAL_CLASSES = YES adamstark@60: adamstark@60: # This flag is only useful for Objective-C code. When set to YES local adamstark@60: # methods, which are defined in the implementation section but not in adamstark@60: # the interface are included in the documentation. adamstark@60: # If set to NO (the default) only methods in the interface are included. adamstark@60: adamstark@60: EXTRACT_LOCAL_METHODS = NO adamstark@60: adamstark@60: # If this flag is set to YES, the members of anonymous namespaces will be adamstark@60: # extracted and appear in the documentation as a namespace called adamstark@60: # 'anonymous_namespace{file}', where file will be replaced with the base adamstark@60: # name of the file that contains the anonymous namespace. By default adamstark@60: # anonymous namespaces are hidden. adamstark@60: adamstark@60: EXTRACT_ANON_NSPACES = NO adamstark@60: adamstark@60: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all adamstark@60: # undocumented members of documented classes, files or namespaces. adamstark@60: # If set to NO (the default) these members will be included in the adamstark@60: # various overviews, but no documentation section is generated. adamstark@60: # This option has no effect if EXTRACT_ALL is enabled. adamstark@60: adamstark@60: HIDE_UNDOC_MEMBERS = NO adamstark@60: adamstark@60: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all adamstark@60: # undocumented classes that are normally visible in the class hierarchy. adamstark@60: # If set to NO (the default) these classes will be included in the various adamstark@60: # overviews. This option has no effect if EXTRACT_ALL is enabled. adamstark@60: adamstark@60: HIDE_UNDOC_CLASSES = NO adamstark@60: adamstark@60: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all adamstark@60: # friend (class|struct|union) declarations. adamstark@60: # If set to NO (the default) these declarations will be included in the adamstark@60: # documentation. adamstark@60: adamstark@60: HIDE_FRIEND_COMPOUNDS = NO adamstark@60: adamstark@60: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any adamstark@60: # documentation blocks found inside the body of a function. adamstark@60: # If set to NO (the default) these blocks will be appended to the adamstark@60: # function's detailed documentation block. adamstark@60: adamstark@60: HIDE_IN_BODY_DOCS = NO adamstark@60: adamstark@60: # The INTERNAL_DOCS tag determines if documentation adamstark@60: # that is typed after a \internal command is included. If the tag is set adamstark@60: # to NO (the default) then the documentation will be excluded. adamstark@60: # Set it to YES to include the internal documentation. adamstark@60: adamstark@60: INTERNAL_DOCS = NO adamstark@60: adamstark@60: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate adamstark@60: # file names in lower-case letters. If set to YES upper-case letters are also adamstark@60: # allowed. This is useful if you have classes or files whose names only differ adamstark@60: # in case and if your file system supports case sensitive file names. Windows adamstark@60: # and Mac users are advised to set this option to NO. adamstark@60: adamstark@60: CASE_SENSE_NAMES = NO adamstark@60: adamstark@60: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen adamstark@60: # will show members with their full class and namespace scopes in the adamstark@60: # documentation. If set to YES the scope will be hidden. adamstark@60: adamstark@60: HIDE_SCOPE_NAMES = NO adamstark@60: adamstark@60: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen adamstark@60: # will put a list of the files that are included by a file in the documentation adamstark@60: # of that file. adamstark@60: adamstark@60: SHOW_INCLUDE_FILES = YES adamstark@60: adamstark@60: # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen adamstark@60: # will list include files with double quotes in the documentation adamstark@60: # rather than with sharp brackets. adamstark@60: adamstark@60: FORCE_LOCAL_INCLUDES = NO adamstark@60: adamstark@60: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] adamstark@60: # is inserted in the documentation for inline members. adamstark@60: adamstark@60: INLINE_INFO = YES adamstark@60: adamstark@60: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen adamstark@60: # will sort the (detailed) documentation of file and class members adamstark@60: # alphabetically by member name. If set to NO the members will appear in adamstark@60: # declaration order. adamstark@60: adamstark@60: SORT_MEMBER_DOCS = YES adamstark@60: adamstark@60: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the adamstark@60: # brief documentation of file, namespace and class members alphabetically adamstark@60: # by member name. If set to NO (the default) the members will appear in adamstark@60: # declaration order. adamstark@60: adamstark@60: SORT_BRIEF_DOCS = NO adamstark@60: adamstark@60: # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen adamstark@60: # will sort the (brief and detailed) documentation of class members so that adamstark@60: # constructors and destructors are listed first. If set to NO (the default) adamstark@60: # the constructors will appear in the respective orders defined by adamstark@60: # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. adamstark@60: # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO adamstark@60: # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. adamstark@60: adamstark@60: SORT_MEMBERS_CTORS_1ST = NO adamstark@60: adamstark@60: # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the adamstark@60: # hierarchy of group names into alphabetical order. If set to NO (the default) adamstark@60: # the group names will appear in their defined order. adamstark@60: adamstark@60: SORT_GROUP_NAMES = NO adamstark@60: adamstark@60: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be adamstark@60: # sorted by fully-qualified names, including namespaces. If set to adamstark@60: # NO (the default), the class list will be sorted only by class name, adamstark@60: # not including the namespace part. adamstark@60: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. adamstark@60: # Note: This option applies only to the class list, not to the adamstark@60: # alphabetical list. adamstark@60: adamstark@60: SORT_BY_SCOPE_NAME = NO adamstark@60: adamstark@60: # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to adamstark@60: # do proper type resolution of all parameters of a function it will reject a adamstark@60: # match between the prototype and the implementation of a member function even adamstark@60: # if there is only one candidate or it is obvious which candidate to choose adamstark@60: # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen adamstark@60: # will still accept a match between prototype and implementation in such cases. adamstark@60: adamstark@60: STRICT_PROTO_MATCHING = NO adamstark@60: adamstark@60: # The GENERATE_TODOLIST tag can be used to enable (YES) or adamstark@60: # disable (NO) the todo list. This list is created by putting \todo adamstark@60: # commands in the documentation. adamstark@60: adamstark@60: GENERATE_TODOLIST = YES adamstark@60: adamstark@60: # The GENERATE_TESTLIST tag can be used to enable (YES) or adamstark@60: # disable (NO) the test list. This list is created by putting \test adamstark@60: # commands in the documentation. adamstark@60: adamstark@60: GENERATE_TESTLIST = YES adamstark@60: adamstark@60: # The GENERATE_BUGLIST tag can be used to enable (YES) or adamstark@60: # disable (NO) the bug list. This list is created by putting \bug adamstark@60: # commands in the documentation. adamstark@60: adamstark@60: GENERATE_BUGLIST = YES adamstark@60: adamstark@60: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or adamstark@60: # disable (NO) the deprecated list. This list is created by putting adamstark@60: # \deprecated commands in the documentation. adamstark@60: adamstark@60: GENERATE_DEPRECATEDLIST= YES adamstark@60: adamstark@60: # The ENABLED_SECTIONS tag can be used to enable conditional adamstark@60: # documentation sections, marked by \if sectionname ... \endif. adamstark@60: adamstark@60: ENABLED_SECTIONS = adamstark@60: adamstark@60: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines adamstark@60: # the initial value of a variable or macro consists of for it to appear in adamstark@60: # the documentation. If the initializer consists of more lines than specified adamstark@60: # here it will be hidden. Use a value of 0 to hide initializers completely. adamstark@60: # The appearance of the initializer of individual variables and macros in the adamstark@60: # documentation can be controlled using \showinitializer or \hideinitializer adamstark@60: # command in the documentation regardless of this setting. adamstark@60: adamstark@60: MAX_INITIALIZER_LINES = 30 adamstark@60: adamstark@60: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated adamstark@60: # at the bottom of the documentation of classes and structs. If set to YES the adamstark@60: # list will mention the files that were used to generate the documentation. adamstark@60: adamstark@60: SHOW_USED_FILES = YES adamstark@60: adamstark@60: # Set the SHOW_FILES tag to NO to disable the generation of the Files page. adamstark@60: # This will remove the Files entry from the Quick Index and from the adamstark@60: # Folder Tree View (if specified). The default is YES. adamstark@60: adamstark@60: SHOW_FILES = YES adamstark@60: adamstark@60: # Set the SHOW_NAMESPACES tag to NO to disable the generation of the adamstark@60: # Namespaces page. This will remove the Namespaces entry from the Quick Index adamstark@60: # and from the Folder Tree View (if specified). The default is YES. adamstark@60: adamstark@60: SHOW_NAMESPACES = YES adamstark@60: adamstark@60: # The FILE_VERSION_FILTER tag can be used to specify a program or script that adamstark@60: # doxygen should invoke to get the current version for each file (typically from adamstark@60: # the version control system). Doxygen will invoke the program by executing (via adamstark@60: # popen()) the command , where is the value of adamstark@60: # the FILE_VERSION_FILTER tag, and is the name of an input file adamstark@60: # provided by doxygen. Whatever the program writes to standard output adamstark@60: # is used as the file version. See the manual for examples. adamstark@60: adamstark@60: FILE_VERSION_FILTER = adamstark@60: adamstark@60: # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed adamstark@60: # by doxygen. The layout file controls the global structure of the generated adamstark@60: # output files in an output format independent way. To create the layout file adamstark@60: # that represents doxygen's defaults, run doxygen with the -l option. adamstark@60: # You can optionally specify a file name after the option, if omitted adamstark@60: # DoxygenLayout.xml will be used as the name of the layout file. adamstark@60: adamstark@60: LAYOUT_FILE = adamstark@60: adamstark@60: # The CITE_BIB_FILES tag can be used to specify one or more bib files adamstark@60: # containing the references data. This must be a list of .bib files. The adamstark@60: # .bib extension is automatically appended if omitted. Using this command adamstark@60: # requires the bibtex tool to be installed. See also adamstark@60: # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style adamstark@60: # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this adamstark@60: # feature you need bibtex and perl available in the search path. adamstark@60: adamstark@60: CITE_BIB_FILES = adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to warning and progress messages adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # The QUIET tag can be used to turn on/off the messages that are generated adamstark@60: # by doxygen. Possible values are YES and NO. If left blank NO is used. adamstark@60: adamstark@60: QUIET = NO adamstark@60: adamstark@60: # The WARNINGS tag can be used to turn on/off the warning messages that are adamstark@60: # generated by doxygen. Possible values are YES and NO. If left blank adamstark@60: # NO is used. adamstark@60: adamstark@60: WARNINGS = YES adamstark@60: adamstark@60: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings adamstark@60: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will adamstark@60: # automatically be disabled. adamstark@60: adamstark@60: WARN_IF_UNDOCUMENTED = YES adamstark@60: adamstark@60: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for adamstark@60: # potential errors in the documentation, such as not documenting some adamstark@60: # parameters in a documented function, or documenting parameters that adamstark@60: # don't exist or using markup commands wrongly. adamstark@60: adamstark@60: WARN_IF_DOC_ERROR = YES adamstark@60: adamstark@60: # The WARN_NO_PARAMDOC option can be enabled to get warnings for adamstark@60: # functions that are documented, but have no documentation for their parameters adamstark@60: # or return value. If set to NO (the default) doxygen will only warn about adamstark@60: # wrong or incomplete parameter documentation, but not about the absence of adamstark@60: # documentation. adamstark@60: adamstark@60: WARN_NO_PARAMDOC = NO adamstark@60: adamstark@60: # The WARN_FORMAT tag determines the format of the warning messages that adamstark@60: # doxygen can produce. The string should contain the $file, $line, and $text adamstark@60: # tags, which will be replaced by the file and line number from which the adamstark@60: # warning originated and the warning text. Optionally the format may contain adamstark@60: # $version, which will be replaced by the version of the file (if it could adamstark@60: # be obtained via FILE_VERSION_FILTER) adamstark@60: adamstark@60: WARN_FORMAT = "$file:$line: $text" adamstark@60: adamstark@60: # The WARN_LOGFILE tag can be used to specify a file to which warning adamstark@60: # and error messages should be written. If left blank the output is written adamstark@60: # to stderr. adamstark@60: adamstark@60: WARN_LOGFILE = adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to the input files adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # The INPUT tag can be used to specify the files and/or directories that contain adamstark@60: # documented source files. You may enter file names like "myfile.cpp" or adamstark@60: # directories like "/usr/src/myproject". Separate the files or directories adamstark@60: # with spaces. adamstark@60: adamstark@61: INPUT = src \ adamstark@61: doc adamstark@60: adamstark@60: # This tag can be used to specify the character encoding of the source files adamstark@60: # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is adamstark@60: # also the default input encoding. Doxygen uses libiconv (or the iconv built adamstark@60: # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for adamstark@60: # the list of possible encodings. adamstark@60: adamstark@60: INPUT_ENCODING = UTF-8 adamstark@60: adamstark@60: # If the value of the INPUT tag contains directories, you can use the adamstark@60: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp adamstark@60: # and *.h) to filter out the source-files in the directories. If left adamstark@60: # blank the following patterns are tested: adamstark@60: # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh adamstark@60: # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py adamstark@60: # *.f90 *.f *.for *.vhd *.vhdl adamstark@60: adamstark@60: FILE_PATTERNS = *.c \ adamstark@60: *.cc \ adamstark@60: *.cxx \ adamstark@60: *.cpp \ adamstark@60: *.c++ \ adamstark@60: *.d \ adamstark@60: *.java \ adamstark@60: *.ii \ adamstark@60: *.ixx \ adamstark@60: *.ipp \ adamstark@60: *.i++ \ adamstark@60: *.inl \ adamstark@60: *.h \ adamstark@60: *.hh \ adamstark@60: *.hxx \ adamstark@60: *.hpp \ adamstark@60: *.h++ \ adamstark@60: *.idl \ adamstark@60: *.odl \ adamstark@60: *.cs \ adamstark@60: *.php \ adamstark@60: *.php3 \ adamstark@60: *.inc \ adamstark@60: *.m \ adamstark@60: *.markdown \ adamstark@60: *.md \ adamstark@60: *.mm \ adamstark@60: *.dox \ adamstark@60: *.py \ adamstark@60: *.f90 \ adamstark@60: *.f \ adamstark@60: *.for \ adamstark@60: *.vhd \ adamstark@60: *.vhdl adamstark@60: adamstark@60: # The RECURSIVE tag can be used to turn specify whether or not subdirectories adamstark@60: # should be searched for input files as well. Possible values are YES and NO. adamstark@60: # If left blank NO is used. adamstark@60: adamstark@60: RECURSIVE = NO adamstark@60: adamstark@60: # The EXCLUDE tag can be used to specify files and/or directories that should be adamstark@60: # excluded from the INPUT source files. This way you can easily exclude a adamstark@60: # subdirectory from a directory tree whose root is specified with the INPUT tag. adamstark@60: # Note that relative paths are relative to the directory from which doxygen is adamstark@60: # run. adamstark@60: adamstark@60: EXCLUDE = adamstark@60: adamstark@60: # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or adamstark@60: # directories that are symbolic links (a Unix file system feature) are excluded adamstark@60: # from the input. adamstark@60: adamstark@60: EXCLUDE_SYMLINKS = NO adamstark@60: adamstark@60: # If the value of the INPUT tag contains directories, you can use the adamstark@60: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude adamstark@60: # certain files from those directories. Note that the wildcards are matched adamstark@60: # against the file with absolute path, so to exclude all test directories adamstark@60: # for example use the pattern */test/* adamstark@60: adamstark@60: EXCLUDE_PATTERNS = adamstark@60: adamstark@60: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names adamstark@60: # (namespaces, classes, functions, etc.) that should be excluded from the adamstark@60: # output. The symbol name can be a fully qualified name, a word, or if the adamstark@60: # wildcard * is used, a substring. Examples: ANamespace, AClass, adamstark@60: # AClass::ANamespace, ANamespace::*Test adamstark@60: adamstark@60: EXCLUDE_SYMBOLS = adamstark@60: adamstark@60: # The EXAMPLE_PATH tag can be used to specify one or more files or adamstark@60: # directories that contain example code fragments that are included (see adamstark@60: # the \include command). adamstark@60: adamstark@60: EXAMPLE_PATH = adamstark@60: adamstark@60: # If the value of the EXAMPLE_PATH tag contains directories, you can use the adamstark@60: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp adamstark@60: # and *.h) to filter out the source-files in the directories. If left adamstark@60: # blank all files are included. adamstark@60: adamstark@60: EXAMPLE_PATTERNS = * adamstark@60: adamstark@60: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be adamstark@60: # searched for input files to be used with the \include or \dontinclude adamstark@60: # commands irrespective of the value of the RECURSIVE tag. adamstark@60: # Possible values are YES and NO. If left blank NO is used. adamstark@60: adamstark@60: EXAMPLE_RECURSIVE = NO adamstark@60: adamstark@60: # The IMAGE_PATH tag can be used to specify one or more files or adamstark@60: # directories that contain image that are included in the documentation (see adamstark@60: # the \image command). adamstark@60: adamstark@60: IMAGE_PATH = adamstark@60: adamstark@60: # The INPUT_FILTER tag can be used to specify a program that doxygen should adamstark@60: # invoke to filter for each input file. Doxygen will invoke the filter program adamstark@60: # by executing (via popen()) the command , where adamstark@60: # is the value of the INPUT_FILTER tag, and is the name of an adamstark@60: # input file. Doxygen will then use the output that the filter program writes adamstark@60: # to standard output. If FILTER_PATTERNS is specified, this tag will be adamstark@60: # ignored. adamstark@60: adamstark@60: INPUT_FILTER = adamstark@60: adamstark@60: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern adamstark@60: # basis. Doxygen will compare the file name with each pattern and apply the adamstark@60: # filter if there is a match. The filters are a list of the form: adamstark@60: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further adamstark@60: # info on how filters are used. If FILTER_PATTERNS is empty or if adamstark@60: # non of the patterns match the file name, INPUT_FILTER is applied. adamstark@60: adamstark@60: FILTER_PATTERNS = adamstark@60: adamstark@60: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using adamstark@60: # INPUT_FILTER) will be used to filter the input files when producing source adamstark@60: # files to browse (i.e. when SOURCE_BROWSER is set to YES). adamstark@60: adamstark@60: FILTER_SOURCE_FILES = NO adamstark@60: adamstark@60: # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file adamstark@60: # pattern. A pattern will override the setting for FILTER_PATTERN (if any) adamstark@60: # and it is also possible to disable source filtering for a specific pattern adamstark@60: # using *.ext= (so without naming a filter). This option only has effect when adamstark@60: # FILTER_SOURCE_FILES is enabled. adamstark@60: adamstark@60: FILTER_SOURCE_PATTERNS = adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to source browsing adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the SOURCE_BROWSER tag is set to YES then a list of source files will adamstark@60: # be generated. Documented entities will be cross-referenced with these sources. adamstark@60: # Note: To get rid of all source code in the generated output, make sure also adamstark@60: # VERBATIM_HEADERS is set to NO. adamstark@60: adamstark@60: SOURCE_BROWSER = NO adamstark@60: adamstark@60: # Setting the INLINE_SOURCES tag to YES will include the body adamstark@60: # of functions and classes directly in the documentation. adamstark@60: adamstark@60: INLINE_SOURCES = NO adamstark@60: adamstark@60: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct adamstark@60: # doxygen to hide any special comment blocks from generated source code adamstark@60: # fragments. Normal C, C++ and Fortran comments will always remain visible. adamstark@60: adamstark@60: STRIP_CODE_COMMENTS = YES adamstark@60: adamstark@60: # If the REFERENCED_BY_RELATION tag is set to YES adamstark@60: # then for each documented function all documented adamstark@60: # functions referencing it will be listed. adamstark@60: adamstark@60: REFERENCED_BY_RELATION = NO adamstark@60: adamstark@60: # If the REFERENCES_RELATION tag is set to YES adamstark@60: # then for each documented function all documented entities adamstark@60: # called/used by that function will be listed. adamstark@60: adamstark@60: REFERENCES_RELATION = NO adamstark@60: adamstark@60: # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) adamstark@60: # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from adamstark@60: # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will adamstark@60: # link to the source code. Otherwise they will link to the documentation. adamstark@60: adamstark@60: REFERENCES_LINK_SOURCE = YES adamstark@60: adamstark@60: # If the USE_HTAGS tag is set to YES then the references to source code adamstark@60: # will point to the HTML generated by the htags(1) tool instead of doxygen adamstark@60: # built-in source browser. The htags tool is part of GNU's global source adamstark@60: # tagging system (see http://www.gnu.org/software/global/global.html). You adamstark@60: # will need version 4.8.6 or higher. adamstark@60: adamstark@60: USE_HTAGS = NO adamstark@60: adamstark@60: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen adamstark@60: # will generate a verbatim copy of the header file for each class for adamstark@60: # which an include is specified. Set to NO to disable this. adamstark@60: adamstark@60: VERBATIM_HEADERS = YES adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to the alphabetical class index adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index adamstark@60: # of all compounds will be generated. Enable this if the project adamstark@60: # contains a lot of classes, structs, unions or interfaces. adamstark@60: adamstark@60: ALPHABETICAL_INDEX = YES adamstark@60: adamstark@60: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then adamstark@60: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns adamstark@60: # in which this list will be split (can be a number in the range [1..20]) adamstark@60: adamstark@60: COLS_IN_ALPHA_INDEX = 5 adamstark@60: adamstark@60: # In case all classes in a project start with a common prefix, all adamstark@60: # classes will be put under the same header in the alphabetical index. adamstark@60: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that adamstark@60: # should be ignored while generating the index headers. adamstark@60: adamstark@60: IGNORE_PREFIX = adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to the HTML output adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will adamstark@60: # generate HTML output. adamstark@60: adamstark@60: GENERATE_HTML = YES adamstark@60: adamstark@60: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. adamstark@60: # If a relative path is entered the value of OUTPUT_DIRECTORY will be adamstark@60: # put in front of it. If left blank `html' will be used as the default path. adamstark@60: adamstark@60: HTML_OUTPUT = html adamstark@60: adamstark@60: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for adamstark@60: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank adamstark@60: # doxygen will generate files with .html extension. adamstark@60: adamstark@60: HTML_FILE_EXTENSION = .html adamstark@60: adamstark@60: # The HTML_HEADER tag can be used to specify a personal HTML header for adamstark@60: # each generated HTML page. If it is left blank doxygen will generate a adamstark@60: # standard header. Note that when using a custom header you are responsible adamstark@60: # for the proper inclusion of any scripts and style sheets that doxygen adamstark@60: # needs, which is dependent on the configuration options used. adamstark@60: # It is advised to generate a default header using "doxygen -w html adamstark@60: # header.html footer.html stylesheet.css YourConfigFile" and then modify adamstark@60: # that header. Note that the header is subject to change so you typically adamstark@60: # have to redo this when upgrading to a newer version of doxygen or when adamstark@60: # changing the value of configuration settings such as GENERATE_TREEVIEW! adamstark@60: adamstark@60: HTML_HEADER = adamstark@60: adamstark@60: # The HTML_FOOTER tag can be used to specify a personal HTML footer for adamstark@60: # each generated HTML page. If it is left blank doxygen will generate a adamstark@60: # standard footer. adamstark@60: adamstark@60: HTML_FOOTER = adamstark@60: adamstark@60: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading adamstark@60: # style sheet that is used by each HTML page. It can be used to adamstark@60: # fine-tune the look of the HTML output. If left blank doxygen will adamstark@60: # generate a default style sheet. Note that it is recommended to use adamstark@60: # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this adamstark@60: # tag will in the future become obsolete. adamstark@60: adamstark@60: HTML_STYLESHEET = adamstark@60: adamstark@60: # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional adamstark@60: # user-defined cascading style sheet that is included after the standard adamstark@60: # style sheets created by doxygen. Using this option one can overrule adamstark@60: # certain style aspects. This is preferred over using HTML_STYLESHEET adamstark@60: # since it does not replace the standard style sheet and is therefor more adamstark@60: # robust against future updates. Doxygen will copy the style sheet file to adamstark@60: # the output directory. adamstark@60: adamstark@60: HTML_EXTRA_STYLESHEET = adamstark@60: adamstark@60: # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or adamstark@60: # other source files which should be copied to the HTML output directory. Note adamstark@60: # that these files will be copied to the base HTML output directory. Use the adamstark@60: # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these adamstark@60: # files. In the HTML_STYLESHEET file, use the file name only. Also note that adamstark@60: # the files will be copied as-is; there are no commands or markers available. adamstark@60: adamstark@60: HTML_EXTRA_FILES = adamstark@60: adamstark@60: # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. adamstark@60: # Doxygen will adjust the colors in the style sheet and background images adamstark@60: # according to this color. Hue is specified as an angle on a colorwheel, adamstark@60: # see http://en.wikipedia.org/wiki/Hue for more information. adamstark@60: # For instance the value 0 represents red, 60 is yellow, 120 is green, adamstark@60: # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. adamstark@60: # The allowed range is 0 to 359. adamstark@60: adamstark@60: HTML_COLORSTYLE_HUE = 220 adamstark@60: adamstark@60: # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of adamstark@60: # the colors in the HTML output. For a value of 0 the output will use adamstark@60: # grayscales only. A value of 255 will produce the most vivid colors. adamstark@60: adamstark@60: HTML_COLORSTYLE_SAT = 100 adamstark@60: adamstark@60: # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to adamstark@60: # the luminance component of the colors in the HTML output. Values below adamstark@60: # 100 gradually make the output lighter, whereas values above 100 make adamstark@60: # the output darker. The value divided by 100 is the actual gamma applied, adamstark@60: # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, adamstark@60: # and 100 does not change the gamma. adamstark@60: adamstark@60: HTML_COLORSTYLE_GAMMA = 80 adamstark@60: adamstark@60: # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML adamstark@60: # page will contain the date and time when the page was generated. Setting adamstark@60: # this to NO can help when comparing the output of multiple runs. adamstark@60: adamstark@60: HTML_TIMESTAMP = YES adamstark@60: adamstark@60: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML adamstark@60: # documentation will contain sections that can be hidden and shown after the adamstark@60: # page has loaded. adamstark@60: adamstark@60: HTML_DYNAMIC_SECTIONS = NO adamstark@60: adamstark@60: # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of adamstark@60: # entries shown in the various tree structured indices initially; the user adamstark@60: # can expand and collapse entries dynamically later on. Doxygen will expand adamstark@60: # the tree to such a level that at most the specified number of entries are adamstark@60: # visible (unless a fully collapsed tree already exceeds this amount). adamstark@60: # So setting the number of entries 1 will produce a full collapsed tree by adamstark@60: # default. 0 is a special value representing an infinite number of entries adamstark@60: # and will result in a full expanded tree by default. adamstark@60: adamstark@60: HTML_INDEX_NUM_ENTRIES = 100 adamstark@60: adamstark@60: # If the GENERATE_DOCSET tag is set to YES, additional index files adamstark@60: # will be generated that can be used as input for Apple's Xcode 3 adamstark@60: # integrated development environment, introduced with OSX 10.5 (Leopard). adamstark@60: # To create a documentation set, doxygen will generate a Makefile in the adamstark@60: # HTML output directory. Running make will produce the docset in that adamstark@60: # directory and running "make install" will install the docset in adamstark@60: # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find adamstark@60: # it at startup. adamstark@60: # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html adamstark@60: # for more information. adamstark@60: adamstark@60: GENERATE_DOCSET = NO adamstark@60: adamstark@60: # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the adamstark@60: # feed. A documentation feed provides an umbrella under which multiple adamstark@60: # documentation sets from a single provider (such as a company or product suite) adamstark@60: # can be grouped. adamstark@60: adamstark@60: DOCSET_FEEDNAME = "Doxygen generated docs" adamstark@60: adamstark@60: # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that adamstark@60: # should uniquely identify the documentation set bundle. This should be a adamstark@60: # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen adamstark@60: # will append .docset to the name. adamstark@60: adamstark@60: DOCSET_BUNDLE_ID = org.doxygen.Project adamstark@60: adamstark@60: # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely adamstark@60: # identify the documentation publisher. This should be a reverse domain-name adamstark@60: # style string, e.g. com.mycompany.MyDocSet.documentation. adamstark@60: adamstark@60: DOCSET_PUBLISHER_ID = org.doxygen.Publisher adamstark@60: adamstark@60: # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. adamstark@60: adamstark@60: DOCSET_PUBLISHER_NAME = Publisher adamstark@60: adamstark@60: # If the GENERATE_HTMLHELP tag is set to YES, additional index files adamstark@60: # will be generated that can be used as input for tools like the adamstark@60: # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) adamstark@60: # of the generated HTML documentation. adamstark@60: adamstark@60: GENERATE_HTMLHELP = NO adamstark@60: adamstark@60: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can adamstark@60: # be used to specify the file name of the resulting .chm file. You adamstark@60: # can add a path in front of the file if the result should not be adamstark@60: # written to the html output directory. adamstark@60: adamstark@60: CHM_FILE = adamstark@60: adamstark@60: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can adamstark@60: # be used to specify the location (absolute path including file name) of adamstark@60: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run adamstark@60: # the HTML help compiler on the generated index.hhp. adamstark@60: adamstark@60: HHC_LOCATION = adamstark@60: adamstark@60: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag adamstark@60: # controls if a separate .chi index file is generated (YES) or that adamstark@60: # it should be included in the master .chm file (NO). adamstark@60: adamstark@60: GENERATE_CHI = NO adamstark@60: adamstark@60: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING adamstark@60: # is used to encode HtmlHelp index (hhk), content (hhc) and project file adamstark@60: # content. adamstark@60: adamstark@60: CHM_INDEX_ENCODING = adamstark@60: adamstark@60: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag adamstark@60: # controls whether a binary table of contents is generated (YES) or a adamstark@60: # normal table of contents (NO) in the .chm file. adamstark@60: adamstark@60: BINARY_TOC = NO adamstark@60: adamstark@60: # The TOC_EXPAND flag can be set to YES to add extra items for group members adamstark@60: # to the contents of the HTML help documentation and to the tree view. adamstark@60: adamstark@60: TOC_EXPAND = NO adamstark@60: adamstark@60: # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and adamstark@60: # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated adamstark@60: # that can be used as input for Qt's qhelpgenerator to generate a adamstark@60: # Qt Compressed Help (.qch) of the generated HTML documentation. adamstark@60: adamstark@60: GENERATE_QHP = NO adamstark@60: adamstark@60: # If the QHG_LOCATION tag is specified, the QCH_FILE tag can adamstark@60: # be used to specify the file name of the resulting .qch file. adamstark@60: # The path specified is relative to the HTML output folder. adamstark@60: adamstark@60: QCH_FILE = adamstark@60: adamstark@60: # The QHP_NAMESPACE tag specifies the namespace to use when generating adamstark@60: # Qt Help Project output. For more information please see adamstark@60: # http://doc.trolltech.com/qthelpproject.html#namespace adamstark@60: adamstark@60: QHP_NAMESPACE = org.doxygen.Project adamstark@60: adamstark@60: # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating adamstark@60: # Qt Help Project output. For more information please see adamstark@60: # http://doc.trolltech.com/qthelpproject.html#virtual-folders adamstark@60: adamstark@60: QHP_VIRTUAL_FOLDER = doc adamstark@60: adamstark@60: # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to adamstark@60: # add. For more information please see adamstark@60: # http://doc.trolltech.com/qthelpproject.html#custom-filters adamstark@60: adamstark@60: QHP_CUST_FILTER_NAME = adamstark@60: adamstark@60: # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the adamstark@60: # custom filter to add. For more information please see adamstark@60: # adamstark@60: # Qt Help Project / Custom Filters. adamstark@60: adamstark@60: QHP_CUST_FILTER_ATTRS = adamstark@60: adamstark@60: # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this adamstark@60: # project's adamstark@60: # filter section matches. adamstark@60: # adamstark@60: # Qt Help Project / Filter Attributes. adamstark@60: adamstark@60: QHP_SECT_FILTER_ATTRS = adamstark@60: adamstark@60: # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can adamstark@60: # be used to specify the location of Qt's qhelpgenerator. adamstark@60: # If non-empty doxygen will try to run qhelpgenerator on the generated adamstark@60: # .qhp file. adamstark@60: adamstark@60: QHG_LOCATION = adamstark@60: adamstark@60: # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files adamstark@60: # will be generated, which together with the HTML files, form an Eclipse help adamstark@60: # plugin. To install this plugin and make it available under the help contents adamstark@60: # menu in Eclipse, the contents of the directory containing the HTML and XML adamstark@60: # files needs to be copied into the plugins directory of eclipse. The name of adamstark@60: # the directory within the plugins directory should be the same as adamstark@60: # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before adamstark@60: # the help appears. adamstark@60: adamstark@60: GENERATE_ECLIPSEHELP = NO adamstark@60: adamstark@60: # A unique identifier for the eclipse help plugin. When installing the plugin adamstark@60: # the directory name containing the HTML and XML files should also have adamstark@60: # this name. adamstark@60: adamstark@60: ECLIPSE_DOC_ID = org.doxygen.Project adamstark@60: adamstark@60: # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) adamstark@60: # at top of each HTML page. The value NO (the default) enables the index and adamstark@60: # the value YES disables it. Since the tabs have the same information as the adamstark@60: # navigation tree you can set this option to NO if you already set adamstark@60: # GENERATE_TREEVIEW to YES. adamstark@60: adamstark@60: DISABLE_INDEX = NO adamstark@60: adamstark@60: # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index adamstark@60: # structure should be generated to display hierarchical information. adamstark@60: # If the tag value is set to YES, a side panel will be generated adamstark@60: # containing a tree-like index structure (just like the one that adamstark@60: # is generated for HTML Help). For this to work a browser that supports adamstark@60: # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). adamstark@60: # Windows users are probably better off using the HTML help feature. adamstark@60: # Since the tree basically has the same information as the tab index you adamstark@60: # could consider to set DISABLE_INDEX to NO when enabling this option. adamstark@60: adamstark@60: GENERATE_TREEVIEW = NO adamstark@60: adamstark@60: # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values adamstark@60: # (range [0,1..20]) that doxygen will group on one line in the generated HTML adamstark@60: # documentation. Note that a value of 0 will completely suppress the enum adamstark@60: # values from appearing in the overview section. adamstark@60: adamstark@60: ENUM_VALUES_PER_LINE = 4 adamstark@60: adamstark@60: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be adamstark@60: # used to set the initial width (in pixels) of the frame in which the tree adamstark@60: # is shown. adamstark@60: adamstark@60: TREEVIEW_WIDTH = 250 adamstark@60: adamstark@60: # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open adamstark@60: # links to external symbols imported via tag files in a separate window. adamstark@60: adamstark@60: EXT_LINKS_IN_WINDOW = NO adamstark@60: adamstark@60: # Use this tag to change the font size of Latex formulas included adamstark@60: # as images in the HTML documentation. The default is 10. Note that adamstark@60: # when you change the font size after a successful doxygen run you need adamstark@60: # to manually remove any form_*.png images from the HTML output directory adamstark@60: # to force them to be regenerated. adamstark@60: adamstark@60: FORMULA_FONTSIZE = 10 adamstark@60: adamstark@60: # Use the FORMULA_TRANPARENT tag to determine whether or not the images adamstark@60: # generated for formulas are transparent PNGs. Transparent PNGs are adamstark@60: # not supported properly for IE 6.0, but are supported on all modern browsers. adamstark@60: # Note that when changing this option you need to delete any form_*.png files adamstark@60: # in the HTML output before the changes have effect. adamstark@60: adamstark@60: FORMULA_TRANSPARENT = YES adamstark@60: adamstark@60: # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax adamstark@60: # (see http://www.mathjax.org) which uses client side Javascript for the adamstark@60: # rendering instead of using prerendered bitmaps. Use this if you do not adamstark@60: # have LaTeX installed or if you want to formulas look prettier in the HTML adamstark@60: # output. When enabled you may also need to install MathJax separately and adamstark@60: # configure the path to it using the MATHJAX_RELPATH option. adamstark@60: adamstark@60: USE_MATHJAX = NO adamstark@60: adamstark@60: # When MathJax is enabled you need to specify the location relative to the adamstark@60: # HTML output directory using the MATHJAX_RELPATH option. The destination adamstark@60: # directory should contain the MathJax.js script. For instance, if the mathjax adamstark@60: # directory is located at the same level as the HTML output directory, then adamstark@60: # MATHJAX_RELPATH should be ../mathjax. The default value points to adamstark@60: # the MathJax Content Delivery Network so you can quickly see the result without adamstark@60: # installing MathJax. However, it is strongly recommended to install a local adamstark@60: # copy of MathJax from http://www.mathjax.org before deployment. adamstark@60: adamstark@60: MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest adamstark@60: adamstark@60: # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension adamstark@60: # names that should be enabled during MathJax rendering. adamstark@60: adamstark@60: MATHJAX_EXTENSIONS = adamstark@60: adamstark@60: # When the SEARCHENGINE tag is enabled doxygen will generate a search box adamstark@60: # for the HTML output. The underlying search engine uses javascript adamstark@60: # and DHTML and should work on any modern browser. Note that when using adamstark@60: # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets adamstark@60: # (GENERATE_DOCSET) there is already a search function so this one should adamstark@60: # typically be disabled. For large projects the javascript based search engine adamstark@60: # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. adamstark@60: adamstark@60: SEARCHENGINE = YES adamstark@60: adamstark@60: # When the SERVER_BASED_SEARCH tag is enabled the search engine will be adamstark@60: # implemented using a PHP enabled web server instead of at the web client adamstark@60: # using Javascript. Doxygen will generate the search PHP script and index adamstark@60: # file to put on the web server. The advantage of the server adamstark@60: # based approach is that it scales better to large projects and allows adamstark@60: # full text search. The disadvantages are that it is more difficult to setup adamstark@60: # and does not have live searching capabilities. adamstark@60: adamstark@60: SERVER_BASED_SEARCH = NO adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to the LaTeX output adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will adamstark@60: # generate Latex output. adamstark@60: adamstark@60: GENERATE_LATEX = NO adamstark@60: adamstark@60: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. adamstark@60: # If a relative path is entered the value of OUTPUT_DIRECTORY will be adamstark@60: # put in front of it. If left blank `latex' will be used as the default path. adamstark@60: adamstark@60: LATEX_OUTPUT = latex adamstark@60: adamstark@60: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be adamstark@60: # invoked. If left blank `latex' will be used as the default command name. adamstark@60: # Note that when enabling USE_PDFLATEX this option is only used for adamstark@60: # generating bitmaps for formulas in the HTML output, but not in the adamstark@60: # Makefile that is written to the output directory. adamstark@60: adamstark@60: LATEX_CMD_NAME = latex adamstark@60: adamstark@60: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to adamstark@60: # generate index for LaTeX. If left blank `makeindex' will be used as the adamstark@60: # default command name. adamstark@60: adamstark@60: MAKEINDEX_CMD_NAME = makeindex adamstark@60: adamstark@60: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact adamstark@60: # LaTeX documents. This may be useful for small projects and may help to adamstark@60: # save some trees in general. adamstark@60: adamstark@60: COMPACT_LATEX = NO adamstark@60: adamstark@60: # The PAPER_TYPE tag can be used to set the paper type that is used adamstark@60: # by the printer. Possible values are: a4, letter, legal and adamstark@60: # executive. If left blank a4wide will be used. adamstark@60: adamstark@60: PAPER_TYPE = a4 adamstark@60: adamstark@60: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX adamstark@60: # packages that should be included in the LaTeX output. adamstark@60: adamstark@60: EXTRA_PACKAGES = adamstark@60: adamstark@60: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for adamstark@60: # the generated latex document. The header should contain everything until adamstark@60: # the first chapter. If it is left blank doxygen will generate a adamstark@60: # standard header. Notice: only use this tag if you know what you are doing! adamstark@60: adamstark@60: LATEX_HEADER = adamstark@60: adamstark@60: # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for adamstark@60: # the generated latex document. The footer should contain everything after adamstark@60: # the last chapter. If it is left blank doxygen will generate a adamstark@60: # standard footer. Notice: only use this tag if you know what you are doing! adamstark@60: adamstark@60: LATEX_FOOTER = adamstark@60: adamstark@60: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated adamstark@60: # is prepared for conversion to pdf (using ps2pdf). The pdf file will adamstark@60: # contain links (just like the HTML output) instead of page references adamstark@60: # This makes the output suitable for online browsing using a pdf viewer. adamstark@60: adamstark@60: PDF_HYPERLINKS = YES adamstark@60: adamstark@60: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of adamstark@60: # plain latex in the generated Makefile. Set this option to YES to get a adamstark@60: # higher quality PDF documentation. adamstark@60: adamstark@60: USE_PDFLATEX = YES adamstark@60: adamstark@60: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. adamstark@60: # command to the generated LaTeX files. This will instruct LaTeX to keep adamstark@60: # running if errors occur, instead of asking the user for help. adamstark@60: # This option is also used when generating formulas in HTML. adamstark@60: adamstark@60: LATEX_BATCHMODE = NO adamstark@60: adamstark@60: # If LATEX_HIDE_INDICES is set to YES then doxygen will not adamstark@60: # include the index chapters (such as File Index, Compound Index, etc.) adamstark@60: # in the output. adamstark@60: adamstark@60: LATEX_HIDE_INDICES = NO adamstark@60: adamstark@60: # If LATEX_SOURCE_CODE is set to YES then doxygen will include adamstark@60: # source code with syntax highlighting in the LaTeX output. adamstark@60: # Note that which sources are shown also depends on other settings adamstark@60: # such as SOURCE_BROWSER. adamstark@60: adamstark@60: LATEX_SOURCE_CODE = NO adamstark@60: adamstark@60: # The LATEX_BIB_STYLE tag can be used to specify the style to use for the adamstark@60: # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See adamstark@60: # http://en.wikipedia.org/wiki/BibTeX for more info. adamstark@60: adamstark@60: LATEX_BIB_STYLE = plain adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to the RTF output adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output adamstark@60: # The RTF output is optimized for Word 97 and may not look very pretty with adamstark@60: # other RTF readers or editors. adamstark@60: adamstark@60: GENERATE_RTF = NO adamstark@60: adamstark@60: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. adamstark@60: # If a relative path is entered the value of OUTPUT_DIRECTORY will be adamstark@60: # put in front of it. If left blank `rtf' will be used as the default path. adamstark@60: adamstark@60: RTF_OUTPUT = rtf adamstark@60: adamstark@60: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact adamstark@60: # RTF documents. This may be useful for small projects and may help to adamstark@60: # save some trees in general. adamstark@60: adamstark@60: COMPACT_RTF = NO adamstark@60: adamstark@60: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated adamstark@60: # will contain hyperlink fields. The RTF file will adamstark@60: # contain links (just like the HTML output) instead of page references. adamstark@60: # This makes the output suitable for online browsing using WORD or other adamstark@60: # programs which support those fields. adamstark@60: # Note: wordpad (write) and others do not support links. adamstark@60: adamstark@60: RTF_HYPERLINKS = NO adamstark@60: adamstark@60: # Load style sheet definitions from file. Syntax is similar to doxygen's adamstark@60: # config file, i.e. a series of assignments. You only have to provide adamstark@60: # replacements, missing definitions are set to their default value. adamstark@60: adamstark@60: RTF_STYLESHEET_FILE = adamstark@60: adamstark@60: # Set optional variables used in the generation of an rtf document. adamstark@60: # Syntax is similar to doxygen's config file. adamstark@60: adamstark@60: RTF_EXTENSIONS_FILE = adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to the man page output adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will adamstark@60: # generate man pages adamstark@60: adamstark@60: GENERATE_MAN = NO adamstark@60: adamstark@60: # The MAN_OUTPUT tag is used to specify where the man pages will be put. adamstark@60: # If a relative path is entered the value of OUTPUT_DIRECTORY will be adamstark@60: # put in front of it. If left blank `man' will be used as the default path. adamstark@60: adamstark@60: MAN_OUTPUT = man adamstark@60: adamstark@60: # The MAN_EXTENSION tag determines the extension that is added to adamstark@60: # the generated man pages (default is the subroutine's section .3) adamstark@60: adamstark@60: MAN_EXTENSION = .3 adamstark@60: adamstark@60: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, adamstark@60: # then it will generate one additional man file for each entity adamstark@60: # documented in the real man page(s). These additional files adamstark@60: # only source the real man page, but without them the man command adamstark@60: # would be unable to find the correct page. The default is NO. adamstark@60: adamstark@60: MAN_LINKS = NO adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to the XML output adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the GENERATE_XML tag is set to YES Doxygen will adamstark@60: # generate an XML file that captures the structure of adamstark@60: # the code including all documentation. adamstark@60: adamstark@60: GENERATE_XML = NO adamstark@60: adamstark@60: # The XML_OUTPUT tag is used to specify where the XML pages will be put. adamstark@60: # If a relative path is entered the value of OUTPUT_DIRECTORY will be adamstark@60: # put in front of it. If left blank `xml' will be used as the default path. adamstark@60: adamstark@60: XML_OUTPUT = xml adamstark@60: adamstark@60: # The XML_SCHEMA tag can be used to specify an XML schema, adamstark@60: # which can be used by a validating XML parser to check the adamstark@60: # syntax of the XML files. adamstark@60: adamstark@60: XML_SCHEMA = adamstark@60: adamstark@60: # The XML_DTD tag can be used to specify an XML DTD, adamstark@60: # which can be used by a validating XML parser to check the adamstark@60: # syntax of the XML files. adamstark@60: adamstark@60: XML_DTD = adamstark@60: adamstark@60: # If the XML_PROGRAMLISTING tag is set to YES Doxygen will adamstark@60: # dump the program listings (including syntax highlighting adamstark@60: # and cross-referencing information) to the XML output. Note that adamstark@60: # enabling this will significantly increase the size of the XML output. adamstark@60: adamstark@60: XML_PROGRAMLISTING = YES adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options for the AutoGen Definitions output adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will adamstark@60: # generate an AutoGen Definitions (see autogen.sf.net) file adamstark@60: # that captures the structure of the code including all adamstark@60: # documentation. Note that this feature is still experimental adamstark@60: # and incomplete at the moment. adamstark@60: adamstark@60: GENERATE_AUTOGEN_DEF = NO adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # configuration options related to the Perl module output adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the GENERATE_PERLMOD tag is set to YES Doxygen will adamstark@60: # generate a Perl module file that captures the structure of adamstark@60: # the code including all documentation. Note that this adamstark@60: # feature is still experimental and incomplete at the adamstark@60: # moment. adamstark@60: adamstark@60: GENERATE_PERLMOD = NO adamstark@60: adamstark@60: # If the PERLMOD_LATEX tag is set to YES Doxygen will generate adamstark@60: # the necessary Makefile rules, Perl scripts and LaTeX code to be able adamstark@60: # to generate PDF and DVI output from the Perl module output. adamstark@60: adamstark@60: PERLMOD_LATEX = NO adamstark@60: adamstark@60: # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be adamstark@60: # nicely formatted so it can be parsed by a human reader. This is useful adamstark@60: # if you want to understand what is going on. On the other hand, if this adamstark@60: # tag is set to NO the size of the Perl module output will be much smaller adamstark@60: # and Perl will parse it just the same. adamstark@60: adamstark@60: PERLMOD_PRETTY = YES adamstark@60: adamstark@60: # The names of the make variables in the generated doxyrules.make file adamstark@60: # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. adamstark@60: # This is useful so different doxyrules.make files included by the same adamstark@60: # Makefile don't overwrite each other's variables. adamstark@60: adamstark@60: PERLMOD_MAKEVAR_PREFIX = adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # Configuration options related to the preprocessor adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will adamstark@60: # evaluate all C-preprocessor directives found in the sources and include adamstark@60: # files. adamstark@60: adamstark@60: ENABLE_PREPROCESSING = YES adamstark@60: adamstark@60: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro adamstark@60: # names in the source code. If set to NO (the default) only conditional adamstark@60: # compilation will be performed. Macro expansion can be done in a controlled adamstark@60: # way by setting EXPAND_ONLY_PREDEF to YES. adamstark@60: adamstark@60: MACRO_EXPANSION = NO adamstark@60: adamstark@60: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES adamstark@60: # then the macro expansion is limited to the macros specified with the adamstark@60: # PREDEFINED and EXPAND_AS_DEFINED tags. adamstark@60: adamstark@60: EXPAND_ONLY_PREDEF = NO adamstark@60: adamstark@60: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files adamstark@60: # pointed to by INCLUDE_PATH will be searched when a #include is found. adamstark@60: adamstark@60: SEARCH_INCLUDES = YES adamstark@60: adamstark@60: # The INCLUDE_PATH tag can be used to specify one or more directories that adamstark@60: # contain include files that are not input files but should be processed by adamstark@60: # the preprocessor. adamstark@60: adamstark@60: INCLUDE_PATH = adamstark@60: adamstark@60: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard adamstark@60: # patterns (like *.h and *.hpp) to filter out the header-files in the adamstark@60: # directories. If left blank, the patterns specified with FILE_PATTERNS will adamstark@60: # be used. adamstark@60: adamstark@60: INCLUDE_FILE_PATTERNS = adamstark@60: adamstark@60: # The PREDEFINED tag can be used to specify one or more macro names that adamstark@60: # are defined before the preprocessor is started (similar to the -D option of adamstark@60: # gcc). The argument of the tag is a list of macros of the form: name adamstark@60: # or name=definition (no spaces). If the definition and the = are adamstark@60: # omitted =1 is assumed. To prevent a macro definition from being adamstark@60: # undefined via #undef or recursively expanded use the := operator adamstark@60: # instead of the = operator. adamstark@60: adamstark@60: PREDEFINED = adamstark@60: adamstark@60: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then adamstark@60: # this tag can be used to specify a list of macro names that should be expanded. adamstark@60: # The macro definition that is found in the sources will be used. adamstark@60: # Use the PREDEFINED tag if you want to use a different macro definition that adamstark@60: # overrules the definition found in the source code. adamstark@60: adamstark@60: EXPAND_AS_DEFINED = adamstark@60: adamstark@60: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then adamstark@60: # doxygen's preprocessor will remove all references to function-like macros adamstark@60: # that are alone on a line, have an all uppercase name, and do not end with a adamstark@60: # semicolon, because these will confuse the parser if not removed. adamstark@60: adamstark@60: SKIP_FUNCTION_MACROS = YES adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # Configuration::additions related to external references adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # The TAGFILES option can be used to specify one or more tagfiles. For each adamstark@60: # tag file the location of the external documentation should be added. The adamstark@60: # format of a tag file without this location is as follows: adamstark@60: # TAGFILES = file1 file2 ... adamstark@60: # Adding location for the tag files is done as follows: adamstark@60: # TAGFILES = file1=loc1 "file2 = loc2" ... adamstark@60: # where "loc1" and "loc2" can be relative or absolute paths adamstark@60: # or URLs. Note that each tag file must have a unique name (where the name does adamstark@60: # NOT include the path). If a tag file is not located in the directory in which adamstark@60: # doxygen is run, you must also specify the path to the tagfile here. adamstark@60: adamstark@60: TAGFILES = adamstark@60: adamstark@60: # When a file name is specified after GENERATE_TAGFILE, doxygen will create adamstark@60: # a tag file that is based on the input files it reads. adamstark@60: adamstark@60: GENERATE_TAGFILE = adamstark@60: adamstark@60: # If the ALLEXTERNALS tag is set to YES all external classes will be listed adamstark@60: # in the class index. If set to NO only the inherited external classes adamstark@60: # will be listed. adamstark@60: adamstark@60: ALLEXTERNALS = NO adamstark@60: adamstark@60: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed adamstark@60: # in the modules index. If set to NO, only the current project's groups will adamstark@60: # be listed. adamstark@60: adamstark@60: EXTERNAL_GROUPS = YES adamstark@60: adamstark@60: # The PERL_PATH should be the absolute path and name of the perl script adamstark@60: # interpreter (i.e. the result of `which perl'). adamstark@60: adamstark@60: PERL_PATH = /usr/bin/perl adamstark@60: adamstark@60: #--------------------------------------------------------------------------- adamstark@60: # Configuration options related to the dot tool adamstark@60: #--------------------------------------------------------------------------- adamstark@60: adamstark@60: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will adamstark@60: # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base adamstark@60: # or super classes. Setting the tag to NO turns the diagrams off. Note that adamstark@60: # this option also works with HAVE_DOT disabled, but it is recommended to adamstark@60: # install and use dot, since it yields more powerful graphs. adamstark@60: adamstark@60: CLASS_DIAGRAMS = YES adamstark@60: adamstark@60: # You can define message sequence charts within doxygen comments using the \msc adamstark@60: # command. Doxygen will then run the mscgen tool (see adamstark@60: # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the adamstark@60: # documentation. The MSCGEN_PATH tag allows you to specify the directory where adamstark@60: # the mscgen tool resides. If left empty the tool is assumed to be found in the adamstark@60: # default search path. adamstark@60: adamstark@60: MSCGEN_PATH = adamstark@60: adamstark@60: # If set to YES, the inheritance and collaboration graphs will hide adamstark@60: # inheritance and usage relations if the target is undocumented adamstark@60: # or is not a class. adamstark@60: adamstark@60: HIDE_UNDOC_RELATIONS = YES adamstark@60: adamstark@60: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is adamstark@60: # available from the path. This tool is part of Graphviz, a graph visualization adamstark@60: # toolkit from AT&T and Lucent Bell Labs. The other options in this section adamstark@60: # have no effect if this option is set to NO (the default) adamstark@60: adamstark@60: HAVE_DOT = NO adamstark@60: adamstark@60: # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is adamstark@60: # allowed to run in parallel. When set to 0 (the default) doxygen will adamstark@60: # base this on the number of processors available in the system. You can set it adamstark@60: # explicitly to a value larger than 0 to get control over the balance adamstark@60: # between CPU load and processing speed. adamstark@60: adamstark@60: DOT_NUM_THREADS = 0 adamstark@60: adamstark@60: # By default doxygen will use the Helvetica font for all dot files that adamstark@60: # doxygen generates. When you want a differently looking font you can specify adamstark@60: # the font name using DOT_FONTNAME. You need to make sure dot is able to find adamstark@60: # the font, which can be done by putting it in a standard location or by setting adamstark@60: # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the adamstark@60: # directory containing the font. adamstark@60: adamstark@60: DOT_FONTNAME = Helvetica adamstark@60: adamstark@60: # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. adamstark@60: # The default size is 10pt. adamstark@60: adamstark@60: DOT_FONTSIZE = 10 adamstark@60: adamstark@60: # By default doxygen will tell dot to use the Helvetica font. adamstark@60: # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to adamstark@60: # set the path where dot can find it. adamstark@60: adamstark@60: DOT_FONTPATH = adamstark@60: adamstark@60: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen adamstark@60: # will generate a graph for each documented class showing the direct and adamstark@60: # indirect inheritance relations. Setting this tag to YES will force the adamstark@60: # CLASS_DIAGRAMS tag to NO. adamstark@60: adamstark@60: CLASS_GRAPH = YES adamstark@60: adamstark@60: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen adamstark@60: # will generate a graph for each documented class showing the direct and adamstark@60: # indirect implementation dependencies (inheritance, containment, and adamstark@60: # class references variables) of the class with other documented classes. adamstark@60: adamstark@60: COLLABORATION_GRAPH = YES adamstark@60: adamstark@60: # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen adamstark@60: # will generate a graph for groups, showing the direct groups dependencies adamstark@60: adamstark@60: GROUP_GRAPHS = YES adamstark@60: adamstark@60: # If the UML_LOOK tag is set to YES doxygen will generate inheritance and adamstark@60: # collaboration diagrams in a style similar to the OMG's Unified Modeling adamstark@60: # Language. adamstark@60: adamstark@60: UML_LOOK = NO adamstark@60: adamstark@60: # If the UML_LOOK tag is enabled, the fields and methods are shown inside adamstark@60: # the class node. If there are many fields or methods and many nodes the adamstark@60: # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS adamstark@60: # threshold limits the number of items for each type to make the size more adamstark@60: # managable. Set this to 0 for no limit. Note that the threshold may be adamstark@60: # exceeded by 50% before the limit is enforced. adamstark@60: adamstark@60: UML_LIMIT_NUM_FIELDS = 10 adamstark@60: adamstark@60: # If set to YES, the inheritance and collaboration graphs will show the adamstark@60: # relations between templates and their instances. adamstark@60: adamstark@60: TEMPLATE_RELATIONS = NO adamstark@60: adamstark@60: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT adamstark@60: # tags are set to YES then doxygen will generate a graph for each documented adamstark@60: # file showing the direct and indirect include dependencies of the file with adamstark@60: # other documented files. adamstark@60: adamstark@60: INCLUDE_GRAPH = YES adamstark@60: adamstark@60: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and adamstark@60: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each adamstark@60: # documented header file showing the documented files that directly or adamstark@60: # indirectly include this file. adamstark@60: adamstark@60: INCLUDED_BY_GRAPH = YES adamstark@60: adamstark@60: # If the CALL_GRAPH and HAVE_DOT options are set to YES then adamstark@60: # doxygen will generate a call dependency graph for every global function adamstark@60: # or class method. Note that enabling this option will significantly increase adamstark@60: # the time of a run. So in most cases it will be better to enable call graphs adamstark@60: # for selected functions only using the \callgraph command. adamstark@60: adamstark@60: CALL_GRAPH = NO adamstark@60: adamstark@60: # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then adamstark@60: # doxygen will generate a caller dependency graph for every global function adamstark@60: # or class method. Note that enabling this option will significantly increase adamstark@60: # the time of a run. So in most cases it will be better to enable caller adamstark@60: # graphs for selected functions only using the \callergraph command. adamstark@60: adamstark@60: CALLER_GRAPH = NO adamstark@60: adamstark@60: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen adamstark@60: # will generate a graphical hierarchy of all classes instead of a textual one. adamstark@60: adamstark@60: GRAPHICAL_HIERARCHY = YES adamstark@60: adamstark@60: # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES adamstark@60: # then doxygen will show the dependencies a directory has on other directories adamstark@60: # in a graphical way. The dependency relations are determined by the #include adamstark@60: # relations between the files in the directories. adamstark@60: adamstark@60: DIRECTORY_GRAPH = YES adamstark@60: adamstark@60: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images adamstark@60: # generated by dot. Possible values are svg, png, jpg, or gif. adamstark@60: # If left blank png will be used. If you choose svg you need to set adamstark@60: # HTML_FILE_EXTENSION to xhtml in order to make the SVG files adamstark@60: # visible in IE 9+ (other browsers do not have this requirement). adamstark@60: adamstark@60: DOT_IMAGE_FORMAT = png adamstark@60: adamstark@60: # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to adamstark@60: # enable generation of interactive SVG images that allow zooming and panning. adamstark@60: # Note that this requires a modern browser other than Internet Explorer. adamstark@60: # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you adamstark@60: # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files adamstark@60: # visible. Older versions of IE do not have SVG support. adamstark@60: adamstark@60: INTERACTIVE_SVG = NO adamstark@60: adamstark@60: # The tag DOT_PATH can be used to specify the path where the dot tool can be adamstark@60: # found. If left blank, it is assumed the dot tool can be found in the path. adamstark@60: adamstark@60: DOT_PATH = adamstark@60: adamstark@60: # The DOTFILE_DIRS tag can be used to specify one or more directories that adamstark@60: # contain dot files that are included in the documentation (see the adamstark@60: # \dotfile command). adamstark@60: adamstark@60: DOTFILE_DIRS = adamstark@60: adamstark@60: # The MSCFILE_DIRS tag can be used to specify one or more directories that adamstark@60: # contain msc files that are included in the documentation (see the adamstark@60: # \mscfile command). adamstark@60: adamstark@60: MSCFILE_DIRS = adamstark@60: adamstark@60: # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of adamstark@60: # nodes that will be shown in the graph. If the number of nodes in a graph adamstark@60: # becomes larger than this value, doxygen will truncate the graph, which is adamstark@60: # visualized by representing a node as a red box. Note that doxygen if the adamstark@60: # number of direct children of the root node in a graph is already larger than adamstark@60: # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note adamstark@60: # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. adamstark@60: adamstark@60: DOT_GRAPH_MAX_NODES = 50 adamstark@60: adamstark@60: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the adamstark@60: # graphs generated by dot. A depth value of 3 means that only nodes reachable adamstark@60: # from the root by following a path via at most 3 edges will be shown. Nodes adamstark@60: # that lay further from the root node will be omitted. Note that setting this adamstark@60: # option to 1 or 2 may greatly reduce the computation time needed for large adamstark@60: # code bases. Also note that the size of a graph can be further restricted by adamstark@60: # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. adamstark@60: adamstark@60: MAX_DOT_GRAPH_DEPTH = 0 adamstark@60: adamstark@60: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent adamstark@60: # background. This is disabled by default, because dot on Windows does not adamstark@60: # seem to support this out of the box. Warning: Depending on the platform used, adamstark@60: # enabling this option may lead to badly anti-aliased labels on the edges of adamstark@60: # a graph (i.e. they become hard to read). adamstark@60: adamstark@60: DOT_TRANSPARENT = NO adamstark@60: adamstark@60: # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output adamstark@60: # files in one run (i.e. multiple -o and -T options on the command line). This adamstark@60: # makes dot run faster, but since only newer versions of dot (>1.8.10) adamstark@60: # support this, this feature is disabled by default. adamstark@60: adamstark@60: DOT_MULTI_TARGETS = NO adamstark@60: adamstark@60: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will adamstark@60: # generate a legend page explaining the meaning of the various boxes and adamstark@60: # arrows in the dot generated graphs. adamstark@60: adamstark@60: GENERATE_LEGEND = YES adamstark@60: adamstark@60: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will adamstark@60: # remove the intermediate dot files that are used to generate adamstark@60: # the various graphs. adamstark@60: adamstark@60: DOT_CLEANUP = YES