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