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