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