Doxyfile.in | Doxyfile.in | |||
---|---|---|---|---|
# Doxyfile 1.7.1 | # Doxyfile 1.8.2 | |||
# 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 (" "). | |||
#-------------------------------------------------------------------------- - | #-------------------------------------------------------------------------- - | |||
# Project related configuration options | # Project related configuration options | |||
#-------------------------------------------------------------------------- - | #-------------------------------------------------------------------------- - | |||
# This tag specifies the encoding used for all characters in the config fil e | # This tag specifies the encoding used for all characters in the config fil e | |||
# that follow. The default is UTF-8 which is also the encoding used for all | # 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 t he | # text before the first occurrence of this tag. Doxygen uses libiconv (or t he | |||
# iconv built into libc) for the transcoding. See | # iconv built into libc) for the transcoding. See | |||
# http://www.gnu.org/software/libiconv for the list of possible encodings. | # http://www.gnu.org/software/libiconv for the list of possible encodings. | |||
DOXYFILE_ENCODING = UTF-8 | DOXYFILE_ENCODING = UTF-8 | |||
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded | # The PROJECT_NAME tag is a single word (or sequence of words) that should | |||
# by quotes) that should identify the project. | # identify the project. Note that if you do not use Doxywizard you need | |||
# to put quotes around the project name if it contains spaces. | ||||
PROJECT_NAME = "OAuth library functions" | PROJECT_NAME = "OAuth library functions" | |||
# 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 = @VERSION@ | PROJECT_NUMBER = @VERSION@ | |||
# Using the PROJECT_BRIEF tag one can provide an optional one line descript | ||||
ion | ||||
# for a project that appears at the top of each page and should give viewer | ||||
# 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 = doc/libOAuth.png | ||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | |||
# base path where the generated documentation will be put. | # base path where the generated documentation will be put. | |||
# If a relative path is entered, it will be relative to the location | # 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 us ed. | # where doxygen was started. If left blank the current directory will be us ed. | |||
OUTPUT_DIRECTORY = doc | OUTPUT_DIRECTORY = doc | |||
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | |||
# 4096 sub-directories (in 2 levels) under the output directory of each out put | # 4096 sub-directories (in 2 levels) under the output directory of each out put | |||
# format and will distribute the generated files over these directories. | # format and will distribute the generated files over these directories. | |||
skipping to change at line 60 | skipping to change at line 74 | |||
CREATE_SUBDIRS = NO | CREATE_SUBDIRS = NO | |||
# The OUTPUT_LANGUAGE tag is used to specify the language in which all | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | |||
# documentation generated by doxygen is written. Doxygen will use this | # documentation generated by doxygen is written. Doxygen will use this | |||
# information to generate all constant output in the proper language. | # information to generate all constant output in the proper language. | |||
# The default language is English, other supported languages are: | # The default language is English, other supported languages are: | |||
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | |||
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German , | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German , | |||
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English | |||
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, | |||
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, | |||
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. | |||
OUTPUT_LANGUAGE = English | OUTPUT_LANGUAGE = English | |||
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | |||
# include brief member descriptions after the members that are listed in | # include brief member descriptions after the members that are listed in | |||
# the file and class documentation (similar to JavaDoc). | # the file and class documentation (similar to JavaDoc). | |||
# Set to NO to disable this. | # Set to NO to disable this. | |||
BRIEF_MEMBER_DESC = YES | BRIEF_MEMBER_DESC = YES | |||
skipping to change at line 115 | skipping to change at line 129 | |||
# path before files name in the file list and in the header files. If set | # 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. | # to NO the shortest path that makes the file name unique will be used. | |||
FULL_PATH_NAMES = YES | FULL_PATH_NAMES = YES | |||
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | # 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 | # 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 | # 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. | # 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 | # If left blank the directory from which doxygen is run is used as the | |||
# path to strip. | # path to strip. Note that you specify absolute paths here, but also | |||
# relative paths, which will be relative from the directory where doxygen i | ||||
s | ||||
# started. | ||||
STRIP_FROM_PATH = | STRIP_FROM_PATH = src/ | |||
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of | # 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 path mentioned in the documentation of a class, which tells | |||
# the reader which header file to include in order to use a class. | # 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 | # If left blank only the name of the header file containing the class | |||
# definition is used. Otherwise one should specify the include paths that | # definition is used. Otherwise one should specify the include paths that | |||
# are normally passed to the compiler using the -I flag. | # are normally passed to the compiler using the -I flag. | |||
STRIP_FROM_INC_PATH = | STRIP_FROM_INC_PATH = | |||
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | |||
# (but less readable) file names. This can be useful is your file systems | # (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. | # doesn't support long names like on DOS, Mac, or CD-ROM. | |||
SHORT_NAMES = NO | SHORT_NAMES = NO | |||
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | |||
# will interpret the first line (until the first dot) of a JavaDoc-style | # will interpret the first line (until the first dot) of a JavaDoc-style | |||
# comment as the brief description. If set to NO, the JavaDoc | # comment as the brief description. If set to NO, the JavaDoc | |||
# comments will behave just like regular Qt-style comments | # comments will behave just like regular Qt-style comments | |||
# (thus requiring an explicit @brief command for a brief description.) | # (thus requiring an explicit @brief command for a brief description.) | |||
skipping to change at line 184 | skipping to change at line 200 | |||
# This tag can be used to specify a number of aliases that acts | # 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". | # as commands in the documentation. An alias has the form "name=value". | |||
# For example adding "sideeffect=\par Side Effects:\n" will allow you to | # For example adding "sideeffect=\par Side Effects:\n" will allow you to | |||
# put the command \sideeffect (or @sideeffect) in the documentation, which | # put the command \sideeffect (or @sideeffect) in the documentation, which | |||
# will result in a user-defined paragraph with heading "Side Effects:". | # 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. | # You can put \n's in the value part of an alias to insert newlines. | |||
ALIASES = | ALIASES = | |||
# This tag can be used to specify a number of word-keyword mappings (TCL on | ||||
ly). | ||||
# A mapping has the form "name=value". For example adding | ||||
# "class=itcl::class" will allow you to use the command class in the | ||||
# itcl::class meaning. | ||||
TCL_SUBST = | ||||
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C | # 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. | # 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 | # For instance, some of the names that are used will be different. The list | |||
# of all members will be omitted, etc. | # of all members will be omitted, etc. | |||
OPTIMIZE_OUTPUT_FOR_C = YES | OPTIMIZE_OUTPUT_FOR_C = YES | |||
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java | # 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 | # sources only. Doxygen will then generate output that is more tailored for | |||
# Java. For instance, namespaces will be presented as packages, qualified | # Java. For instance, namespaces will be presented as packages, qualified | |||
skipping to change at line 211 | skipping to change at line 234 | |||
OPTIMIZE_FOR_FORTRAN = NO | OPTIMIZE_FOR_FORTRAN = NO | |||
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | |||
# sources. Doxygen will then generate output that is tailored for | # sources. Doxygen will then generate output that is tailored for | |||
# VHDL. | # VHDL. | |||
OPTIMIZE_OUTPUT_VHDL = NO | OPTIMIZE_OUTPUT_VHDL = NO | |||
# Doxygen selects the parser to use depending on the extension of the files it | # 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 exte | # parses. With this tag you can assign which parser to use for a given | |||
nsion. | # extension. Doxygen has a built-in mapping, but you can override or extend | |||
# Doxygen has a built-in mapping, but you can override or extend it using t | it | |||
his | # using this tag. The format is ext=language, where ext is a file extension | |||
# tag. The format is ext=language, where ext is a file extension, and langu | , | |||
age | # and language is one of the parsers supported by doxygen: IDL, Java, | |||
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp | # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C | |||
, C, | , | |||
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to | # C++. For instance to make doxygen treat .inc files as Fortran files (defa | |||
make | ult | |||
# doxygen treat .inc files as Fortran files (default is PHP), and .f files | # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. No | |||
as C | te | |||
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensio | # that for custom extensions you also need to set FILE_PATTERNS otherwise t | |||
ns | he | |||
# you also need to set FILE_PATTERNS otherwise the files are not read by do | # files are not read by doxygen. | |||
xygen. | ||||
EXTENSION_MAPPING = | EXTENSION_MAPPING = | |||
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes a | ||||
ll | ||||
# comments according to the Markdown format, which allows for more readable | ||||
# documentation. See http://daringfireball.net/projects/markdown/ for detai | ||||
ls. | ||||
# The output of markdown processing is further processed by doxygen, so you | ||||
# can mix doxygen, HTML, and XML commands with Markdown formatting. | ||||
# Disable only in case of backward compatibilities issues. | ||||
MARKDOWN_SUPPORT = YES | ||||
# When enabled doxygen tries to link words that correspond to documented cl | ||||
asses, | ||||
# or namespaces to their corresponding documentation. Such a link can be | ||||
# prevented in individual cases by by putting a % sign in front of the word | ||||
or | ||||
# globally by setting AUTOLINK_SUPPORT to NO. | ||||
AUTOLINK_SUPPORT = YES | ||||
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not w ant | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not w ant | |||
# to include (a tag file for) the STL sources as input, then you should | # 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 | # 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. | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | |||
# func(std::string) {}). This also make the inheritance and collaboration | # func(std::string) {}). This also makes the inheritance and collaboration | |||
# diagrams that involve STL classes more complete and accurate. | # diagrams that involve STL classes more complete and accurate. | |||
BUILTIN_STL_SUPPORT = NO | BUILTIN_STL_SUPPORT = NO | |||
# If you use Microsoft's C++/CLI language, you should set this option to YE S to | # If you use Microsoft's C++/CLI language, you should set this option to YE S to | |||
# enable parsing support. | # enable parsing support. | |||
CPP_CLI_SUPPORT = NO | CPP_CLI_SUPPORT = NO | |||
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources on ly. | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources on ly. | |||
# Doxygen will parse them like normal C++ but will assume all classes use p ublic | # Doxygen will parse them like normal C++ but will assume all classes use p ublic | |||
# instead of private inheritance when no explicit protection keyword is pre sent. | # instead of private inheritance when no explicit protection keyword is pre sent. | |||
SIP_SUPPORT = NO | SIP_SUPPORT = NO | |||
# For Microsoft's IDL there are propget and propput attributes to indicate | # For Microsoft's IDL there are propget and propput attributes to indicate | |||
getter | getter and setter methods for a property. Setting this option to YES (the d | |||
# and setter methods for a property. Setting this option to YES (the defaul | efault) will make doxygen replace the get and set methods by a property in | |||
t) | the documentation. This will only work if the methods are indeed getting or | |||
# will make doxygen to replace the get and set methods by a property in the | setting a simple type. If this is not the case, or you want to show the me | |||
# documentation. This will only work if the methods are indeed getting or | thods anyway, you should set this option to NO. | |||
# 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 | IDL_PROPERTY_SUPPORT = YES | |||
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_ DOC | # 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 | # 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 defau lt | # member in the group (if any) for the other members of the group. By defau lt | |||
# all members of a group must be documented explicitly. | # all members of a group must be documented explicitly. | |||
DISTRIBUTE_GROUP_DOC = NO | DISTRIBUTE_GROUP_DOC = NO | |||
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of | # 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 | # 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 t o | # subgroup of that type (e.g. under the Public Functions section). Set it t o | |||
# NO to prevent subgrouping. Alternatively, this can be done per class usin g | # NO to prevent subgrouping. Alternatively, this can be done per class usin g | |||
# the \nosubgrouping command. | # the \nosubgrouping command. | |||
SUBGROUPING = YES | 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 the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and | ||||
# unions with only public data fields will be shown inline in the documenta | ||||
tion | ||||
# of the scope in which they are defined (i.e. file, namespace, or group | ||||
# documentation), provided this scope is documented. If set to NO (the defa | ||||
ult), | ||||
# structs, classes, and unions are shown on a separate page (for HTML and M | ||||
an | ||||
# pages) or section (for LaTeX and RTF). | ||||
INLINE_SIMPLE_STRUCTS = NO | ||||
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or en um | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or en um | |||
# is documented as struct, union, or enum with the name of the typedef. So | # 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 stru ct | # typedef struct TypeS {} TypeT, will appear in the documentation as a stru ct | |||
# with name TypeT. When disabled the typedef will appear as a member of a f ile, | # with name TypeT. When disabled the typedef will appear as a member of a f ile, | |||
# namespace, or class. And the struct will be named TypeS. This can typical ly | # namespace, or class. And the struct will be named TypeS. This can typical ly | |||
# be useful for C code in case the coding convention dictates that all comp ound | # be useful for C code in case the coding convention dictates that all comp ound | |||
# types are typedef'ed and only the typedef is referenced, never the tag na me. | # types are typedef'ed and only the typedef is referenced, never the tag na me. | |||
TYPEDEF_HIDES_STRUCT = NO | TYPEDEF_HIDES_STRUCT = NO | |||
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to | # 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. | # 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. | # 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 i s | # For small to medium size projects (<1000 input files) the default value i s | |||
# probably good enough. For larger projects a too small cache size can caus e | # probably good enough. For larger projects a too small cache size can caus e | |||
# doxygen to be busy swapping symbols to and from disk most of the time | # doxygen to be busy swapping symbols to and from disk most of the time | |||
# causing a significant performance penality. | # causing a significant performance penalty. | |||
# If the system has enough physical memory increasing the cache will improv e the | # If the system has enough physical memory increasing the cache will improv e the | |||
# performance by keeping more symbols in memory. Note that the value works on | # performance by keeping more symbols in memory. Note that the value works on | |||
# a logarithmic scale so increasing the size by one will rougly double the | # a logarithmic scale so increasing the size by one will roughly double the | |||
# memory usage. The cache size is given by this formula: | # 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, | # 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 | # corresponding to a cache size of 2^16 = 65536 symbols. | |||
SYMBOL_CACHE_SIZE = 0 | SYMBOL_CACHE_SIZE = 0 | |||
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can | ||||
be | ||||
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given | ||||
# their name and scope. Since this can be an expensive process and often th | ||||
e | ||||
# same symbol appear multiple times in the code, doxygen keeps a cache of | ||||
# pre-resolved symbols. If the cache is too small doxygen will become slowe | ||||
r. | ||||
# If the cache is too large, memory is wasted. The cache size is given by t | ||||
his | ||||
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default i | ||||
s 0, | ||||
# corresponding to a cache size of 2^16 = 65536 symbols. | ||||
LOOKUP_CACHE_SIZE = 0 | ||||
#-------------------------------------------------------------------------- - | #-------------------------------------------------------------------------- - | |||
# Build related configuration options | # Build related configuration options | |||
#-------------------------------------------------------------------------- - | #-------------------------------------------------------------------------- - | |||
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | |||
# documentation are documented, even if no documentation was available. | # documentation are documented, even if no documentation was available. | |||
# Private class members and static file members will be hidden unless | # 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 = YES | EXTRACT_ALL = YES | |||
# 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_PACKAGE tag is set to YES all members with package or inte | ||||
rnal | ||||
# scope will be included in the documentation. | ||||
EXTRACT_PACKAGE = 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 = YES | |||
skipping to change at line 330 | skipping to change at line 397 | |||
# methods, which are defined in the implementation section but not in | # methods, which are defined in the implementation section but not in | |||
# the interface are included in the documentation. | # the interface are included in the documentation. | |||
# If set to NO (the default) only methods in the interface are included. | # If set to NO (the default) only methods in the interface are included. | |||
EXTRACT_LOCAL_METHODS = NO | EXTRACT_LOCAL_METHODS = NO | |||
# If this flag is set to YES, the members of anonymous namespaces will be | # If this flag is set to YES, the members of anonymous namespaces will be | |||
# extracted and appear in the documentation as a namespace called | # extracted and appear in the documentation as a namespace called | |||
# 'anonymous_namespace{file}', where file will be replaced with the base | # 'anonymous_namespace{file}', where file will be replaced with the base | |||
# name of the file that contains the anonymous namespace. By default | # name of the file that contains the anonymous namespace. By default | |||
# anonymous namespace are hidden. | # anonymous namespaces are hidden. | |||
EXTRACT_ANON_NSPACES = NO | EXTRACT_ANON_NSPACES = NO | |||
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | |||
# undocumented members of documented classes, files or namespaces. | # undocumented members of documented classes, files or namespaces. | |||
# If set to NO (the default) these members will be included in the | # If set to NO (the default) these members will be included in the | |||
# various overviews, but no documentation section is generated. | # 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 | |||
skipping to change at line 441 | skipping to change at line 508 | |||
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | |||
# sorted by fully-qualified names, including namespaces. If set to | # sorted by fully-qualified names, including namespaces. If set to | |||
# NO (the default), the class list will be sorted only by class name, | # NO (the default), the class list will be sorted only by class name, | |||
# not including the namespace part. | # not including the namespace part. | |||
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | # 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 | # Note: This option applies only to the class list, not to the | |||
# alphabetical list. | # alphabetical list. | |||
SORT_BY_SCOPE_NAME = NO | SORT_BY_SCOPE_NAME = NO | |||
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to | ||||
# 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 e | ||||
ven | ||||
# 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 doxyge | ||||
n | ||||
# will still accept a match between prototype and implementation in such ca | ||||
ses. | ||||
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. | |||
skipping to change at line 471 | skipping to change at line 547 | |||
# \deprecated commands in the documentation. | # \deprecated commands in the documentation. | |||
GENERATE_DEPRECATEDLIST= YES | GENERATE_DEPRECATEDLIST= YES | |||
# The ENABLED_SECTIONS tag can be used to enable conditional | # 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 specifi ed | # the documentation. If the initializer consists of more lines than specifi ed | |||
# 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 t he | |||
# documentation can be controlled using \showinitializer or \hideinitialize r | # documentation can be controlled using \showinitializer or \hideinitialize r | |||
# 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 SHOW_USED_FILES tag to NO to disable the list of files generated | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | |||
# at the bottom of the documentation of classes and structs. If set to YES the | # at the bottom of the documentation of classes and structs. If set to YES the | |||
# list will mention the files that were used to generate the documentation. | # list will mention the files that were used to generate the documentation. | |||
SHOW_USED_FILES = YES | SHOW_USED_FILES = YES | |||
# If the sources in your project are distributed over multiple directories | ||||
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hier | ||||
archy | ||||
# in the documentation. The default is NO. | ||||
SHOW_DIRECTORIES = NO | ||||
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. | |||
# This will remove the Files entry from the Quick Index and from the | # This will remove the Files entry from the Quick Index and from the | |||
# Folder Tree View (if specified). The default is YES. | # Folder Tree View (if specified). The default is YES. | |||
SHOW_FILES = YES | SHOW_FILES = YES | |||
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the | |||
# Namespaces page. | # Namespaces page. | |||
# This will remove the Namespaces entry from the Quick Index | # This will remove the Namespaces entry from the Quick Index | |||
# and from the Folder Tree View (if specified). The default is YES. | # and from the Folder Tree View (if specified). The default is YES. | |||
skipping to change at line 517 | skipping to change at line 587 | |||
# the version control system). Doxygen will invoke the program by executing (via | # the version control system). Doxygen will invoke the program by executing (via | |||
# popen()) the command <command> <input-file>, where <command> is the value of | # 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 fil e | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input fil e | |||
# provided by doxygen. Whatever the program writes to standard output | # provided by doxygen. Whatever the program writes to standard output | |||
# is used as the file version. See the manual for examples. | # is used as the file version. See the manual for examples. | |||
FILE_VERSION_FILTER = | FILE_VERSION_FILTER = | |||
# The LAYOUT_FILE tag can be used to specify a layout file which will be pa rsed | # The LAYOUT_FILE tag can be used to specify a layout file which will be pa rsed | |||
# by doxygen. The layout file controls the global structure of the generate d | # by doxygen. The layout file controls the global structure of the generate d | |||
# output files in an output format independent way. The create the layout f ile | # output files in an output format independent way. To create the layout fi le | |||
# that represents doxygen's defaults, run doxygen with the -l option. | # that represents doxygen's defaults, run doxygen with the -l option. | |||
# You can optionally specify a file name after the option, if omitted | # You can optionally specify a file name after the option, if omitted | |||
# DoxygenLayout.xml will be used as the name of the layout file. | # DoxygenLayout.xml will be used as the name of the layout file. | |||
LAYOUT_FILE = | LAYOUT_FILE = | |||
# The CITE_BIB_FILES tag can be used to specify one or more bib files | ||||
# containing the references data. This must be a list of .bib files. The | ||||
# .bib extension is automatically appended if omitted. Using this command | ||||
# requires the bibtex tool to be installed. See also | ||||
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style | ||||
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this | ||||
# feature you need bibtex and perl available in the search path. | ||||
CITE_BIB_FILES = | ||||
#-------------------------------------------------------------------------- - | #-------------------------------------------------------------------------- - | |||
# 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 = YES | 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 | |||
skipping to change at line 552 | skipping to change at line 632 | |||
WARN_IF_UNDOCUMENTED = YES | WARN_IF_UNDOCUMENTED = YES | |||
# 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 | |||
# This WARN_NO_PARAMDOC option can be abled to get warnings for | # The WARN_NO_PARAMDOC option can be enabled to get warnings for | |||
# functions that are documented, but have no documentation for their parame ters | # functions that are documented, but have no documentation for their parame ters | |||
# or return value. If set to NO (the default) doxygen will only warn about | # or return value. If set to NO (the default) doxygen will only warn about | |||
# wrong or incomplete parameter documentation, but not about the absence of | # wrong or incomplete parameter documentation, but not about the absence of | |||
# documentation. | # documentation. | |||
WARN_NO_PARAMDOC = NO | WARN_NO_PARAMDOC = NO | |||
# The WARN_FORMAT tag determines the format of the warning messages that | # The WARN_FORMAT tag determines the format of the warning messages that | |||
# doxygen can produce. The string should contain the $file, $line, and $tex t | # doxygen can produce. The string should contain the $file, $line, and $tex t | |||
# tags, which will be replaced by the file and line number from which the | # tags, which will be replaced by the file and line number from which the | |||
skipping to change at line 599 | skipping to change at line 679 | |||
# also the default input encoding. Doxygen uses libiconv (or the iconv buil t | # also the default input encoding. Doxygen uses libiconv (or the iconv buil t | |||
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | |||
# the list of possible encodings. | # the list of possible encodings. | |||
INPUT_ENCODING = UTF-8 | INPUT_ENCODING = UTF-8 | |||
# 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 | |||
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | # 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 | # and *.h) to filter out the source-files in the directories. If left | |||
# blank the following patterns are tested: | # blank the following patterns are tested: | |||
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh * | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *. | |||
.hxx | hh | |||
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py | |||
# *.f90 *.f *.for *.vhd *.vhdl | ||||
FILE_PATTERNS = | FILE_PATTERNS = | |||
# The RECURSIVE tag can be used to turn specify whether or not subdirectori es | # The RECURSIVE tag can be used to turn specify whether or not subdirectori es | |||
# should be searched for input files as well. Possible values are YES and N O. | # should be searched for input files as well. Possible values are YES and N O. | |||
# If left blank NO is used. | # If left blank NO is used. | |||
RECURSIVE = NO | RECURSIVE = NO | |||
# The EXCLUDE tag can be used to specify files and/or directories that shou ld | # The EXCLUDE tag can be used to specify files and/or directories that shou ld be | |||
# 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. | |||
# Note that relative paths are relative to the directory from which doxygen | ||||
is | ||||
# run. | ||||
EXCLUDE = | EXCLUDE = | |||
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or | |||
# directories that are symbolic links (a Unix filesystem feature) are exclu | # directories that are symbolic links (a Unix file system feature) are excl | |||
ded | uded | |||
# from the input. | # 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. Note that the wildcards are matched | # certain files from those directories. Note that the wildcards are matched | |||
# against the file with absolute path, so to exclude all test directories | # against the file with absolute path, so to exclude all test directories | |||
# for example use the pattern */test/* | # for example use the pattern */test/* | |||
skipping to change at line 681 | skipping to change at line 764 | |||
# ignored. | # ignored. | |||
INPUT_FILTER = | INPUT_FILTER = | |||
# The FILTER_PATTERNS tag can be used to specify filters on a per file patt ern | # The FILTER_PATTERNS tag can be used to specify filters on a per file patt ern | |||
# basis. | # basis. | |||
# Doxygen will compare the file name with each pattern and apply the | # Doxygen will compare the file name with each pattern and apply the | |||
# filter if there is a match. | # filter if there is a match. | |||
# The filters are a list of the form: | # The filters are a list of the form: | |||
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | |||
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | # info on how filters are used. If FILTER_PATTERNS is empty or if | |||
# is applied to all files. | # non of the patterns match the file name, INPUT_FILTER is applied. | |||
FILTER_PATTERNS = | FILTER_PATTERNS = | |||
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set us ing | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set us ing | |||
# INPUT_FILTER) will be used to filter the input files when producing sourc e | # INPUT_FILTER) will be used to filter the input files when producing sourc e | |||
# 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 patter | ||||
n | ||||
# using *.ext= (so without naming a filter). This option only has effect wh | ||||
en | ||||
# 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 sou rces. | # be generated. Documented entities will be cross-referenced with these sou rces. | |||
# Note: To get rid of all source code in the generated output, make sure al so | # Note: To get rid of all source code in the generated output, make sure al so | |||
# VERBATIM_HEADERS is set to NO. | # VERBATIM_HEADERS is set to NO. | |||
SOURCE_BROWSER = YES | SOURCE_BROWSER = YES | |||
# 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, C++ and Fortran comments will always remain visible. | |||
STRIP_CODE_COMMENTS = YES | STRIP_CODE_COMMENTS = YES | |||
# If the REFERENCED_BY_RELATION tag is set to YES | # 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 | # If the REFERENCES_RELATION tag is set to YES | |||
skipping to change at line 794 | skipping to change at line 885 | |||
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 bla nk | # each generated HTML page (for example: .htm,.php,.asp). If it is left bla nk | |||
# 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 advised 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 left blank doxygen will | |||
# will generate a default style sheet. Note that doxygen will try to copy | # generate a default style sheet. Note that it is recommended to use | |||
# the style sheet file to the HTML output directory, so don't put your own | # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this | |||
# stylesheet in the HTML output directory as well, or it will be erased! | # tag will in the future become obsolete. | |||
HTML_STYLESHEET = | HTML_STYLESHEET = | |||
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional | ||||
# user-defined cascading style sheet that is included after the standard | ||||
# style sheets created by doxygen. Using this option one can overrule | ||||
# certain style aspects. This is preferred over using HTML_STYLESHEET | ||||
# since it does not replace the standard style sheet and is therefor more | ||||
# robust against future updates. Doxygen will copy the style sheet file to | ||||
# the output directory. | ||||
HTML_EXTRA_STYLESHEET = | ||||
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images | ||||
or | ||||
# other source files which should be copied to the HTML output directory. N | ||||
ote | ||||
# that these files will be copied to the base HTML output directory. Use th | ||||
e | ||||
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load thes | ||||
e | ||||
# files. In the HTML_STYLESHEET file, use the file name only. Also note tha | ||||
t | ||||
# the files will be copied as-is; there are no commands or markers availabl | ||||
e. | ||||
HTML_EXTRA_FILES = | ||||
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. | |||
# Doxygen will adjust the colors in the stylesheet and background images | # Doxygen will adjust the colors in the style sheet and background images | |||
# according to this color. Hue is specified as an angle on a colorwheel, | # according to this color. Hue is specified as an angle on a colorwheel, | |||
# see http://en.wikipedia.org/wiki/Hue for more information. | # see http://en.wikipedia.org/wiki/Hue for more information. | |||
# For instance the value 0 represents red, 60 is yellow, 120 is green, | # 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. | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. | |||
# The allowed range is 0 to 359. | # The allowed range is 0 to 359. | |||
HTML_COLORSTYLE_HUE = 220 | HTML_COLORSTYLE_HUE = 220 | |||
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of | # 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 | # the colors in the HTML output. For a value of 0 the output will use | |||
skipping to change at line 844 | skipping to change at line 961 | |||
# and 100 does not change the gamma. | # and 100 does not change the gamma. | |||
HTML_COLORSTYLE_GAMMA = 80 | HTML_COLORSTYLE_GAMMA = 80 | |||
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | # 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 | # 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. | # this to NO can help when comparing the output of multiple runs. | |||
HTML_TIMESTAMP = YES | 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. | ||||
HTML_ALIGN_MEMBERS = YES | ||||
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | |||
# documentation will contain sections that can be hidden and shown after th e | # documentation will contain sections that can be hidden and shown after th e | |||
# page has loaded. For this to work a browser that supports | # page has loaded. | |||
# 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 | HTML_DYNAMIC_SECTIONS = NO | |||
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of | ||||
# entries shown in the various tree structured indices initially; the user | ||||
# can expand and collapse entries dynamically later on. Doxygen will expand | ||||
# the tree to such a level that at most the specified number of entries are | ||||
# visible (unless a fully collapsed tree already exceeds this amount). | ||||
# So setting the number of entries 1 will produce a full collapsed tree by | ||||
# default. 0 is a special value representing an infinite number of entries | ||||
# and will result in a full expanded tree by default. | ||||
HTML_INDEX_NUM_ENTRIES = 100 | ||||
# If the GENERATE_DOCSET tag is set to YES, additional index files | # 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 | # will be generated that can be used as input for Apple's Xcode 3 | |||
# integrated development environment, introduced with OSX 10.5 (Leopard). | # integrated development environment, introduced with OSX 10.5 (Leopard). | |||
# To create a documentation set, doxygen will generate a Makefile in the | # To create a documentation set, doxygen will generate a Makefile in the | |||
# HTML output directory. Running make will produce the docset in that | # HTML output directory. Running make will produce the docset in that | |||
# directory and running "make install" will install the docset in | # directory and running "make install" will install the docset in | |||
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | |||
# it at startup. | # it at startup. | |||
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | |||
# for more information. | # for more information. | |||
skipping to change at line 885 | skipping to change at line 1005 | |||
DOCSET_FEEDNAME = "Doxygen generated docs" | DOCSET_FEEDNAME = "Doxygen generated docs" | |||
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | # 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 | # should uniquely identify the documentation set bundle. This should be a | |||
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | |||
# will append .docset to the name. | # will append .docset to the name. | |||
DOCSET_BUNDLE_ID = org.doxygen.Project | DOCSET_BUNDLE_ID = org.doxygen.Project | |||
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely id | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely | |||
entify | # identify the documentation publisher. This should be a reverse domain-nam | |||
# the documentation publisher. This should be a reverse domain-name style | e | |||
# string, e.g. com.mycompany.MyDocSet.documentation. | # style string, e.g. com.mycompany.MyDocSet.documentation. | |||
DOCSET_PUBLISHER_ID = org.doxygen.Publisher | DOCSET_PUBLISHER_ID = org.doxygen.Publisher | |||
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. | |||
DOCSET_PUBLISHER_NAME = Publisher | DOCSET_PUBLISHER_NAME = Publisher | |||
# If the GENERATE_HTMLHELP tag is set to YES, additional index files | # 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 | # 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) | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | |||
skipping to change at line 1009 | skipping to change at line 1129 | |||
# the help appears. | # the help appears. | |||
GENERATE_ECLIPSEHELP = NO | GENERATE_ECLIPSEHELP = NO | |||
# A unique identifier for the eclipse help plugin. When installing the plug in | # A unique identifier for the eclipse help plugin. When installing the plug in | |||
# the directory name containing the HTML and XML files should also have | # the directory name containing the HTML and XML files should also have | |||
# this name. | # this name. | |||
ECLIPSE_DOC_ID = org.doxygen.Project | ECLIPSE_DOC_ID = org.doxygen.Project | |||
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at | # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tab | |||
# top of each HTML page. The value NO (the default) enables the index and | s) | |||
# the value YES disables it. | # at top of each HTML page. The value NO (the default) enables the index an | |||
d | ||||
# the value YES disables it. Since the tabs have the same information as th | ||||
e | ||||
# navigation tree you can set this option to NO if you already set | ||||
# GENERATE_TREEVIEW to YES. | ||||
DISABLE_INDEX = NO | DISABLE_INDEX = NO | |||
# This tag can be used to set the number of enum values (range [1..20]) | ||||
# that doxygen will group on one line in the generated HTML documentation. | ||||
ENUM_VALUES_PER_LINE = 4 | ||||
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | |||
# structure should be generated to display hierarchical information. | # structure should be generated to display hierarchical information. | |||
# If the tag value is set to YES, a side panel will be generated | # If the tag value is set to YES, a side panel will be generated | |||
# containing a tree-like index structure (just like the one that | # containing a tree-like index structure (just like the one that | |||
# is generated for HTML Help). For this to work a browser that supports | # is generated for HTML Help). For this to work a browser that supports | |||
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). | |||
# Windows users are probably better off using the HTML help feature. | # Windows users are probably better off using the HTML help feature. | |||
# Since the tree basically has the same information as the tab index you | ||||
# could consider to set DISABLE_INDEX to NO when enabling this option. | ||||
GENERATE_TREEVIEW = NO | GENERATE_TREEVIEW = NO | |||
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directori | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values | |||
es, | # (range [0,1..20]) that doxygen will group on one line in the generated HT | |||
# and Class Hierarchy pages using a tree view instead of an ordered list. | ML | |||
# documentation. Note that a value of 0 will completely suppress the enum | ||||
# values from appearing in the overview section. | ||||
USE_INLINE_TREES = NO | ENUM_VALUES_PER_LINE = 4 | |||
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | # 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 | # 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 | # 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. | # links to external symbols imported via tag files in a separate window. | |||
skipping to change at line 1062 | skipping to change at line 1183 | |||
FORMULA_FONTSIZE = 10 | FORMULA_FONTSIZE = 10 | |||
# Use the FORMULA_TRANPARENT tag to determine whether or not the images | # Use the FORMULA_TRANPARENT tag to determine whether or not the images | |||
# generated for formulas are transparent PNGs. Transparent PNGs are | # generated for formulas are transparent PNGs. Transparent PNGs are | |||
# not supported properly for IE 6.0, but are supported on all modern browse rs. | # not supported properly for IE 6.0, but are supported on all modern browse rs. | |||
# Note that when changing this option you need to delete any form_*.png fil es | # Note that when changing this option you need to delete any form_*.png fil es | |||
# in the HTML output before the changes have effect. | # in the HTML output before the changes have effect. | |||
FORMULA_TRANSPARENT = YES | 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 may 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 math | ||||
jax | ||||
# 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 Content Delivery Network so you can quickly see the result wi | ||||
thout | ||||
# installing MathJax. | ||||
# However, it is strongly recommended to install a local | ||||
# copy of MathJax from http://www.mathjax.org before deployment. | ||||
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | ||||
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extensio | ||||
n | ||||
# names that should be enabled during MathJax rendering. | ||||
MATHJAX_EXTENSIONS = | ||||
# When the SEARCHENGINE tag is enabled doxygen will generate a search box | # When the SEARCHENGINE tag is enabled doxygen will generate a search box | |||
# for the HTML output. The underlying search engine uses javascript | # for the HTML output. The underlying search engine uses javascript | |||
# and DHTML and should work on any modern browser. Note that when using | # and DHTML and should work on any modern browser. Note that when using | |||
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets | |||
# (GENERATE_DOCSET) there is already a search function so this one should | # (GENERATE_DOCSET) there is already a search function so this one should | |||
# typically be disabled. For large projects the javascript based search eng ine | # typically be disabled. For large projects the javascript based search eng ine | |||
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solut ion. | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solut ion. | |||
SEARCHENGINE = NO | SEARCHENGINE = NO | |||
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be | # 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 | # implemented using a PHP enabled web server instead of at the web client | |||
# using Javascript. Doxygen will generate the search PHP script and index | # using Javascript. Doxygen will generate the search PHP script and index | |||
# file to put on the web server. The advantage of the server | # file to put on the web server. The advantage of the server | |||
# based approach is that it scales better to large projects and allows | # based approach is that it scales better to large projects and allows | |||
# full text search. The disadvances is that it is more difficult to setup | # full text search. The disadvantages are that it is more difficult to setu p | |||
# and does not have live searching capabilities. | # and does not have live searching capabilities. | |||
SERVER_BASED_SEARCH = NO | 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. | |||
skipping to change at line 1118 | skipping to change at line 1265 | |||
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 = | |||
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for | ||||
# the generated latex document. The footer should contain everything after | ||||
# 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 | # 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 | # is prepared for conversion to pdf (using ps2pdf). The pdf 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 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. | |||
skipping to change at line 1168 | skipping to change at line 1322 | |||
LATEX_HIDE_INDICES = NO | LATEX_HIDE_INDICES = NO | |||
# If LATEX_SOURCE_CODE is set to YES then doxygen will include | # If LATEX_SOURCE_CODE is set to YES then doxygen will include | |||
# source code with syntax highlighting in the LaTeX output. | # source code with syntax highlighting in the LaTeX output. | |||
# Note that which sources are shown also depends on other settings | # Note that which sources are shown also depends on other settings | |||
# such as SOURCE_BROWSER. | # such as SOURCE_BROWSER. | |||
LATEX_SOURCE_CODE = NO | LATEX_SOURCE_CODE = NO | |||
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the | ||||
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See | ||||
# http://en.wikipedia.org/wiki/BibTeX for more info. | ||||
LATEX_BIB_STYLE = plain | ||||
#-------------------------------------------------------------------------- - | #-------------------------------------------------------------------------- - | |||
# 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 optimized 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 | |||
skipping to change at line 1199 | skipping to change at line 1359 | |||
# 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 style sheet definitions from file. Syntax is similar to doxygen's | |||
# config file, i.e. a series of assignments. 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 = | |||
skipping to change at line 1344 | skipping to change at line 1504 | |||
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_DEFINED 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 | |||
skipping to change at line 1374 | skipping to change at line 1534 | |||
# 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. To prevent a macro definition from being | # omitted =1 is assumed. To prevent a macro definition from being | |||
# undefined via #undef or recursively expanded use the := operator | # undefined via #undef or recursively expanded use the := operator | |||
# instead of the = operator. | # instead of the = operator. | |||
PREDEFINED = DOXYGEN_IGNORE | PREDEFINED = DOXYGEN_IGNORE | |||
# 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 expa nded. | # this tag can be used to specify a list of macro names that should be expa nded. | |||
# 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 th | |||
at | ||||
# 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 alon | # doxygen's preprocessor will remove all references to function-like macros | |||
e | # that are alone on a line, have an all uppercase name, and do not end with | |||
# on a line, have an all uppercase name, and do not end with a semicolon. S | a | |||
uch | # semicolon, because these will confuse the parser if not removed. | |||
# function macros are typically used for boiler-plate code, and will confus | ||||
e | ||||
# the parser if not removed. | ||||
SKIP_FUNCTION_MACROS = YES | SKIP_FUNCTION_MACROS = YES | |||
#-------------------------------------------------------------------------- - | #-------------------------------------------------------------------------- - | |||
# Configuration::additions 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. For each | |||
# Optionally an initial location of the external documentation | # tag file the location of the external documentation should be added. The | |||
# can be added for each tagfile. The format of a tag file without | # format of a tag file without this location is as follows: | |||
# this location is as follows: | ||||
# | # | |||
# TAGFILES = file1 file2 ... | # TAGFILES = file1 file2 ... | |||
# Adding location for the tag files is done as follows: | # Adding location for the tag files is done as follows: | |||
# | # | |||
# TAGFILES = file1=loc1 "file2 = loc2" ... | # TAGFILES = file1=loc1 "file2 = loc2" ... | |||
# where "loc1" and "loc2" can be relative or absolute paths or | # where "loc1" and "loc2" can be relative or absolute paths | |||
# URLs. If a location is present for each tag, the installdox tool | # or URLs. Note that each tag file must have a unique name (where the name | |||
# does not have to be run to correct the links. | does | |||
# Note that each tag file must have a unique name | # NOT include the path). If a tag file is not located in the directory in w | |||
# (where the name does NOT include the path) | hich | |||
# If a tag file is not located in the directory in which doxygen | # 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 | |||
skipping to change at line 1438 | skipping to change at line 1594 | |||
PERL_PATH = @PERL@ | PERL_PATH = @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 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base | |||
# or super classes. Setting the tag to NO turns the diagrams off. Note that | # or super classes. Setting the tag to NO turns the diagrams off. Note that | |||
# this option is superseded by the HAVE_DOT option below. This is only a | # this option also works with HAVE_DOT disabled, but it is recommended to | |||
# fallback. It is recommended to install and use dot, since it yields more | # install and use dot, since it yields more powerful graphs. | |||
# powerful graphs. | ||||
CLASS_DIAGRAMS = YES | CLASS_DIAGRAMS = YES | |||
# You can define message sequence charts within doxygen comments using the \msc | # You can define message sequence charts within doxygen comments using the \msc | |||
# command. Doxygen will then run the mscgen tool (see | # command. Doxygen will then run the mscgen tool (see | |||
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | # 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 wh ere | # documentation. The MSCGEN_PATH tag allows you to specify the directory wh ere | |||
# the mscgen tool resides. If left empty the tool is assumed to be found in the | # the mscgen tool resides. If left empty the tool is assumed to be found in the | |||
# default search path. | # default search path. | |||
skipping to change at line 1474 | skipping to change at line 1629 | |||
HAVE_DOT = @HAVEDOT@ | HAVE_DOT = @HAVEDOT@ | |||
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is | |||
# allowed to run in parallel. When set to 0 (the default) doxygen will | # allowed to run in parallel. When set to 0 (the default) doxygen will | |||
# base this on the number of processors available in the system. You can se t it | # base this on the number of processors available in the system. You can se t it | |||
# explicitly to a value larger than 0 to get control over the balance | # explicitly to a value larger than 0 to get control over the balance | |||
# between CPU load and processing speed. | # between CPU load and processing speed. | |||
DOT_NUM_THREADS = 0 | DOT_NUM_THREADS = 0 | |||
# By default doxygen will write a font called FreeSans.ttf to the output | # By default doxygen will use the Helvetica font for all dot files that | |||
# directory and reference it in all dot files that doxygen generates. This | # doxygen generates. When you want a differently looking font you can speci | |||
# font does not include all possible unicode characters however, so when yo | fy | |||
u need | # the font name using DOT_FONTNAME. You need to make sure dot is able to fi | |||
# these (or just want a differently looking font) you can specify the font | nd | |||
name | # the font, which can be done by putting it in a standard location or by se | |||
# using DOT_FONTNAME. You need need to make sure dot is able to find the fo | tting | |||
nt, | # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the | |||
# which can be done by putting it in a standard location or by setting the | # directory containing the font. | |||
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the direct | ||||
ory | ||||
# containing the font. | ||||
DOT_FONTNAME = FreeSans.ttf | DOT_FONTNAME = FreeSans.ttf | |||
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graph s. | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graph s. | |||
# The default size is 10pt. | # The default size is 10pt. | |||
DOT_FONTSIZE = 10 | DOT_FONTSIZE = 10 | |||
# By default doxygen will tell dot to use the output directory to look for | # By default doxygen will tell dot to use the Helvetica font. | |||
the | # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPA | |||
# FreeSans.ttf font (which doxygen will put there itself). If you specify a | TH to | |||
# different font using DOT_FONTNAME you can set the path where dot | # set the path where dot can find it. | |||
# can find it using this tag. | ||||
DOT_FONTPATH = | DOT_FONTPATH = | |||
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | # 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 | # will generate a graph for each documented class showing the direct and | |||
# indirect inheritance relations. Setting this tag to YES will force the | # indirect inheritance relations. Setting this tag to YES will force the | |||
# the CLASS_DIAGRAMS tag to NO. | # 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 | |||
skipping to change at line 1522 | skipping to change at line 1674 | |||
# will generate a graph for groups, showing the direct groups dependencies | # will generate a graph for groups, showing the direct groups dependencies | |||
GROUP_GRAPHS = YES | GROUP_GRAPHS = YES | |||
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and | # 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 | # collaboration diagrams in a style similar to the OMG's Unified Modeling | |||
# Language. | # Language. | |||
UML_LOOK = NO | UML_LOOK = NO | |||
# If the UML_LOOK tag is enabled, the fields and methods are shown inside | ||||
# the class node. If there are many fields or methods and many nodes the | ||||
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS | ||||
# threshold limits the number of items for each type to make the size more | ||||
# managable. Set this to 0 for no limit. Note that the threshold may be | ||||
# exceeded by 50% before the limit is enforced. | ||||
UML_LIMIT_NUM_FIELDS = 10 | ||||
# 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 documente d | # tags are set to YES then doxygen will generate a graph for each documente d | |||
# file showing the direct and indirect include dependencies of the file wit h | # file showing the direct and indirect include dependencies of the file wit h | |||
# other documented files. | # other documented files. | |||
skipping to change at line 1558 | skipping to change at line 1719 | |||
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | |||
# doxygen will generate a caller dependency graph for every global function | # doxygen will generate a caller dependency graph for every global function | |||
# or class method. Note that enabling this option will significantly increa se | # or class method. Note that enabling this option will significantly increa se | |||
# the time of a run. So in most cases it will be better to enable caller | # 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. | # graphs for selected functions only using the \callergraph command. | |||
CALLER_GRAPH = NO | CALLER_GRAPH = NO | |||
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | |||
# will graphical hierarchy of all classes instead of a textual one. | # will generate a graphical hierarchy of all classes instead of a textual o ne. | |||
GRAPHICAL_HIERARCHY = YES | GRAPHICAL_HIERARCHY = YES | |||
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES | # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES | |||
# then doxygen will show the dependencies a directory has on other director ies | # then doxygen will show the dependencies a directory has on other director ies | |||
# in a graphical way. The dependency relations are determined by the #inclu de | # in a graphical way. The dependency relations are determined by the #inclu de | |||
# relations between the files in the directories. | # relations between the files in the directories. | |||
DIRECTORY_GRAPH = YES | DIRECTORY_GRAPH = YES | |||
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the image s | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the image s | |||
# generated by dot. Possible values are png, jpg, or gif | # 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. If you choose svg you need to set | |||
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files | ||||
# visible in IE 9+ (other browsers do not have this requirement). | ||||
DOT_IMAGE_FORMAT = png | DOT_IMAGE_FORMAT = png | |||
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to | ||||
# enable generation of interactive SVG images that allow zooming and pannin | ||||
g. | ||||
# Note that this requires a modern browser other than Internet Explorer. | ||||
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you | ||||
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files | ||||
# visible. Older versions of IE do not have SVG support. | ||||
INTERACTIVE_SVG = NO | ||||
# The tag DOT_PATH can be used to specify the path where the dot tool can b e | # The tag DOT_PATH can be used to specify the path where the dot tool can b e | |||
# found. If left blank, it is assumed the dot tool can be found in the path . | # found. If left blank, it is assumed the dot tool can be found in the path . | |||
DOT_PATH = @DOTPATH@ | DOT_PATH = @DOTPATH@ | |||
# 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 MSCFILE_DIRS tag can be used to specify one or more directories that | ||||
# contain msc files that are included in the documentation (see the | ||||
# \mscfile command). | ||||
MSCFILE_DIRS = | ||||
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | |||
# nodes that will be shown in the graph. If the number of nodes in a graph | # nodes that will be shown in the graph. If the number of nodes in a graph | |||
# becomes larger than this value, doxygen will truncate the graph, which is | # becomes larger than this value, doxygen will truncate the graph, which is | |||
# visualized by representing a node as a red box. Note that doxygen if the | # visualized by representing a node as a red box. Note that doxygen if the | |||
# number of direct children of the root node in a graph is already larger t han | # number of direct children of the root node in a graph is already larger t han | |||
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | # 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 . | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH . | |||
DOT_GRAPH_MAX_NODES = 50 | DOT_GRAPH_MAX_NODES = 50 | |||
End of changes. 70 change blocks. | ||||
139 lines changed or deleted | 356 lines changed or added | |||
This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/ |