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