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