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