DoxyFile (libosip2-5.0.0) | : | DoxyFile (libosip2-5.1.0) | ||
---|---|---|---|---|
# Doxyfile 1.8.1.2 | # Doxyfile 1.8.13 | |||
# 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 double hash (##) is considered a comment and is placed in | |||
# front of the TAG it is preceding. | ||||
# | ||||
# All text after a single 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 file | # This tag specifies the encoding used for all characters in the config file | |||
# that follow. The default is UTF-8 which is also the encoding used for all | # that follow. The default is UTF-8 which is also the encoding used for all text | |||
# text before the first occurrence of this tag. Doxygen uses libiconv (or the | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv | |||
# iconv built into libc) for the transcoding. See | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv | |||
# http://www.gnu.org/software/libiconv for the list of possible encodings. | # for the list of possible encodings. | |||
# The default value is: UTF-8. | ||||
DOXYFILE_ENCODING = UTF-8 | DOXYFILE_ENCODING = UTF-8 | |||
# The PROJECT_NAME tag is a single word (or sequence of words) that should | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by | |||
# identify the project. Note that if you do not use Doxywizard you need | # double-quotes, unless you are using Doxywizard) that should identify the | |||
# to put quotes around the project name if it contains spaces. | # project for which the documentation is generated. This name is used in the | |||
# title of most generated pages and in a few other places. | ||||
# The default value is: My Project. | ||||
PROJECT_NAME = libosip | PROJECT_NAME = libosip | |||
# 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 | |||
# This could be handy for archiving the generated documentation or | # could be handy for archiving the generated documentation or if some version | |||
# if some version control system is used. | # control system is used. | |||
PROJECT_NUMBER = 5.0.0 | PROJECT_NUMBER = 5.1.0 | |||
# Using the PROJECT_BRIEF tag one can provide an optional one line description | # Using the PROJECT_BRIEF tag one can provide an optional one line description | |||
# for a project that appears at the top of each page and should give viewer | # for a project that appears at the top of each page and should give viewer a | |||
# a quick idea about the purpose of the project. Keep the description short. | # quick idea about the purpose of the project. Keep the description short. | |||
PROJECT_BRIEF = | PROJECT_BRIEF = | |||
# With the PROJECT_LOGO tag one can specify an logo or icon that is | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included | |||
# included in the documentation. The maximum height of the logo should not | # in the documentation. The maximum height of the logo should not exceed 55 | |||
# exceed 55 pixels and the maximum width should not exceed 200 pixels. | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy | |||
# Doxygen will copy the logo to the output directory. | # the logo to the output directory. | |||
PROJECT_LOGO = | PROJECT_LOGO = | |||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path | |||
# base path where the generated documentation will be put. | # into which the generated documentation will be written. If a relative path is | |||
# If a relative path is entered, it will be relative to the location | # entered, it will be relative to the location where doxygen was started. If | |||
# where doxygen was started. If left blank the current directory will be used. | # left blank the current directory will be used. | |||
OUTPUT_DIRECTORY = help/doxygen/doc | OUTPUT_DIRECTORY = help/doxygen/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- | |||
# 4096 sub-directories (in 2 levels) under the output directory of each output | # directories (in 2 levels) under the output directory of each output format and | |||
# format and will distribute the generated files over these directories. | # will distribute the generated files over these directories. Enabling this | |||
# Enabling this option can be useful when feeding doxygen a huge amount of | # option can be useful when feeding doxygen a huge amount of source files, where | |||
# source files, where putting all generated files in the same directory would | # putting all generated files in the same directory would otherwise causes | |||
# otherwise cause performance problems for the file system. | # performance problems for the file system. | |||
# The default value is: NO. | ||||
CREATE_SUBDIRS = NO | CREATE_SUBDIRS = NO | |||
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII | ||||
# characters to appear in the names of generated files. If set to NO, non-ASCII | ||||
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode | ||||
# U+3044. | ||||
# The default value is: NO. | ||||
ALLOW_UNICODE_NAMES = 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: | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, | |||
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), | |||
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, | |||
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), | |||
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, | |||
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, | |||
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, | |||
# Ukrainian and Vietnamese. | ||||
# The default value is: English. | ||||
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, doxygen will include brief member | |||
# include brief member descriptions after the members that are listed in | # descriptions after the members that are listed in the file and class | |||
# the file and class documentation (similar to JavaDoc). | # documentation (similar to Javadoc). Set to NO to disable this. | |||
# Set to NO to disable this. | # The default value is: YES. | |||
BRIEF_MEMBER_DESC = YES | BRIEF_MEMBER_DESC = YES | |||
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief | |||
# the brief description of a member or function before the detailed description. | # description of a member or function before the detailed description | |||
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | # | |||
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | ||||
# brief descriptions will be completely suppressed. | # brief descriptions will be completely suppressed. | |||
# The default value is: YES. | ||||
REPEAT_BRIEF = YES | REPEAT_BRIEF = YES | |||
# This tag implements a quasi-intelligent brief description abbreviator | # This tag implements a quasi-intelligent brief description abbreviator that is | |||
# that is used to form the text in various listings. Each string | # used to form the text in various listings. Each string in this list, if found | |||
# in this list, if found as the leading text of the brief description, will be | # as the leading text of the brief description, will be stripped from the text | |||
# stripped from the text and the result after processing the whole list, is | # and the result, after processing the whole list, is used as the annotated | |||
# used as the annotated text. Otherwise, the brief description is used as-is. | # text. Otherwise, the brief description is used as-is. If left blank, the | |||
# If left blank, the following values are used ("$name" is automatically | # following values are used ($name is automatically replaced with the name of | |||
# replaced with the name of the entity): "The $name class" "The $name widget" | # the entity):The $name class, The $name widget, The $name file, is, provides, | |||
# "The $name file" "is" "provides" "specifies" "contains" | # specifies, contains, represents, a, an and the. | |||
# "represents" "a" "an" "the" | ||||
ABBREVIATE_BRIEF = | ABBREVIATE_BRIEF = | |||
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | |||
# Doxygen will generate a detailed section even if there is only a brief | # doxygen will generate a detailed section even if there is only a brief | |||
# description. | # description. | |||
# The default value is: NO. | ||||
ALWAYS_DETAILED_SEC = NO | ALWAYS_DETAILED_SEC = NO | |||
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all | |||
# inherited members of a class in the documentation of that class as if those | # inherited members of a class in the documentation of that class as if those | |||
# members were ordinary class members. Constructors, destructors and assignment | # members were ordinary class members. Constructors, destructors and assignment | |||
# operators of the base classes will not be shown. | # operators of the base classes will not be shown. | |||
# The default value is: NO. | ||||
INLINE_INHERITED_MEMB = NO | INLINE_INHERITED_MEMB = NO | |||
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path | |||
# path before files name in the file list and in the header files. If set | # before files name in the file list and in the header files. If set to NO the | |||
# to NO the shortest path that makes the file name unique will be used. | # shortest path that makes the file name unique will be used | |||
# The default value is: YES. | ||||
FULL_PATH_NAMES = NO | FULL_PATH_NAMES = NO | |||
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. | |||
# can be used to strip a user-defined part of the path. Stripping is | # Stripping is only done if one of the specified strings matches the left-hand | |||
# only done if one of the specified strings matches the left-hand part of | # 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 path to | |||
# If left blank the directory from which doxygen is run is used as the | # strip. | |||
# path to strip. | # | |||
# Note that you can specify absolute paths here, but also relative paths, which | ||||
# will be relative from the directory where doxygen is started. | ||||
# This tag requires that the tag FULL_PATH_NAMES is set to YES. | ||||
STRIP_FROM_PATH = | STRIP_FROM_PATH = | |||
# 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 | |||
# the path mentioned in the documentation of a class, which tells | # path mentioned in the documentation of a class, which tells the reader which | |||
# the reader which header file to include in order to use a class. | # header file to include in order to use a class. If left blank only the name of | |||
# If left blank only the name of the header file containing the class | # the header file containing the class definition is used. Otherwise one should | |||
# definition is used. Otherwise one should specify the include paths that | # specify the list of include paths that are normally passed to the compiler | |||
# are normally passed to the compiler using the -I flag. | # 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 | |||
# (but less readable) file names. This can be useful if your file system | # less readable) file names. This can be useful is your file systems doesn't | |||
# doesn't support long names like on DOS, Mac, or CD-ROM. | # support long names like on DOS, Mac, or CD-ROM. | |||
# The default value is: NO. | ||||
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 | |||
# will interpret the first line (until the first dot) of a JavaDoc-style | # first line (until the first dot) of a Javadoc-style comment as the brief | |||
# comment as the brief description. If set to NO, the JavaDoc | # description. If set to NO, the Javadoc-style will behave just like regular Qt- | |||
# comments will behave just like regular Qt-style comments | # style comments (thus requiring an explicit @brief command for a brief | |||
# (thus requiring an explicit @brief command for a brief description.) | # description.) | |||
# The default value is: NO. | ||||
JAVADOC_AUTOBRIEF = NO | JAVADOC_AUTOBRIEF = NO | |||
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first | |||
# interpret the first line (until the first dot) of a Qt-style | # line (until the first dot) of a Qt-style comment as the brief description. If | |||
# comment as the brief description. If set to NO, the comments | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus | |||
# will behave just like regular Qt-style comments (thus requiring | # requiring an explicit \brief command for a brief description.) | |||
# an explicit \brief command for a brief description.) | # The default value is: NO. | |||
QT_AUTOBRIEF = NO | QT_AUTOBRIEF = NO | |||
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a | |||
# treat a multi-line C++ special comment block (i.e. a block of //! or /// | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as | |||
# comments) as a brief description. This used to be the default behaviour. | # a brief description. This used to be the default behavior. The new default is | |||
# The new default is to treat a multi-line C++ comment block as a detailed | # to treat a multi-line C++ comment block as a detailed description. Set this | |||
# description. Set this tag to YES if you prefer the old behaviour instead. | # tag to YES if you prefer the old behavior instead. | |||
# | ||||
# Note that setting this tag to YES also means that rational rose comments are | ||||
# not recognized any more. | ||||
# The default value is: NO. | ||||
MULTILINE_CPP_IS_BRIEF = NO | MULTILINE_CPP_IS_BRIEF = NO | |||
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the | |||
# member inherits the documentation from any documented member that it | # documentation from any documented member that it re-implements. | |||
# re-implements. | # The default value is: YES. | |||
INHERIT_DOCS = YES | INHERIT_DOCS = YES | |||
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new | |||
# a new page for each member. If set to NO, the documentation of a member will | # page for each member. If set to NO, the documentation of a member will be part | |||
# be part of the file/class/namespace that contains it. | # of the file/class/namespace that contains it. | |||
# The default value is: NO. | ||||
SEPARATE_MEMBER_PAGES = NO | SEPARATE_MEMBER_PAGES = NO | |||
# The TAB_SIZE tag can be used to set the number of spaces in a tab. | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen | |||
# Doxygen uses this value to replace tabs by spaces in code fragments. | # uses this value to replace tabs by spaces in code fragments. | |||
# Minimum value: 1, maximum value: 16, default value: 4. | ||||
TAB_SIZE = 8 | TAB_SIZE = 8 | |||
# 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 act as commands in | |||
# as commands in the documentation. An alias has the form "name=value". | # the documentation. An alias has the form: | |||
# For example adding "sideeffect=\par Side Effects:\n" will allow you to | # name=value | |||
# put the command \sideeffect (or @sideeffect) in the documentation, which | # For example adding | |||
# will result in a user-defined paragraph with heading "Side Effects:". | # "sideeffect=@par Side Effects:\n" | |||
# You can put \n's in the value part of an alias to insert newlines. | # will allow you to put the command \sideeffect (or @sideeffect) in the | |||
# documentation, which will result in a user-defined paragraph with heading | ||||
# "Side Effects:". You can put \n's in the value part of an alias to insert | ||||
# newlines. | ||||
ALIASES = | ALIASES = | |||
# This tag can be used to specify a number of word-keyword mappings (TCL only). | # This tag can be used to specify a number of word-keyword mappings (TCL only). | |||
# A mapping has the form "name=value". For example adding | # A mapping has the form "name=value". For example adding "class=itcl::class" | |||
# "class=itcl::class" will allow you to use the command class in the | # will allow you to use the command class in the itcl::class meaning. | |||
# itcl::class meaning. | ||||
TCL_SUBST = | 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 | |||
# sources only. Doxygen will then generate output that is more tailored for C. | # only. Doxygen will then generate output that is more tailored for C. For | |||
# For instance, some of the names that are used will be different. The list | # instance, some of the names that are used will be different. The list of all | |||
# of all members will be omitted, etc. | # members will be omitted, etc. | |||
# The default value is: NO. | ||||
OPTIMIZE_OUTPUT_FOR_C = NO | OPTIMIZE_OUTPUT_FOR_C = NO | |||
# 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 or | |||
# sources only. Doxygen will then generate output that is more tailored for | # Python sources only. Doxygen will then generate output that is more tailored | |||
# Java. For instance, namespaces will be presented as packages, qualified | # for that language. For instance, namespaces will be presented as packages, | |||
# scopes will look different, etc. | # qualified scopes will look different, etc. | |||
# The default value is: NO. | ||||
OPTIMIZE_OUTPUT_JAVA = NO | OPTIMIZE_OUTPUT_JAVA = NO | |||
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | |||
# sources only. Doxygen will then generate output that is more tailored for | # sources. Doxygen will then generate output that is tailored for Fortran. | |||
# Fortran. | # The default value is: NO. | |||
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. | # The default value is: NO. | |||
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 extension | # parses. With this tag you can assign which parser to use for a given | |||
. | # extension. Doxygen has a built-in mapping, but you can override or extend it | |||
# Doxygen has a built-in mapping, but you can override or extend it using this | # using this tag. The format is ext=language, where ext is a file extension, and | |||
# tag. The format is ext=language, where ext is a file extension, and language | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, | |||
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: | |||
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: | |||
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C | # Fortran. In the later case the parser tries to guess whether the code is fixed | |||
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions | # or free formatted code, this is the default for Fortran type files), VHDL. For | |||
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen | # instance to make doxygen treat .inc files as Fortran files (default is PHP), | |||
. | # and .f files as C (default is Fortran), use: inc=Fortran f=C. | |||
# | ||||
# Note: For files without extension you can use no_extension as a placeholder. | ||||
# | ||||
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise | ||||
# the files are not read by doxygen. | ||||
EXTENSION_MAPPING = | EXTENSION_MAPPING = | |||
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments | |||
# comments according to the Markdown format, which allows for more readable | # according to the Markdown format, which allows for more readable | |||
# documentation. See http://daringfireball.net/projects/markdown/ for details. | # documentation. See http://daringfireball.net/projects/markdown/ for details. | |||
# The output of markdown processing is further processed by doxygen, so you | # The output of markdown processing is further processed by doxygen, so you can | |||
# can mix doxygen, HTML, and XML commands with Markdown formatting. | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in | |||
# Disable only in case of backward compatibilities issues. | # case of backward compatibilities issues. | |||
# The default value is: YES. | ||||
MARKDOWN_SUPPORT = YES | MARKDOWN_SUPPORT = YES | |||
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up | ||||
# to that level are automatically included in the table of contents, even if | ||||
# they do not have an id attribute. | ||||
# Note: This feature currently applies only to Markdown headings. | ||||
# Minimum value: 0, maximum value: 99, default value: 0. | ||||
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. | ||||
TOC_INCLUDE_HEADINGS = 0 | ||||
# When enabled doxygen tries to link words that correspond to documented | ||||
# classes, or namespaces to their corresponding documentation. Such a link can | ||||
# be prevented in individual cases by putting a % sign in front of the word or | ||||
# globally by setting AUTOLINK_SUPPORT to NO. | ||||
# The default value is: YES. | ||||
AUTOLINK_SUPPORT = YES | ||||
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | |||
# to include (a tag file for) the STL sources as input, then you should | # to include (a tag file for) the STL sources as input, then you should set this | |||
# set this tag to YES in order to let doxygen match functions declarations and | # 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); | |||
# func(std::string) {}). This also makes the inheritance and collaboration | # versus func(std::string) {}). This also make the inheritance and collaboration | |||
# diagrams that involve STL classes more complete and accurate. | # diagrams that involve STL classes more complete and accurate. | |||
# The default value is: NO. | ||||
BUILTIN_STL_SUPPORT = NO | BUILTIN_STL_SUPPORT = NO | |||
# If you use Microsoft's C++/CLI language, you should set this option to YES to | # If you use Microsoft's C++/CLI language, you should set this option to YES to | |||
# enable parsing support. | # enable parsing support. | |||
# The default value is: NO. | ||||
CPP_CLI_SUPPORT = NO | CPP_CLI_SUPPORT = NO | |||
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: | |||
# Doxygen will parse them like normal C++ but will assume all classes use public | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen | |||
# instead of private inheritance when no explicit protection keyword is present. | # will parse them like normal C++ but will assume all classes use public instead | |||
# of private inheritance when no explicit protection keyword is present. | ||||
# The default value is: NO. | ||||
SIP_SUPPORT = NO | SIP_SUPPORT = NO | |||
# For Microsoft's IDL there are propget and propput attributes to indicate gette | # For Microsoft's IDL there are propget and propput attributes to indicate | |||
r | # getter and setter methods for a property. Setting this option to YES will make | |||
# and setter methods for a property. Setting this option to YES (the default) | # doxygen to replace the get and set methods by a property in the documentation. | |||
# will make doxygen replace the get and set methods by a property in the | # This will only work if the methods are indeed getting or setting a simple | |||
# documentation. This will only work if the methods are indeed getting or | # type. If this is not the case, or you want to show the methods anyway, you | |||
# setting a simple type. If this is not the case, or you want to show the | # should set this option to NO. | |||
# methods anyway, you should set this option to NO. | # The default value is: YES. | |||
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 default | # member in the group (if any) for the other members of the group. By default | |||
# all members of a group must be documented explicitly. | # all members of a group must be documented explicitly. | |||
# The default value is: NO. | ||||
DISTRIBUTE_GROUP_DOC = NO | DISTRIBUTE_GROUP_DOC = NO | |||
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of | # If one adds a struct or class to a group and this option is enabled, then also | |||
# the same type (for instance a group of public functions) to be put as a | # any nested class or struct is added to the same group. By default this option | |||
# subgroup of that type (e.g. under the Public Functions section). Set it to | # is disabled and one has to add nested compounds explicitly via \ingroup. | |||
# NO to prevent subgrouping. Alternatively, this can be done per class using | # The default value is: NO. | |||
# the \nosubgrouping command. | ||||
GROUP_NESTED_COMPOUNDS = NO | ||||
# Set the SUBGROUPING tag to YES to allow class member groups of the same type | ||||
# (for instance a group of public functions) to be put as a subgroup of that | ||||
# type (e.g. under the Public Functions section). Set it to NO to prevent | ||||
# subgrouping. Alternatively, this can be done per class using the | ||||
# \nosubgrouping command. | ||||
# The default value is: YES. | ||||
SUBGROUPING = YES | SUBGROUPING = YES | |||
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions | |||
# unions are shown inside the group in which they are included (e.g. using | # are shown inside the group in which they are included (e.g. using \ingroup) | |||
# @ingroup) instead of on a separate page (for HTML and Man pages) or | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX | |||
# section (for LaTeX and RTF). | # and RTF). | |||
# | ||||
# Note that this feature does not work in combination with | ||||
# SEPARATE_MEMBER_PAGES. | ||||
# The default value is: NO. | ||||
INLINE_GROUPED_CLASSES = NO | INLINE_GROUPED_CLASSES = NO | |||
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions | |||
# unions with only public data fields will be shown inline in the documentation | # with only public data fields or simple typedef fields will be shown inline in | |||
# of the scope in which they are defined (i.e. file, namespace, or group | # the documentation of the scope in which they are defined (i.e. file, | |||
# documentation), provided this scope is documented. If set to NO (the default), | # namespace, or group documentation), provided this scope is documented. If set | |||
# structs, classes, and unions are shown on a separate page (for HTML and Man | # to NO, structs, classes, and unions are shown on a separate page (for HTML and | |||
# pages) or section (for LaTeX and RTF). | # Man pages) or section (for LaTeX and RTF). | |||
# The default value is: NO. | ||||
INLINE_SIMPLE_STRUCTS = NO | INLINE_SIMPLE_STRUCTS = NO | |||
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or | |||
# is documented as struct, union, or enum with the name of the typedef. So | # enum is documented as struct, union, or enum with the name of the typedef. So | |||
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | |||
# with name TypeT. When disabled the typedef will appear as a member of a file, | # with name TypeT. When disabled the typedef will appear as a member of a file, | |||
# namespace, or class. And the struct will be named TypeS. This can typically | # namespace, or class. And the struct will be named TypeS. This can typically be | |||
# be useful for C code in case the coding convention dictates that all compound | # useful for C code in case the coding convention dictates that all compound | |||
# types are typedef'ed and only the typedef is referenced, never the tag name. | # types are typedef'ed and only the typedef is referenced, never the tag name. | |||
# The default value is: NO. | ||||
TYPEDEF_HIDES_STRUCT = NO | TYPEDEF_HIDES_STRUCT = NO | |||
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This | |||
# determine which symbols to keep in memory and which to flush to disk. | # cache is used to resolve symbols given their name and scope. Since this can be | |||
# When the cache is full, less often used symbols will be written to disk. | # an expensive process and often the same symbol appears multiple times in the | |||
# For small to medium size projects (<1000 input files) the default value is | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small | |||
# probably good enough. For larger projects a too small cache size can cause | # doxygen will become slower. If the cache is too large, memory is wasted. The | |||
# doxygen to be busy swapping symbols to and from disk most of the time | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range | |||
# causing a significant performance penalty. | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 | |||
# If the system has enough physical memory increasing the cache will improve the | # symbols. At the end of a run doxygen will report the cache usage and suggest | |||
# performance by keeping more symbols in memory. Note that the value works on | # the optimal cache size from a speed point of view. | |||
# a logarithmic scale so increasing the size by one will roughly double the | # Minimum value: 0, maximum value: 9, default value: 0. | |||
# memory usage. The cache size is given by this formula: | ||||
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, | ||||
# corresponding to a cache size of 2^16 = 65536 symbols. | ||||
SYMBOL_CACHE_SIZE = 0 | ||||
# 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 the | ||||
# 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 slower. | ||||
# If the cache is too large, memory is wasted. The cache size is given by this | ||||
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, | ||||
# corresponding to a cache size of 2^16 = 65536 symbols. | ||||
LOOKUP_CACHE_SIZE = 0 | 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 | |||
# Private class members and static file members will be hidden unless | # class members and static file members will be hidden unless the | |||
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. | |||
# Note: This will also disable the warnings about undocumented members that are | ||||
# normally produced when WARNINGS is set to YES. | ||||
# The default value is: NO. | ||||
EXTRACT_ALL = NO | EXTRACT_ALL = NO | |||
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will | |||
# will be included in the documentation. | # be included in the documentation. | |||
# The default value is: NO. | ||||
EXTRACT_PRIVATE = NO | EXTRACT_PRIVATE = NO | |||
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal | |||
scope will be included in the documentation. | # scope will be included in the documentation. | |||
# The default value is: NO. | ||||
EXTRACT_PACKAGE = NO | 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 | |||
# will be included in the documentation. | # included in the documentation. | |||
# The default value is: NO. | ||||
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 | |||
# defined locally in source files will be included in the documentation. | # locally in source files will be included in the documentation. If set to NO, | |||
# If set to NO only classes defined in header files are included. | # only classes defined in header files are included. Does not have any effect | |||
# for Java sources. | ||||
# The default value is: YES. | ||||
EXTRACT_LOCAL_CLASSES = YES | EXTRACT_LOCAL_CLASSES = YES | |||
# This flag is only useful for Objective-C code. When set to YES local | # This flag is only useful for Objective-C code. If set to YES, local methods, | |||
# methods, which are defined in the implementation section but not in | # which are defined in the implementation section but not in the interface are | |||
# the interface are included in the documentation. | # included in the documentation. If set to NO, only methods in the interface are | |||
# If set to NO (the default) only methods in the interface are included. | # included. | |||
# The default value is: NO. | ||||
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 | |||
# name of the file that contains the anonymous namespace. By default | # the file that contains the anonymous namespace. By default anonymous namespace | |||
# anonymous namespaces are hidden. | # are hidden. | |||
# The default value is: NO. | ||||
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 inside documented classes or files. If set to NO these | |||
# If set to NO (the default) these members will be included in the | # members will be included in the various overviews, but no documentation | |||
# various overviews, but no documentation section is generated. | # section is generated. This option has no effect if EXTRACT_ALL is enabled. | |||
# This option has no effect if EXTRACT_ALL is enabled. | # The default value is: NO. | |||
HIDE_UNDOC_MEMBERS = NO | HIDE_UNDOC_MEMBERS = NO | |||
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all | |||
# undocumented classes that are normally visible in the class hierarchy. | # undocumented classes that are normally visible in the class hierarchy. If set | |||
# If set to NO (the default) these classes will be included in the various | # to NO, these classes will be included in the various overviews. This option | |||
# overviews. This option has no effect if EXTRACT_ALL is enabled. | # has no effect if EXTRACT_ALL is enabled. | |||
# The default value is: NO. | ||||
HIDE_UNDOC_CLASSES = NO | HIDE_UNDOC_CLASSES = NO | |||
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend | |||
# friend (class|struct|union) declarations. | # (class|struct|union) declarations. If set to NO, these declarations will be | |||
# If set to NO (the default) these declarations will be included in the | # included in the documentation. | |||
# documentation. | # The default value is: NO. | |||
HIDE_FRIEND_COMPOUNDS = NO | HIDE_FRIEND_COMPOUNDS = NO | |||
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any | |||
# documentation blocks found inside the body of a function. | # documentation blocks found inside the body of a function. If set to NO, these | |||
# If set to NO (the default) these blocks will be appended to the | # blocks will be appended to the function's detailed documentation block. | |||
# function's detailed documentation block. | # The default value is: NO. | |||
HIDE_IN_BODY_DOCS = NO | HIDE_IN_BODY_DOCS = NO | |||
# The INTERNAL_DOCS tag determines if documentation | # The INTERNAL_DOCS tag determines if documentation that is typed after a | |||
# that is typed after a \internal command is included. If the tag is set | # \internal command is included. If the tag is set to NO then the documentation | |||
# to NO (the default) then the documentation will be excluded. | # will be excluded. Set it to YES to include the internal documentation. | |||
# Set it to YES to include the internal documentation. | # The default value is: NO. | |||
INTERNAL_DOCS = NO | INTERNAL_DOCS = NO | |||
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file | |||
# file names in lower-case letters. If set to YES upper-case letters are also | # names in lower-case letters. If set to YES, upper-case letters are also | |||
# allowed. This is useful if you have classes or files whose names only differ | # allowed. This is useful if you have classes or files whose names only differ | |||
# in case and if your file system supports case sensitive file names. Windows | # in case and if your file system supports case sensitive file names. Windows | |||
# and Mac users are advised to set this option to NO. | # and Mac users are advised to set this option to NO. | |||
# The default value is: system dependent. | ||||
CASE_SENSE_NAMES = YES | CASE_SENSE_NAMES = YES | |||
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with | |||
# will show members with their full class and namespace scopes in the | # their full class and namespace scopes in the documentation. If set to YES, the | |||
# documentation. If set to YES the scope will be hidden. | # scope will be hidden. | |||
# The default value is: NO. | ||||
HIDE_SCOPE_NAMES = NO | HIDE_SCOPE_NAMES = NO | |||
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will | |||
# will put a list of the files that are included by a file in the documentation | # append additional text to a page's title, such as Class Reference. If set to | |||
# of that file. | # YES the compound reference will be hidden. | |||
# The default value is: NO. | ||||
HIDE_COMPOUND_REFERENCE= NO | ||||
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of | ||||
# the files that are included by a file in the documentation of that file. | ||||
# The default value is: YES. | ||||
SHOW_INCLUDE_FILES = YES | SHOW_INCLUDE_FILES = YES | |||
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each | |||
# will list include files with double quotes in the documentation | # grouped member an include statement to the documentation, telling the reader | |||
# rather than with sharp brackets. | # which file to include in order to use the member. | |||
# The default value is: NO. | ||||
SHOW_GROUPED_MEMB_INC = NO | ||||
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include | ||||
# files with double quotes in the documentation rather than with sharp brackets. | ||||
# The default value is: NO. | ||||
FORCE_LOCAL_INCLUDES = NO | FORCE_LOCAL_INCLUDES = NO | |||
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the | |||
# is inserted in the documentation for inline members. | # documentation for inline members. | |||
# The default value is: YES. | ||||
INLINE_INFO = YES | INLINE_INFO = YES | |||
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the | |||
# will sort the (detailed) documentation of file and class members | # (detailed) documentation of file and class members alphabetically by member | |||
# alphabetically by member name. If set to NO the members will appear in | # name. If set to NO, the members will appear in declaration order. | |||
# declaration order. | # The default value is: YES. | |||
SORT_MEMBER_DOCS = YES | SORT_MEMBER_DOCS = YES | |||
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief | |||
# brief documentation of file, namespace and class members alphabetically | # descriptions of file, namespace and class members alphabetically by member | |||
# by member name. If set to NO (the default) the members will appear in | # name. If set to NO, the members will appear in declaration order. Note that | |||
# declaration order. | # this will also influence the order of the classes in the class list. | |||
# The default value is: NO. | ||||
SORT_BRIEF_DOCS = NO | SORT_BRIEF_DOCS = NO | |||
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the | |||
# will sort the (brief and detailed) documentation of class members so that | # (brief and detailed) documentation of class members so that constructors and | |||
# constructors and destructors are listed first. If set to NO (the default) | # destructors are listed first. If set to NO the constructors will appear in the | |||
# the constructors will appear in the respective orders defined by | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. | |||
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief | |||
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO | # member documentation. | |||
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting | |||
# detailed member documentation. | ||||
# The default value is: NO. | ||||
SORT_MEMBERS_CTORS_1ST = NO | SORT_MEMBERS_CTORS_1ST = NO | |||
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy | |||
# hierarchy of group names into alphabetical order. If set to NO (the default) | # of group names into alphabetical order. If set to NO the group names will | |||
# the group names will appear in their defined order. | # appear in their defined order. | |||
# The default value is: NO. | ||||
SORT_GROUP_NAMES = NO | SORT_GROUP_NAMES = NO | |||
# 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 | |||
# sorted by fully-qualified names, including namespaces. If set to | # fully-qualified names, including namespaces. If set to NO, the class list will | |||
# NO (the default), the class list will be sorted only by class name, | # 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 | |||
# alphabetical list. | # list. | |||
# The default value is: NO. | ||||
SORT_BY_SCOPE_NAME = NO | SORT_BY_SCOPE_NAME = NO | |||
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper | |||
# do proper type resolution of all parameters of a function it will reject a | # type resolution of all parameters of a function it will reject a match between | |||
# match between the prototype and the implementation of a member function even | # the prototype and the implementation of a member function even if there is | |||
# if there is only one candidate or it is obvious which candidate to choose | # only one candidate or it is obvious which candidate to choose by doing a | |||
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still | |||
# will still accept a match between prototype and implementation in such cases. | # accept a match between prototype and implementation in such cases. | |||
# The default value is: NO. | ||||
STRICT_PROTO_MATCHING = NO | 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 | |||
# disable (NO) the todo list. This list is created by putting \todo | # list. This list is created by putting \todo commands in the documentation. | |||
# commands in the documentation. | # The default value is: YES. | |||
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 | |||
# disable (NO) the test list. This list is created by putting \test | # list. This list is created by putting \test commands in the documentation. | |||
# commands in the documentation. | # The default value is: YES. | |||
GENERATE_TESTLIST = YES | GENERATE_TESTLIST = YES | |||
# The GENERATE_BUGLIST tag can be used to enable (YES) or | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug | |||
# disable (NO) the bug list. This list is created by putting \bug | # list. This list is created by putting \bug commands in the documentation. | |||
# commands in the documentation. | # The default value is: YES. | |||
GENERATE_BUGLIST = YES | GENERATE_BUGLIST = YES | |||
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) | |||
# disable (NO) the deprecated list. This list is created by putting | # the deprecated list. This list is created by putting \deprecated commands in | |||
# \deprecated commands in the documentation. | # the documentation. | |||
# The default value is: YES. | ||||
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 | |||
# documentation sections, marked by \if sectionname ... \endif. | # sections, marked by \if <section_label> ... \endif and \cond <section_label> | |||
# ... \endcond blocks. | ||||
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 that the | |||
# the initial value of a variable or macro consists of for it to appear in | # initial value of a variable or macro / define can have for it to appear in the | |||
# the documentation. If the initializer consists of more lines than specified | # documentation. If the initializer consists of more lines than specified here | |||
# here it will be hidden. Use a value of 0 to hide initializers completely. | # it will be hidden. Use a value of 0 to hide initializers completely. The | |||
# The appearance of the initializer of individual variables and macros in the | # appearance of the value of individual variables and macros / defines can be | |||
# documentation can be controlled using \showinitializer or \hideinitializer | # controlled using \showinitializer or \hideinitializer command in the | |||
# command in the documentation regardless of this setting. | # documentation regardless of this setting. | |||
# Minimum value: 0, maximum value: 10000, default value: 30. | ||||
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 | |||
# at the bottom of the documentation of classes and structs. If set to YES the | # 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. | |||
# The default value is: YES. | ||||
SHOW_USED_FILES = YES | SHOW_USED_FILES = YES | |||
# 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 | |||
# This will remove the Files entry from the Quick Index and from the | # will remove the Files entry from the Quick Index and from the Folder Tree View | |||
# Folder Tree View (if specified). The default is YES. | # (if specified). | |||
# The default value 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 | |||
# Namespaces page. | # page. This will remove the Namespaces entry from the Quick Index and from the | |||
# This will remove the Namespaces entry from the Quick Index | # Folder Tree View (if specified). | |||
# and from the Folder Tree View (if specified). The default is YES. | # The default value is: YES. | |||
SHOW_NAMESPACES = YES | SHOW_NAMESPACES = YES | |||
# The FILE_VERSION_FILTER tag can be used to specify a program or script that | # The FILE_VERSION_FILTER tag can be used to specify a program or script that | |||
# doxygen should invoke to get the current version for each file (typically from | # doxygen should invoke to get the current version for each file (typically from | |||
# the version control system). Doxygen will invoke the program by executing (via | # 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 | |||
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided | |||
# provided by doxygen. Whatever the program writes to standard output | # by doxygen. Whatever the program writes to standard output is used as the file | |||
# is used as the file version. See the manual for examples. | # version. For an example see the documentation. | |||
FILE_VERSION_FILTER = | FILE_VERSION_FILTER = | |||
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed | |||
# by doxygen. The layout file controls the global structure of the generated | # by doxygen. The layout file controls the global structure of the generated | |||
# output files in an output format independent way. To create the layout file | # output files in an output format independent way. To create the layout file | |||
# that represents doxygen's defaults, run doxygen with the -l option. | # that represents doxygen's defaults, run doxygen with the -l option. You can | |||
# You can optionally specify a file name after the option, if omitted | # optionally specify a file name after the option, if omitted DoxygenLayout.xml | |||
# DoxygenLayout.xml will be used as the name of the layout file. | # will be used as the name of the layout file. | |||
# | ||||
# Note that if you run doxygen from a directory containing a file called | ||||
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE | ||||
# tag is left empty. | ||||
LAYOUT_FILE = | LAYOUT_FILE = | |||
# The CITE_BIB_FILES tag can be used to specify one or more bib files | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing | |||
# containing the references data. This must be a list of .bib files. The | # the reference definitions. This must be a list of .bib files. The .bib | |||
# .bib extension is automatically appended if omitted. Using this command | # extension is automatically appended if omitted. This requires the bibtex tool | |||
# requires the bibtex tool to be installed. See also | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. | |||
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style | # For LaTeX the style of the bibliography can be controlled using | |||
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the | |||
# feature you need bibtex and perl available in the search path. | # search path. See also \cite for info how to create references. | |||
CITE_BIB_FILES = | 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 to | |||
# by doxygen. Possible values are YES and NO. If left blank NO is used. | # standard output by doxygen. If QUIET is set to YES this implies that the | |||
# messages are off. | ||||
# The default value is: NO. | ||||
QUIET = NO | QUIET = NO | |||
# The WARNINGS tag can be used to turn on/off the warning messages that are | # The WARNINGS tag can be used to turn on/off the warning messages that are | |||
# generated by doxygen. Possible values are YES and NO. If left blank | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES | |||
# NO is used. | # this implies that the warnings are on. | |||
# | ||||
# Tip: Turn warnings on while writing the documentation. | ||||
# The default value is: YES. | ||||
WARNINGS = YES | WARNINGS = YES | |||
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate | |||
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag | |||
# automatically be disabled. | # will automatically be disabled. | |||
# The default value is: YES. | ||||
WARN_IF_UNDOCUMENTED = YES | WARN_IF_UNDOCUMENTED = YES | |||
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for | # If the WARN_IF_DOC_ERROR tag 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 | |||
# parameters in a documented function, or documenting parameters that | # in a documented function, or documenting parameters that don't exist or using | |||
# don't exist or using markup commands wrongly. | # markup commands wrongly. | |||
# The default value is: YES. | ||||
WARN_IF_DOC_ERROR = YES | WARN_IF_DOC_ERROR = YES | |||
# The WARN_NO_PARAMDOC option can be enabled to get warnings for | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that | |||
# functions that are documented, but have no documentation for their parameters | # are documented, but have no documentation for their parameters or return | |||
# or return value. If set to NO (the default) doxygen will only warn about | # value. If set to NO, doxygen will only warn about wrong or incomplete | |||
# wrong or incomplete parameter documentation, but not about the absence of | # parameter documentation, but not about the absence of documentation. | |||
# documentation. | # The default value is: NO. | |||
WARN_NO_PARAMDOC = NO | WARN_NO_PARAMDOC = NO | |||
# The WARN_FORMAT tag determines the format of the warning messages that | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when | |||
# doxygen can produce. The string should contain the $file, $line, and $text | # a warning is encountered. | |||
# tags, which will be replaced by the file and line number from which the | # The default value is: NO. | |||
# warning originated and the warning text. Optionally the format may contain | ||||
# $version, which will be replaced by the version of the file (if it could | WARN_AS_ERROR = NO | |||
# be obtained via FILE_VERSION_FILTER) | ||||
# The WARN_FORMAT tag determines the format of the warning messages that doxygen | ||||
# can produce. The string should contain the $file, $line, and $text tags, which | ||||
# will be replaced by the file and line number from which the warning originated | ||||
# and the warning text. Optionally the format may contain $version, which will | ||||
# be replaced by the version of the file (if it could be obtained via | ||||
# FILE_VERSION_FILTER) | ||||
# The default value is: $file:$line: $text. | ||||
WARN_FORMAT = "$file:$line: $text" | WARN_FORMAT = "$file:$line: $text" | |||
# The WARN_LOGFILE tag can be used to specify a file to which warning | # The WARN_LOGFILE tag can be used to specify a file to which warning and error | |||
# and error messages should be written. If left blank the output is written | # messages should be written. If left blank the output is written to standard | |||
# to stderr. | # error (stderr). | |||
WARN_LOGFILE = | WARN_LOGFILE = | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# configuration options related to the input files | # Configuration options related to the input files | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# The INPUT tag can be used to specify the files and/or directories that contain | # The INPUT tag is used to specify the files and/or directories that contain | |||
# documented source files. You may enter file names like "myfile.cpp" or | # documented source files. You may enter file names like myfile.cpp or | |||
# directories like "/usr/src/myproject". Separate the files or directories | # directories like /usr/src/myproject. Separate the files or directories with | |||
# with spaces. | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING | |||
# Note: If this tag is empty the current directory is searched. | ||||
INPUT = help/doxygen \ | INPUT = help/doxygen \ | |||
src/osipparser2 \ | src/osipparser2 \ | |||
src/osip2 \ | src/osip2 \ | |||
include/osipparser2 \ | include/osipparser2 \ | |||
include/osip2 \ | include/osip2 | |||
# This tag can be used to specify the character encoding of the source files | # This tag can be used to specify the character encoding of the source files | |||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses | |||
# also the default input encoding. Doxygen uses libiconv (or the iconv built | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv | |||
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | # documentation (see: http://www.gnu.org/software/libiconv) for the list of | |||
# the list of possible encodings. | # possible encodings. | |||
# The default value is: UTF-8. | ||||
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 patterns (like *.cpp and | |||
# and *.h) to filter out the source-files in the directories. If left | # *.h) to filter out the source-files in the directories. | |||
# blank the following patterns are tested: | # | |||
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh | # Note that for custom extensions or not directly supported extensions you also | |||
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | |||
# *.f90 *.f *.for *.vhd *.vhdl | # read by doxygen. | |||
# | ||||
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | ||||
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | ||||
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, | ||||
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, | ||||
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. | ||||
FILE_PATTERNS = *.h \ | FILE_PATTERNS = *.h \ | |||
*.c \ | *.c \ | |||
*.dox | *.dox | |||
# The RECURSIVE tag can be used to turn specify whether or not subdirectories | # The RECURSIVE tag can be used to specify whether or not subdirectories should | |||
# should be searched for input files as well. Possible values are YES and NO. | # be searched for input files as well. | |||
# If left blank NO is used. | # The default value is: NO. | |||
RECURSIVE = YES | RECURSIVE = YES | |||
# The EXCLUDE tag can be used to specify files and/or directories that should be | # The EXCLUDE tag can be used to specify files and/or directories that should 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 | # Note that relative paths are relative to the directory from which doxygen is | |||
# run. | # run. | |||
EXCLUDE = | EXCLUDE = | |||
# The EXCLUDE_SYMLINKS tag can be used to 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 file system feature) are excluded | # directories that are symbolic links (a Unix file system feature) are excluded | |||
# from the input. | # from the input. | |||
# The default value is: NO. | ||||
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. | |||
# against the file with absolute path, so to exclude all test directories | # | |||
# for example use the pattern */test/* | # Note that the wildcards are matched against the file with absolute path, so to | |||
# exclude all test directories for example use the pattern */test/* | ||||
EXCLUDE_PATTERNS = | EXCLUDE_PATTERNS = | |||
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | |||
# (namespaces, classes, functions, etc.) that should be excluded from the | # (namespaces, classes, functions, etc.) that should be excluded from the | |||
# output. The symbol name can be a fully qualified name, a word, or if the | # output. The symbol name can be a fully qualified name, a word, or if the | |||
# wildcard * is used, a substring. Examples: ANamespace, AClass, | # wildcard * is used, a substring. Examples: ANamespace, AClass, | |||
# AClass::ANamespace, ANamespace::*Test | # AClass::ANamespace, ANamespace::*Test | |||
# | ||||
# Note that the wildcards are matched against the file with absolute path, so to | ||||
# exclude all test directories use the pattern */test/* | ||||
EXCLUDE_SYMBOLS = | EXCLUDE_SYMBOLS = | |||
# The EXAMPLE_PATH tag can be used to specify one or more files or | # The EXAMPLE_PATH tag can be used to specify one or more files or directories | |||
# directories that contain example code fragments that are included (see | # that contain example code fragments that are included (see the \include | |||
# the \include command). | # command). | |||
EXAMPLE_PATH = . | EXAMPLE_PATH = . | |||
# If the value of the EXAMPLE_PATH tag contains directories, you can use the | # If the value of the EXAMPLE_PATH tag contains directories, you can use the | |||
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and | |||
# and *.h) to filter out the source-files in the directories. If left | # *.h) to filter out the source-files in the directories. If left blank all | |||
# blank all files are included. | # files are included. | |||
EXAMPLE_PATTERNS = | EXAMPLE_PATTERNS = | |||
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | |||
# searched for input files to be used with the \include or \dontinclude | # searched for input files to be used with the \include or \dontinclude commands | |||
# commands irrespective of the value of the RECURSIVE tag. | # irrespective of the value of the RECURSIVE tag. | |||
# Possible values are YES and NO. If left blank NO is used. | # The default value is: NO. | |||
EXAMPLE_RECURSIVE = NO | EXAMPLE_RECURSIVE = NO | |||
# The IMAGE_PATH tag can be used to specify one or more files or | # The IMAGE_PATH tag can be used to specify one or more files or directories | |||
# directories that contain image that are included in the documentation (see | # that contain images that are to be included in the documentation (see the | |||
# the \image command). | # \image command). | |||
IMAGE_PATH = | IMAGE_PATH = | |||
# The INPUT_FILTER tag can be used to specify a program that doxygen should | # The INPUT_FILTER tag can be used to specify a program that doxygen should | |||
# invoke to filter for each input file. Doxygen will invoke the filter program | # invoke to filter for each input file. Doxygen will invoke the filter program | |||
# by executing (via popen()) the command <filter> <input-file>, where <filter> | # by executing (via popen()) the command: | |||
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an | # | |||
# input file. Doxygen will then use the output that the filter program writes | # <filter> <input-file> | |||
# to standard output. | # | |||
# If FILTER_PATTERNS is specified, this tag will be | # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the | |||
# ignored. | # name of an input file. Doxygen will then use the output that the filter | |||
# program writes to standard output. If FILTER_PATTERNS is specified, this tag | ||||
# will be ignored. | ||||
# | ||||
# Note that the filter must not add or remove lines; it is applied before the | ||||
# code is scanned, but not when the output code is generated. If lines are added | ||||
# or removed, the anchors will not be placed correctly. | ||||
# | ||||
# Note that for custom extensions or not directly supported extensions you also | ||||
# need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||||
# properly processed by doxygen. | ||||
INPUT_FILTER = | INPUT_FILTER = | |||
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | |||
# 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. The filters are a list of the form: pattern=filter | |||
# filter if there is a match. | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how | |||
# The filters are a list of the form: | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the | |||
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | # patterns match the file name, INPUT_FILTER is applied. | |||
# info on how filters are used. If FILTER_PATTERNS is empty or if | # | |||
# non of the patterns match the file name, INPUT_FILTER is applied. | # Note that for custom extensions or not directly supported extensions you also | |||
# need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||||
# properly processed by doxygen. | ||||
FILTER_PATTERNS = | FILTER_PATTERNS = | |||
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | |||
# INPUT_FILTER) will be used to filter the input files when producing source | # INPUT_FILTER) will also be used to filter the input files that are used for | |||
# files to browse (i.e. when SOURCE_BROWSER is set to YES). | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). | |||
# The default value is: NO. | ||||
FILTER_SOURCE_FILES = NO | FILTER_SOURCE_FILES = NO | |||
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | # 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) | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and | |||
# and it is also possible to disable source filtering for a specific pattern | # it is also possible to disable source filtering for a specific pattern using | |||
# using *.ext= (so without naming a filter). This option only has effect when | # *.ext= (so without naming a filter). | |||
# FILTER_SOURCE_FILES is enabled. | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. | |||
FILTER_SOURCE_PATTERNS = | FILTER_SOURCE_PATTERNS = | |||
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that | ||||
# is part of the input, its contents will be placed on the main page | ||||
# (index.html). This can be useful if you have a project on for instance GitHub | ||||
# and want to reuse the introduction page also for the doxygen output. | ||||
USE_MDFILE_AS_MAINPAGE = | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# 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 | |||
# be generated. Documented entities will be cross-referenced with these sources. | # generated. Documented entities will be cross-referenced with these sources. | |||
# Note: To get rid of all source code in the generated output, make sure also | # | |||
# VERBATIM_HEADERS is set to NO. | # Note: To get rid of all source code in the generated output, make sure that | |||
# also VERBATIM_HEADERS is set to NO. | ||||
# The default value is: NO. | ||||
SOURCE_BROWSER = NO | SOURCE_BROWSER = NO | |||
# Setting the INLINE_SOURCES tag to YES will include the body | # Setting the INLINE_SOURCES tag to YES will include the body of functions, | |||
# of functions and classes directly in the documentation. | # classes and enums directly into the documentation. | |||
# The default value is: NO. | ||||
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 will instruct doxygen to hide any | |||
# doxygen to hide any special comment blocks from generated source code | # special comment blocks from generated source code fragments. Normal C, C++ and | |||
# fragments. Normal C, C++ and Fortran comments will always remain visible. | # Fortran comments will always remain visible. | |||
# The default value is: YES. | ||||
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 | |||
# then for each documented function all documented | # function all documented functions referencing it will be listed. | |||
# functions referencing it will be listed. | # The default value is: NO. | |||
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 then for each documented function | |||
# then for each documented function all documented entities | # all documented entities called/used by that function will be listed. | |||
# called/used by that function will be listed. | # The default value is: NO. | |||
REFERENCES_RELATION = YES | REFERENCES_RELATION = YES | |||
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set | |||
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | # to YES then the hyperlinks from functions in REFERENCES_RELATION and | |||
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will | |||
# link to the source code. | # link to the documentation. | |||
# Otherwise they will link to the documentation. | # The default value is: YES. | |||
REFERENCES_LINK_SOURCE = YES | REFERENCES_LINK_SOURCE = YES | |||
# If the USE_HTAGS tag is set to YES then the references to source code | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the | |||
# will point to the HTML generated by the htags(1) tool instead of doxygen | # source code will show a tooltip with additional information such as prototype, | |||
# built-in source browser. The htags tool is part of GNU's global source | # brief description and links to the definition and documentation. Since this | |||
# tagging system (see http://www.gnu.org/software/global/global.html). You | # will make the HTML file larger and loading of large files a bit slower, you | |||
# will need version 4.8.6 or higher. | # can opt to disable this feature. | |||
# The default value is: YES. | ||||
# This tag requires that the tag SOURCE_BROWSER is set to YES. | ||||
SOURCE_TOOLTIPS = YES | ||||
# If the USE_HTAGS tag is set to YES then the references to source code will | ||||
# point to the HTML generated by the htags(1) tool instead of doxygen built-in | ||||
# source browser. The htags tool is part of GNU's global source tagging system | ||||
# (see http://www.gnu.org/software/global/global.html). You will need version | ||||
# 4.8.6 or higher. | ||||
# | ||||
# To use it do the following: | ||||
# - Install the latest version of global | ||||
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file | ||||
# - Make sure the INPUT points to the root of the source tree | ||||
# - Run doxygen as normal | ||||
# | ||||
# Doxygen will invoke htags (and that will in turn invoke gtags), so these | ||||
# tools must be available from the command line (i.e. in the search path). | ||||
# | ||||
# The result: instead of the source browser generated by doxygen, the links to | ||||
# source code will now point to the output of htags. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag SOURCE_BROWSER is set to YES. | ||||
USE_HTAGS = NO | USE_HTAGS = NO | |||
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a | |||
# will generate a verbatim copy of the header file for each class for | # verbatim copy of the header file for each class for which an include is | |||
# which an include is specified. Set to NO to disable this. | # specified. Set to NO to disable this. | |||
# See also: Section \class. | ||||
# The default value is: YES. | ||||
VERBATIM_HEADERS = YES | VERBATIM_HEADERS = YES | |||
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the | ||||
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the | ||||
# cost of reduced performance. This can be particularly helpful with template | ||||
# rich C++ code for which doxygen's built-in parser lacks the necessary type | ||||
# information. | ||||
# Note: The availability of this option depends on whether or not doxygen was | ||||
# generated with the -Duse-libclang=ON option for CMake. | ||||
# The default value is: NO. | ||||
CLANG_ASSISTED_PARSING = NO | ||||
# If clang assisted parsing is enabled you can provide the compiler with command | ||||
# line options that you would normally use when invoking the compiler. Note that | ||||
# the include paths will already be set by doxygen for the files and directories | ||||
# specified with INPUT and INCLUDE_PATH. | ||||
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | ||||
CLANG_OPTIONS = | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# configuration options related to the alphabetical class index | # Configuration options related to the alphabetical class index | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all | |||
# of all compounds will be generated. Enable this if the project | # compounds will be generated. Enable this if the project contains a lot of | |||
# contains a lot of classes, structs, unions or interfaces. | # classes, structs, unions or interfaces. | |||
# The default value is: YES. | ||||
ALPHABETICAL_INDEX = NO | ALPHABETICAL_INDEX = NO | |||
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in | |||
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | # which the alphabetical index list will be split. | |||
# in which this list will be split (can be a number in the range [1..20]) | # Minimum value: 1, maximum value: 20, default value: 5. | |||
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | ||||
COLS_IN_ALPHA_INDEX = 5 | COLS_IN_ALPHA_INDEX = 5 | |||
# In case all classes in a project start with a common prefix, all | # In case all classes in a project start with a common prefix, all classes will | |||
# classes will be put under the same header in the alphabetical index. | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag | |||
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that | # can be used to specify a prefix (or a list of prefixes) that should be ignored | |||
# should be ignored while generating the index headers. | # while generating the index headers. | |||
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | ||||
IGNORE_PREFIX = | IGNORE_PREFIX = | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# configuration options related to the HTML output | # Configuration options related to the HTML output | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output | |||
# generate HTML output. | # The default value is: YES. | |||
GENERATE_HTML = YES | GENERATE_HTML = YES | |||
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a | |||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | |||
# put in front of it. If left blank `html' will be used as the default path. | # it. | |||
# The default directory is: html. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
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 | |||
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank | # generated HTML page (for example: .htm, .php, .asp). | |||
# doxygen will generate files with .html extension. | # The default value is: .html. | |||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
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 user-defined HTML header file for | |||
# each generated HTML page. If it is left blank doxygen will generate a | # each generated HTML page. If the tag is left blank doxygen will generate a | |||
# standard header. Note that when using a custom header you are responsible | # standard header. | |||
# for the proper inclusion of any scripts and style sheets that doxygen | # | |||
# needs, which is dependent on the configuration options used. | # To get valid HTML the header file that includes any scripts and style sheets | |||
# It is advised to generate a default header using "doxygen -w html | # that doxygen needs, which is dependent on the configuration options used (e.g. | |||
# header.html footer.html stylesheet.css YourConfigFile" and then modify | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a | |||
# that header. Note that the header is subject to change so you typically | # default header using | |||
# have to redo this when upgrading to a newer version of doxygen or when | # doxygen -w html new_header.html new_footer.html new_stylesheet.css | |||
# changing the value of configuration settings such as GENERATE_TREEVIEW! | # YourConfigFile | |||
# and then modify the file new_header.html. See also section "Doxygen usage" | ||||
# for information on how to generate the default header that doxygen normally | ||||
# uses. | ||||
# Note: The header is subject to change so you typically have to regenerate the | ||||
# default header when upgrading to a newer version of doxygen. For a description | ||||
# of the possible markers and block names see the documentation. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
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 user-defined HTML footer for each | |||
# each generated HTML page. If it is left blank doxygen will generate a | # generated HTML page. If the tag is left blank doxygen will generate a standard | |||
# standard footer. | # footer. See HTML_HEADER for more information on how to generate a default | |||
# footer and what special commands can be used inside the footer. See also | ||||
# section "Doxygen usage" for information on how to generate the default footer | ||||
# that doxygen normally uses. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
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 | |||
# style sheet that is used by each HTML page. It can be used to | # sheet that is used by each HTML page. It can be used to fine-tune the look of | |||
# fine-tune the look of the HTML output. If the tag is left blank doxygen | # the HTML output. If left blank doxygen will generate a default style sheet. | |||
# will generate a default style sheet. Note that doxygen will try to copy | # See also section "Doxygen usage" for information on how to generate the style | |||
# the style sheet file to the HTML output directory, so don't put your own | # sheet that doxygen normally uses. | |||
# style sheet in the HTML output directory as well, or it will be erased! | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as | |||
# it is more robust and this tag (HTML_STYLESHEET) will in the future become | ||||
# obsolete. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
HTML_STYLESHEET = | HTML_STYLESHEET = | |||
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined | ||||
# cascading style sheets that are 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 therefore more robust against future updates. | ||||
# Doxygen will copy the style sheet files to the output directory. | ||||
# Note: The order of the extra style sheet files is of importance (e.g. the last | ||||
# style sheet in the list overrules the setting of the previous ones in the | ||||
# list). For an example see the documentation. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
HTML_EXTRA_STYLESHEET = | ||||
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or | # 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. Note | # other source files which should be copied to the HTML output directory. Note | |||
# that these files will be copied to the base HTML output directory. Use the | # that these files will be copied to the base HTML output directory. Use the | |||
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these | |||
# files. In the HTML_STYLESHEET file, use the file name only. Also note that | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the | |||
# the files will be copied as-is; there are no commands or markers available. | # files will be copied as-is; there are no commands or markers available. | |||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
HTML_EXTRA_FILES = | 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 | |||
# Doxygen will adjust the colors in the style sheet and background images | # will adjust the colors in the style sheet and background images according to | |||
# according to this color. Hue is specified as an angle on a colorwheel, | # this color. Hue is specified as an angle on a colorwheel, see | |||
# see http://en.wikipedia.org/wiki/Hue for more information. | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value | |||
# For instance the value 0 represents red, 60 is yellow, 120 is green, | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 | |||
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. | # purple, and 360 is red again. | |||
# The allowed range is 0 to 359. | # Minimum value: 0, maximum value: 359, default value: 220. | |||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
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 | |||
# the colors in the HTML output. For a value of 0 the output will use | # in the HTML output. For a value of 0 the output will use grayscales only. A | |||
# grayscales only. A value of 255 will produce the most vivid colors. | # value of 255 will produce the most vivid colors. | |||
# Minimum value: 0, maximum value: 255, default value: 100. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
HTML_COLORSTYLE_SAT = 100 | HTML_COLORSTYLE_SAT = 100 | |||
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the | |||
# the luminance component of the colors in the HTML output. Values below | # luminance component of the colors in the HTML output. Values below 100 | |||
# 100 gradually make the output lighter, whereas values above 100 make | # gradually make the output lighter, whereas values above 100 make the output | |||
# the output darker. The value divided by 100 is the actual gamma applied, | # darker. The value divided by 100 is the actual gamma applied, so 80 represents | |||
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not | |||
# and 100 does not change the gamma. | # change the gamma. | |||
# Minimum value: 40, maximum value: 240, default value: 80. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
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 | |||
# this to NO can help when comparing the output of multiple runs. | # to YES can help to show when doxygen was last run and thus if the | |||
# documentation is up to date. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
HTML_TIMESTAMP = YES | HTML_TIMESTAMP = 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 the | # documentation will contain sections that can be hidden and shown after the | |||
# page has loaded. | # page has loaded. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
HTML_DYNAMIC_SECTIONS = NO | HTML_DYNAMIC_SECTIONS = NO | |||
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries | |||
# entries shown in the various tree structured indices initially; the user | # shown in the various tree structured indices initially; the user can expand | |||
# can expand and collapse entries dynamically later on. Doxygen will expand | # and collapse entries dynamically later on. Doxygen will expand the tree to | |||
# the tree to such a level that at most the specified number of entries are | # such a level that at most the specified number of entries are visible (unless | |||
# visible (unless a fully collapsed tree already exceeds this amount). | # a fully collapsed tree already exceeds this amount). So setting the number of | |||
# So setting the number of entries 1 will produce a full collapsed tree by | # entries 1 will produce a full collapsed tree by default. 0 is a special value | |||
# default. 0 is a special value representing an infinite number of entries | # representing an infinite number of entries and will result in a full expanded | |||
# and will result in a full expanded tree by default. | # tree by default. | |||
# Minimum value: 0, maximum value: 9999, default value: 100. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
HTML_INDEX_NUM_ENTRIES = 100 | 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 | |||
# will be generated that can be used as input for Apple's Xcode 3 | # generated that can be used as input for Apple's Xcode 3 integrated development | |||
# integrated development environment, introduced with OSX 10.5 (Leopard). | # environment (see: http://developer.apple.com/tools/xcode/), introduced with | |||
# To create a documentation set, doxygen will generate a Makefile in the | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a | |||
# HTML output directory. Running make will produce the docset in that | # Makefile in the HTML output directory. Running make will produce the docset in | |||
# directory and running "make install" will install the docset in | # that 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 | |||
# it at startup. | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | |||
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | ||||
# for more information. | # for more information. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
GENERATE_DOCSET = NO | GENERATE_DOCSET = NO | |||
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | # This tag determines the name of the docset feed. A documentation feed provides | |||
# feed. A documentation feed provides an umbrella under which multiple | # an umbrella under which multiple documentation sets from a single provider | |||
# documentation sets from a single provider (such as a company or product suite) | # (such as a company or product suite) can be grouped. | |||
# can be grouped. | # The default value is: Doxygen generated docs. | |||
# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||||
DOCSET_FEEDNAME = "Doxygen generated docs" | DOCSET_FEEDNAME = "Doxygen generated docs" | |||
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | # This tag specifies a string that should uniquely identify the documentation | |||
# should uniquely identify the documentation set bundle. This should be a | # set bundle. This should be a reverse domain-name style string, e.g. | |||
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. | |||
# will append .docset to the name. | # The default value is: org.doxygen.Project. | |||
# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||||
DOCSET_BUNDLE_ID = org.doxygen.Project | DOCSET_BUNDLE_ID = org.doxygen.Project | |||
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identif y | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify | |||
# the documentation publisher. This should be a reverse domain-name style | # the documentation publisher. This should be a reverse domain-name style | |||
# string, e.g. com.mycompany.MyDocSet.documentation. | # string, e.g. com.mycompany.MyDocSet.documentation. | |||
# The default value is: org.doxygen.Publisher. | ||||
# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||||
DOCSET_PUBLISHER_ID = org.doxygen.Publisher | DOCSET_PUBLISHER_ID = org.doxygen.Publisher | |||
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. | |||
# The default value is: Publisher. | ||||
# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||||
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 then doxygen generates three | |||
# will be generated that can be used as input for tools like the | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The | |||
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop | |||
# of the generated HTML documentation. | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on | |||
# Windows. | ||||
# | ||||
# The HTML Help Workshop contains a compiler that can convert all HTML output | ||||
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML | ||||
# files are now used as the Windows 98 help format, and will replace the old | ||||
# Windows help format (.hlp) on all Windows platforms in the future. Compressed | ||||
# HTML files also contain an index, a table of contents, and you can search for | ||||
# words in the documentation. The HTML workshop also contains a viewer for | ||||
# compressed HTML files. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
GENERATE_HTMLHELP = NO | GENERATE_HTMLHELP = NO | |||
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | # The CHM_FILE tag can be used to specify the file name of the resulting .chm | |||
# be used to specify the file name of the resulting .chm file. You | # file. You can add a path in front of the file if the result should not be | |||
# can add a path in front of the file if the result should not be | ||||
# written to the html output directory. | # written to the html output directory. | |||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||||
CHM_FILE = | CHM_FILE = | |||
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | # The HHC_LOCATION tag can be used to specify the location (absolute path | |||
# be used to specify the location (absolute path including file name) of | # including file name) of the HTML help compiler (hhc.exe). If non-empty, | |||
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run | # doxygen will try to run the HTML help compiler on the generated index.hhp. | |||
# the HTML help compiler on the generated index.hhp. | # The file has to be specified with full path. | |||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||||
HHC_LOCATION = | HHC_LOCATION = | |||
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | # The GENERATE_CHI flag controls if a separate .chi index file is generated | |||
# controls if a separate .chi index file is generated (YES) or that | # (YES) or that it should be included in the master .chm file (NO). | |||
# it should be included in the master .chm file (NO). | # The default value is: NO. | |||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||||
GENERATE_CHI = NO | GENERATE_CHI = NO | |||
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) | |||
# is used to encode HtmlHelp index (hhk), content (hhc) and project file | # and project file content. | |||
# content. | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | |||
CHM_INDEX_ENCODING = | CHM_INDEX_ENCODING = | |||
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | # The BINARY_TOC flag controls whether a binary table of contents is generated | |||
# controls whether a binary table of contents is generated (YES) or a | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it | |||
# normal table of contents (NO) in the .chm file. | # enables the Previous and Next buttons. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||||
BINARY_TOC = NO | BINARY_TOC = NO | |||
# The TOC_EXPAND flag can be set to YES to add extra items for group members | # The TOC_EXPAND flag can be set to YES to add extra items for group members to | |||
# to the contents of the HTML help documentation and to the tree view. | # the table of contents of the HTML help documentation and to the tree view. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||||
TOC_EXPAND = NO | TOC_EXPAND = NO | |||
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | |||
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that | |||
# that can be used as input for Qt's qhelpgenerator to generate a | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help | |||
# Qt Compressed Help (.qch) of the generated HTML documentation. | # (.qch) of the generated HTML documentation. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
GENERATE_QHP = NO | GENERATE_QHP = NO | |||
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify | |||
# be used to specify the file name of the resulting .qch file. | # the file name of the resulting .qch file. The path specified is relative to | |||
# The path specified is relative to the HTML output folder. | # the HTML output folder. | |||
# This tag requires that the tag GENERATE_QHP is set to YES. | ||||
QCH_FILE = | QCH_FILE = | |||
# The QHP_NAMESPACE tag specifies the namespace to use when generating | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help | |||
# Qt Help Project output. For more information please see | # Project output. For more information please see Qt Help Project / Namespace | |||
# http://doc.trolltech.com/qthelpproject.html#namespace | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). | |||
# The default value is: org.doxygen.Project. | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | ||||
QHP_NAMESPACE = org.doxygen.Project | QHP_NAMESPACE = org.doxygen.Project | |||
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt | |||
# Qt Help Project output. For more information please see | # Help Project output. For more information please see Qt Help Project / Virtual | |||
# http://doc.trolltech.com/qthelpproject.html#virtual-folders | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- | |||
# folders). | ||||
# The default value is: doc. | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | ||||
QHP_VIRTUAL_FOLDER = doc | QHP_VIRTUAL_FOLDER = doc | |||
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom | |||
# add. For more information please see | # filter to add. For more information please see Qt Help Project / Custom | |||
# http://doc.trolltech.com/qthelpproject.html#custom-filters | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- | |||
# filters). | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | ||||
QHP_CUST_FILTER_NAME = | QHP_CUST_FILTER_NAME = | |||
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the | |||
# custom filter to add. For more information please see | # custom filter to add. For more information please see Qt Help Project / Custom | |||
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- | |||
# Qt Help Project / Custom Filters</a>. | # filters). | |||
# This tag requires that the tag GENERATE_QHP is set to YES. | ||||
QHP_CUST_FILTER_ATTRS = | QHP_CUST_FILTER_ATTRS = | |||
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | |||
# project's | # project's filter section matches. Qt Help Project / Filter Attributes (see: | |||
# filter section matches. | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). | |||
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> | # This tag requires that the tag GENERATE_QHP is set to YES. | |||
# Qt Help Project / Filter Attributes</a>. | ||||
QHP_SECT_FILTER_ATTRS = | QHP_SECT_FILTER_ATTRS = | |||
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can | # The QHG_LOCATION tag can be used to specify the location of Qt's | |||
# be used to specify the location of Qt's qhelpgenerator. | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the | |||
# If non-empty doxygen will try to run qhelpgenerator on the generated | # generated .qhp file. | |||
# .qhp file. | # This tag requires that the tag GENERATE_QHP is set to YES. | |||
QHG_LOCATION = | QHG_LOCATION = | |||
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be | |||
# will be generated, which together with the HTML files, form an Eclipse help | # generated, together with the HTML files, they form an Eclipse help plugin. To | |||
# plugin. To install this plugin and make it available under the help contents | # install this plugin and make it available under the help contents menu in | |||
# menu in Eclipse, the contents of the directory containing the HTML and XML | # Eclipse, the contents of the directory containing the HTML and XML files needs | |||
# files needs to be copied into the plugins directory of eclipse. The name of | # to be copied into the plugins directory of eclipse. The name of the directory | |||
# the directory within the plugins directory should be the same as | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. | |||
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before | # After copying Eclipse needs to be restarted before the help appears. | |||
# the help appears. | # The default value is: NO. | |||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
GENERATE_ECLIPSEHELP = NO | GENERATE_ECLIPSEHELP = NO | |||
# A unique identifier for the eclipse help plugin. When installing the plugin | # A unique identifier for the Eclipse help plugin. When installing the plugin | |||
# 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 | |||
# this name. | # name. Each documentation set should have its own identifier. | |||
# The default value is: org.doxygen.Project. | ||||
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. | ||||
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 (tabs) | # If you want full control over the layout of the generated HTML pages it might | |||
# at top of each HTML page. The value NO (the default) enables the index and | # be necessary to disable the index and replace it with your own. The | |||
# the value YES disables it. Since the tabs have the same information as the | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top | |||
# navigation tree you can set this option to NO if you already set | # of each HTML page. A value of NO enables the index and the value YES disables | |||
# GENERATE_TREEVIEW to YES. | # it. Since the tabs in the index contain the same information as the navigation | |||
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
DISABLE_INDEX = NO | DISABLE_INDEX = NO | |||
# 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 | |||
# If the tag value is set to YES, a side panel will be generated | # value is set to YES, a side panel will be generated containing a tree-like | |||
# containing a tree-like index structure (just like the one that | # index structure (just like the one that is generated for HTML Help). For this | |||
# is generated for HTML Help). For this to work a browser that supports | # to work a browser that supports JavaScript, DHTML, CSS and frames is required | |||
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). | # (i.e. any modern browser). Windows users are probably better off using the | |||
# Windows users are probably better off using the HTML help feature. | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can | |||
# Since the tree basically has the same information as the tab index you | # further fine-tune the look of the index. As an example, the default style | |||
# could consider to set DISABLE_INDEX to NO when enabling this option. | # sheet generated by doxygen has an example that shows how to put an image at | |||
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has | ||||
# the same information as the tab index, you could consider setting | ||||
# DISABLE_INDEX to YES when enabling this option. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
GENERATE_TREEVIEW = NO | GENERATE_TREEVIEW = NO | |||
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that | |||
# (range [0,1..20]) that doxygen will group on one line in the generated HTML | # doxygen will group on one line in the generated HTML documentation. | |||
# documentation. Note that a value of 0 will completely suppress the enum | # | |||
# values from appearing in the overview section. | # Note that a value of 0 will completely suppress the enum values from appearing | |||
# in the overview section. | ||||
# Minimum value: 0, maximum value: 20, default value: 4. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
ENUM_VALUES_PER_LINE = 4 | 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 | |||
# used to set the initial width (in pixels) of the frame in which the tree | # to set the initial width (in pixels) of the frame in which the tree is shown. | |||
# is shown. | # Minimum value: 0, maximum value: 1500, default value: 250. | |||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
TREEVIEW_WIDTH = 250 | TREEVIEW_WIDTH = 250 | |||
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to | |||
# links to external symbols imported via tag files in a separate window. | # external symbols imported via tag files in a separate window. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
EXT_LINKS_IN_WINDOW = NO | EXT_LINKS_IN_WINDOW = NO | |||
# Use this tag to change the font size of Latex formulas included | # Use this tag to change the font size of LaTeX formulas included as images in | |||
# as images in the HTML documentation. The default is 10. Note that | # the HTML documentation. When you change the font size after a successful | |||
# when you change the font size after a successful doxygen run you need | # doxygen run you need to manually remove any form_*.png images from the HTML | |||
# to manually remove any form_*.png images from the HTML output directory | # output directory to force them to be regenerated. | |||
# to force them to be regenerated. | # Minimum value: 8, maximum value: 50, default value: 10. | |||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
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 | |||
# not supported properly for IE 6.0, but are supported on all modern browsers. | # supported properly for IE 6.0, but are supported on all modern browsers. | |||
# Note that when changing this option you need to delete any form_*.png files | # | |||
# in the HTML output before the changes have effect. | # Note that when changing this option you need to delete any form_*.png files in | |||
# the HTML output directory before the changes have effect. | ||||
# The default value is: YES. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
FORMULA_TRANSPARENT = YES | FORMULA_TRANSPARENT = YES | |||
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see | |||
# (see http://www.mathjax.org) which uses client side Javascript for the | # http://www.mathjax.org) which uses client side Javascript for the rendering | |||
# rendering instead of using prerendered bitmaps. Use this if you do not | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX | |||
# have LaTeX installed or if you want to formulas look prettier in the HTML | # installed or if you want to formulas look prettier in the HTML output. When | |||
# output. When enabled you may also need to install MathJax separately and | # enabled you may also need to install MathJax separately and configure the path | |||
# configure the path to it using the MATHJAX_RELPATH option. | # to it using the MATHJAX_RELPATH option. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
USE_MATHJAX = NO | USE_MATHJAX = NO | |||
# When MathJax is enabled you need to specify the location relative to the | # When MathJax is enabled you can set the default output format to be used for | |||
# HTML output directory using the MATHJAX_RELPATH option. The destination | # the MathJax output. See the MathJax site (see: | |||
# directory should contain the MathJax.js script. For instance, if the mathjax | # http://docs.mathjax.org/en/latest/output.html) for more details. | |||
# directory is located at the same level as the HTML output directory, then | # Possible values are: HTML-CSS (which is slower, but has the best | |||
# MATHJAX_RELPATH should be ../mathjax. The default value points to | # compatibility), NativeMML (i.e. MathML) and SVG. | |||
# the MathJax Content Delivery Network so you can quickly see the result without | # The default value is: HTML-CSS. | |||
# installing MathJax. | # This tag requires that the tag USE_MATHJAX is set to YES. | |||
# However, it is strongly recommended to install a local | ||||
# copy of MathJax from http://www.mathjax.org before deployment. | MATHJAX_FORMAT = HTML-CSS | |||
# When MathJax is enabled you need to specify the location relative to the HTML | ||||
# output directory using the MATHJAX_RELPATH option. The destination directory | ||||
# should contain the MathJax.js script. For instance, if the mathjax directory | ||||
# is located at the same level as the HTML output directory, then | ||||
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax | ||||
# Content Delivery Network so you can quickly see the result without installing | ||||
# MathJax. However, it is strongly recommended to install a local copy of | ||||
# MathJax from http://www.mathjax.org before deployment. | ||||
# The default value is: http://cdn.mathjax.org/mathjax/latest. | ||||
# This tag requires that the tag USE_MATHJAX is set to YES. | ||||
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | |||
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax | |||
# names that should be enabled during MathJax rendering. | # extension names that should be enabled during MathJax rendering. For example | |||
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols | ||||
# This tag requires that the tag USE_MATHJAX is set to YES. | ||||
MATHJAX_EXTENSIONS = | MATHJAX_EXTENSIONS = | |||
# When the SEARCHENGINE tag is enabled doxygen will generate a search box | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces | |||
# for the HTML output. The underlying search engine uses javascript | # of code that will be used on startup of the MathJax code. See the MathJax site | |||
# and DHTML and should work on any modern browser. Note that when using | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an | |||
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets | # example see the documentation. | |||
# (GENERATE_DOCSET) there is already a search function so this one should | # This tag requires that the tag USE_MATHJAX is set to YES. | |||
# typically be disabled. For large projects the javascript based search engine | ||||
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. | MATHJAX_CODEFILE = | |||
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for | ||||
# the HTML output. The underlying search engine uses javascript and DHTML and | ||||
# should work on any modern browser. Note that when using HTML help | ||||
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) | ||||
# there is already a search function so this one should typically be disabled. | ||||
# For large projects the javascript based search engine can be slow, then | ||||
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to | ||||
# search using the keyboard; to jump to the search box use <access key> + S | ||||
# (what the <access key> is depends on the OS and browser, but it is typically | ||||
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down | ||||
# key> to jump into the search results window, the results can be navigated | ||||
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel | ||||
# the search. The filter options can be selected when the cursor is inside the | ||||
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> | ||||
# to select a filter and <Enter> or <escape> to activate or cancel the filter | ||||
# option. | ||||
# The default value is: YES. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||||
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 web server instead of a web client using Javascript. There | |||
# using Javascript. Doxygen will generate the search PHP script and index | # are two flavors of web server based searching depending on the EXTERNAL_SEARCH | |||
# file to put on the web server. The advantage of the server | # setting. When disabled, doxygen will generate a PHP script for searching and | |||
# based approach is that it scales better to large projects and allows | # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing | |||
# full text search. The disadvantages are that it is more difficult to setup | # and searching needs to be provided by external tools. See the section | |||
# and does not have live searching capabilities. | # "External Indexing and Searching" for details. | |||
# The default value is: NO. | ||||
# This tag requires that the tag SEARCHENGINE is set to YES. | ||||
SERVER_BASED_SEARCH = NO | SERVER_BASED_SEARCH = NO | |||
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP | ||||
# script for searching. Instead the search results are written to an XML file | ||||
# which needs to be processed by an external indexer. Doxygen will invoke an | ||||
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the | ||||
# search results. | ||||
# | ||||
# Doxygen ships with an example indexer (doxyindexer) and search engine | ||||
# (doxysearch.cgi) which are based on the open source search engine library | ||||
# Xapian (see: http://xapian.org/). | ||||
# | ||||
# See the section "External Indexing and Searching" for details. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag SEARCHENGINE is set to YES. | ||||
EXTERNAL_SEARCH = NO | ||||
# The SEARCHENGINE_URL should point to a search engine hosted by a web server | ||||
# which will return the search results when EXTERNAL_SEARCH is enabled. | ||||
# | ||||
# Doxygen ships with an example indexer (doxyindexer) and search engine | ||||
# (doxysearch.cgi) which are based on the open source search engine library | ||||
# Xapian (see: http://xapian.org/). See the section "External Indexing and | ||||
# Searching" for details. | ||||
# This tag requires that the tag SEARCHENGINE is set to YES. | ||||
SEARCHENGINE_URL = | ||||
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed | ||||
# search data is written to a file for indexing by an external tool. With the | ||||
# SEARCHDATA_FILE tag the name of this file can be specified. | ||||
# The default file is: searchdata.xml. | ||||
# This tag requires that the tag SEARCHENGINE is set to YES. | ||||
SEARCHDATA_FILE = searchdata.xml | ||||
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the | ||||
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is | ||||
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple | ||||
# projects and redirect the results back to the right project. | ||||
# This tag requires that the tag SEARCHENGINE is set to YES. | ||||
EXTERNAL_SEARCH_ID = | ||||
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen | ||||
# projects other than the one defined by this configuration file, but that are | ||||
# all added to the same external search index. Each project needs to have a | ||||
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of | ||||
# to a relative location where the documentation can be found. The format is: | ||||
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... | ||||
# This tag requires that the tag SEARCHENGINE is set to YES. | ||||
EXTRA_SEARCH_MAPPINGS = | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# 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, doxygen will generate LaTeX output. | |||
# generate Latex output. | # The default value is: YES. | |||
GENERATE_LATEX = YES | GENERATE_LATEX = NO | |||
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a | |||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | |||
# put in front of it. If left blank `latex' will be used as the default path. | # it. | |||
# The default directory is: latex. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_OUTPUT = latex | LATEX_OUTPUT = latex | |||
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | |||
# invoked. If left blank `latex' will be used as the default command name. | # invoked. | |||
# Note that when enabling USE_PDFLATEX this option is only used for | # | |||
# generating bitmaps for formulas in the HTML output, but not in the | # Note that when enabling USE_PDFLATEX this option is only used for generating | |||
# Makefile that is written to the output directory. | # bitmaps for formulas in the HTML output, but not in the Makefile that is | |||
# written to the output directory. | ||||
# The default file is: latex. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_CMD_NAME = latex | LATEX_CMD_NAME = latex | |||
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate | |||
# generate index for LaTeX. If left blank `makeindex' will be used as the | # index for LaTeX. | |||
# default command name. | # The default file is: makeindex. | |||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
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 | |||
# LaTeX documents. This may be useful for small projects and may help to | # documents. This may be useful for small projects and may help to save some | |||
# save some trees in general. | # trees in general. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
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 | |||
# by the printer. Possible values are: a4, letter, legal and | # printer. | |||
# executive. If left blank a4wide will be used. | # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x | |||
# 14 inches) and executive (7.25 x 10.5 inches). | ||||
# The default value is: a4. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
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 used to specify one or more LaTeX package names | |||
# packages that should be included in the LaTeX output. | # that should be included in the LaTeX output. The package can be specified just | |||
# by its name or with the correct syntax as to be used with the LaTeX | ||||
# \usepackage command. To get the times font for instance you can specify : | ||||
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} | ||||
# To use the option intlimits with the amsmath package you can specify: | ||||
# EXTRA_PACKAGES=[intlimits]{amsmath} | ||||
# If left blank no extra packages will be included. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
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 | |||
# the generated latex document. The header should contain everything until | # generated LaTeX document. The header should contain everything until the first | |||
# the first chapter. If it is left blank doxygen will generate a | # chapter. If it is left blank doxygen will generate a standard header. See | |||
# standard header. Notice: only use this tag if you know what you are doing! | # section "Doxygen usage" for information on how to let doxygen write the | |||
# default header to a separate file. | ||||
# | ||||
# Note: Only use a user-defined header if you know what you are doing! The | ||||
# following commands have a special meaning inside the header: $title, | ||||
# $datetime, $date, $doxygenversion, $projectname, $projectnumber, | ||||
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty | ||||
# string, for the replacement values of the other commands the user is referred | ||||
# to HTML_HEADER. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_HEADER = | LATEX_HEADER = | |||
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the | |||
# the generated latex document. The footer should contain everything after | # generated LaTeX document. The footer should contain everything after the last | |||
# the last chapter. If it is left blank doxygen will generate a | # chapter. If it is left blank doxygen will generate a standard footer. See | |||
# standard footer. Notice: only use this tag if you know what you are doing! | # LATEX_HEADER for more information on how to generate a default footer and what | |||
# special commands can be used inside the footer. | ||||
# | ||||
# Note: Only use a user-defined footer if you know what you are doing! | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_FOOTER = | LATEX_FOOTER = | |||
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined | |||
# is prepared for conversion to pdf (using ps2pdf). The pdf file will | # LaTeX style sheets that are included after the standard style sheets created | |||
# contain links (just like the HTML output) instead of page references | # by doxygen. Using this option one can overrule certain style aspects. Doxygen | |||
# This makes the output suitable for online browsing using a pdf viewer. | # will copy the style sheet files to the output directory. | |||
# Note: The order of the extra style sheet files is of importance (e.g. the last | ||||
# style sheet in the list overrules the setting of the previous ones in the | ||||
# list). | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_EXTRA_STYLESHEET = | ||||
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or | ||||
# other source files which should be copied to the LATEX_OUTPUT output | ||||
# directory. Note that the files will be copied as-is; there are no commands or | ||||
# markers available. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_EXTRA_FILES = | ||||
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is | ||||
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will | ||||
# contain links (just like the HTML output) instead of page references. This | ||||
# makes the output suitable for online browsing using a PDF viewer. | ||||
# The default value is: YES. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
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, doxygen will use pdflatex to generate | |||
# plain latex in the generated Makefile. Set this option to YES to get a | # the PDF file directly from the LaTeX files. Set this option to YES, to get a | |||
# higher quality PDF documentation. | # higher quality PDF documentation. | |||
# The default value is: YES. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
USE_PDFLATEX = NO | USE_PDFLATEX = NO | |||
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode | |||
# command to the generated LaTeX files. This will instruct LaTeX to keep | # command to the generated LaTeX files. This will instruct LaTeX to keep running | |||
# running if errors occur, instead of asking the user for help. | # if errors occur, instead of asking the user for help. This option is also used | |||
# This option is also used when generating formulas in HTML. | # when generating formulas in HTML. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_BATCHMODE = NO | LATEX_BATCHMODE = NO | |||
# If LATEX_HIDE_INDICES is set to YES then doxygen will not | # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the | |||
# include the index chapters (such as File Index, Compound Index, etc.) | # index chapters (such as File Index, Compound Index, etc.) in the output. | |||
# in the output. | # The default value is: NO. | |||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_HIDE_INDICES = NO | LATEX_HIDE_INDICES = NO | |||
# If LATEX_SOURCE_CODE is set to YES then doxygen will include | # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source | |||
# source code with syntax highlighting in the LaTeX output. | # code with syntax highlighting in the LaTeX output. | |||
# Note that which sources are shown also depends on other settings | # | |||
# such as SOURCE_BROWSER. | # Note that which sources are shown also depends on other settings such as | |||
# SOURCE_BROWSER. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_SOURCE_CODE = NO | LATEX_SOURCE_CODE = NO | |||
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the | # 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 | # bibliography, e.g. plainnat, or ieeetr. See | |||
# http://en.wikipedia.org/wiki/BibTeX for more info. | # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. | |||
# The default value is: plain. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_BIB_STYLE = plain | LATEX_BIB_STYLE = plain | |||
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated | ||||
# 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. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_TIMESTAMP = NO | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# configuration options related to the RTF output | # Configuration options related to the RTF output | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The | |||
# The RTF output is optimized for Word 97 and may not look very pretty with | # RTF output is optimized for Word 97 and may not look too pretty with other RTF | |||
# other RTF readers or editors. | # readers/editors. | |||
# The default value is: NO. | ||||
GENERATE_RTF = NO | GENERATE_RTF = NO | |||
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a | |||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | |||
# put in front of it. If left blank `rtf' will be used as the default path. | # it. | |||
# The default directory is: rtf. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | ||||
RTF_OUTPUT = rtf | RTF_OUTPUT = rtf | |||
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact | # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF | |||
# RTF documents. This may be useful for small projects and may help to | # documents. This may be useful for small projects and may help to save some | |||
# save some trees in general. | # trees in general. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | ||||
COMPACT_RTF = NO | COMPACT_RTF = NO | |||
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will | |||
# will contain hyperlink fields. The RTF file will | # contain hyperlink fields. The RTF file will contain links (just like the HTML | |||
# contain links (just like the HTML output) instead of page references. | # output) instead of page references. This makes the output suitable for online | |||
# This makes the output suitable for online browsing using WORD or other | # browsing using Word or some other Word compatible readers that support those | |||
# programs which support those fields. | # fields. | |||
# Note: wordpad (write) and others do not support links. | # | |||
# Note: WordPad (write) and others do not support links. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | ||||
RTF_HYPERLINKS = NO | RTF_HYPERLINKS = NO | |||
# Load style sheet definitions from file. Syntax is similar to doxygen's | # Load stylesheet definitions from file. Syntax is similar to doxygen's config | |||
# config file, i.e. a series of assignments. You only have to provide | # file, i.e. a series of assignments. You only have to provide replacements, | |||
# replacements, missing definitions are set to their default value. | # missing definitions are set to their default value. | |||
# | ||||
# See also section "Doxygen usage" for information on how to generate the | ||||
# default style sheet that doxygen normally uses. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | ||||
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 | |||
# Syntax is similar to doxygen's config file. | # similar to doxygen's config file. A template extensions file can be generated | |||
# using doxygen -e rtf extensionFile. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | ||||
RTF_EXTENSIONS_FILE = | RTF_EXTENSIONS_FILE = | |||
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code | ||||
# with syntax highlighting in the RTF output. | ||||
# | ||||
# Note that which sources are shown also depends on other settings such as | ||||
# SOURCE_BROWSER. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | ||||
RTF_SOURCE_CODE = NO | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# configuration options related to the man page output | # Configuration options related to the man page output | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will | # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for | |||
# generate man pages | # classes and files. | |||
# The default value is: NO. | ||||
GENERATE_MAN = NO | GENERATE_MAN = NO | |||
# The MAN_OUTPUT tag is used to specify where the man pages will be put. | # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a | |||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | |||
# put in front of it. If left blank `man' will be used as the default path. | # it. A directory man3 will be created inside the directory specified by | |||
# MAN_OUTPUT. | ||||
# The default directory is: man. | ||||
# This tag requires that the tag GENERATE_MAN is set to YES. | ||||
MAN_OUTPUT = man | MAN_OUTPUT = man | |||
# The MAN_EXTENSION tag determines the extension that is added to | # The MAN_EXTENSION tag determines the extension that is added to the generated | |||
# the generated man pages (default is the subroutine's section .3) | # man pages. In case the manual section does not start with a number, the number | |||
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is | ||||
# optional. | ||||
# The default value is: .3. | ||||
# This tag requires that the tag GENERATE_MAN is set to YES. | ||||
MAN_EXTENSION = .3 | MAN_EXTENSION = .3 | |||
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, | # The MAN_SUBDIR tag determines the name of the directory created within | |||
# then it will generate one additional man file for each entity | # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by | |||
# documented in the real man page(s). These additional files | # MAN_EXTENSION with the initial . removed. | |||
# only source the real man page, but without them the man command | # This tag requires that the tag GENERATE_MAN is set to YES. | |||
# would be unable to find the correct page. The default is NO. | ||||
MAN_SUBDIR = | ||||
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it | ||||
# will generate one additional man file for each entity documented in the real | ||||
# man page(s). These additional files only source the real man page, but without | ||||
# them the man command would be unable to find the correct page. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_MAN is set to YES. | ||||
MAN_LINKS = NO | MAN_LINKS = NO | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# configuration options related to the XML output | # Configuration options related to the XML output | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the GENERATE_XML tag is set to YES Doxygen will | # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that | |||
# generate an XML file that captures the structure of | # captures the structure of the code including all documentation. | |||
# the code including all documentation. | # The default value is: NO. | |||
GENERATE_XML = NO | GENERATE_XML = NO | |||
# The XML_OUTPUT tag is used to specify where the XML pages will be put. | # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a | |||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | |||
# put in front of it. If left blank `xml' will be used as the default path. | # it. | |||
# The default directory is: xml. | ||||
# This tag requires that the tag GENERATE_XML is set to YES. | ||||
XML_OUTPUT = xml | XML_OUTPUT = xml | |||
# The XML_SCHEMA tag can be used to specify an XML schema, | # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program | |||
# which can be used by a validating XML parser to check the | # listings (including syntax highlighting and cross-referencing information) to | |||
# syntax of the XML files. | # the XML output. Note that enabling this will significantly increase the size | |||
# of the XML output. | ||||
XML_SCHEMA = | # The default value is: YES. | |||
# This tag requires that the tag GENERATE_XML is set to YES. | ||||
# The XML_DTD tag can be used to specify an XML DTD, | ||||
# which can be used by a validating XML parser to check the | ||||
# syntax of the XML files. | ||||
XML_DTD = | ||||
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will | ||||
# dump the program listings (including syntax highlighting | ||||
# and cross-referencing information) to the XML output. Note that | ||||
# enabling this will significantly increase the size of the XML output. | ||||
XML_PROGRAMLISTING = YES | XML_PROGRAMLISTING = YES | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# configuration options for the AutoGen Definitions output | # Configuration options related to the DOCBOOK output | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files | |||
# generate an AutoGen Definitions (see autogen.sf.net) file | # that can be used to generate PDF. | |||
# that captures the structure of the code including all | # The default value is: NO. | |||
# documentation. Note that this feature is still experimental | ||||
# and incomplete at the moment. | GENERATE_DOCBOOK = NO | |||
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. | ||||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in | ||||
# front of it. | ||||
# The default directory is: docbook. | ||||
# This tag requires that the tag GENERATE_DOCBOOK is set to YES. | ||||
DOCBOOK_OUTPUT = docbook | ||||
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the | ||||
# program listings (including syntax highlighting and cross-referencing | ||||
# information) to the DOCBOOK output. Note that enabling this will significantly | ||||
# increase the size of the DOCBOOK output. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_DOCBOOK is set to YES. | ||||
DOCBOOK_PROGRAMLISTING = NO | ||||
#--------------------------------------------------------------------------- | ||||
# Configuration options for the AutoGen Definitions output | ||||
#--------------------------------------------------------------------------- | ||||
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an | ||||
# AutoGen Definitions (see http://autogen.sf.net) file that captures the | ||||
# structure of the code including all documentation. Note that this feature is | ||||
# still experimental and incomplete at the moment. | ||||
# The default value is: NO. | ||||
GENERATE_AUTOGEN_DEF = NO | GENERATE_AUTOGEN_DEF = NO | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# configuration options related to the Perl module output | # Configuration options related to the Perl module output | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the GENERATE_PERLMOD tag is set to YES Doxygen will | # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module | |||
# generate a Perl module file that captures the structure of | # file that captures the structure of the code including all documentation. | |||
# the code including all documentation. Note that this | # | |||
# feature is still experimental and incomplete at the | # Note that this feature is still experimental and incomplete at the moment. | |||
# moment. | # The default value is: NO. | |||
GENERATE_PERLMOD = NO | GENERATE_PERLMOD = NO | |||
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate | # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary | |||
# the necessary Makefile rules, Perl scripts and LaTeX code to be able | # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI | |||
# to generate PDF and DVI output from the Perl module output. | # output from the Perl module output. | |||
# The default value is: NO. | ||||
# This tag requires that the tag GENERATE_PERLMOD is set to YES. | ||||
PERLMOD_LATEX = NO | PERLMOD_LATEX = NO | |||
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely | |||
# nicely formatted so it can be parsed by a human reader. | # formatted so it can be parsed by a human reader. This is useful if you want to | |||
# This is useful | # understand what is going on. On the other hand, if this tag is set to NO, the | |||
# if you want to understand what is going on. | # size of the Perl module output will be much smaller and Perl will parse it | |||
# On the other hand, if this | # just the same. | |||
# tag is set to NO the size of the Perl module output will be much smaller | # The default value is: YES. | |||
# and Perl will parse it just the same. | # This tag requires that the tag GENERATE_PERLMOD is set to YES. | |||
PERLMOD_PRETTY = YES | PERLMOD_PRETTY = YES | |||
# The names of the make variables in the generated doxyrules.make file | # The names of the make variables in the generated doxyrules.make file are | |||
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful | |||
# This is useful so different doxyrules.make files included by the same | # so different doxyrules.make files included by the same Makefile don't | |||
# Makefile don't overwrite each other's variables. | # overwrite each other's variables. | |||
# This tag requires that the tag GENERATE_PERLMOD is set to YES. | ||||
PERLMOD_MAKEVAR_PREFIX = | PERLMOD_MAKEVAR_PREFIX = | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# Configuration options related to the preprocessor | # Configuration options related to the preprocessor | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all | |||
# evaluate all C-preprocessor directives found in the sources and include | # C-preprocessor directives found in the sources and include files. | |||
# files. | # The default value is: YES. | |||
ENABLE_PREPROCESSING = YES | ENABLE_PREPROCESSING = YES | |||
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names | |||
# names in the source code. If set to NO (the default) only conditional | # in the source code. If set to NO, only conditional compilation will be | |||
# compilation will be performed. Macro expansion can be done in a controlled | # performed. Macro expansion can be done in a controlled way by setting | |||
# way by setting EXPAND_ONLY_PREDEF to YES. | # EXPAND_ONLY_PREDEF to YES. | |||
# The default value is: NO. | ||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||||
MACRO_EXPANSION = YES | MACRO_EXPANSION = YES | |||
# 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 | |||
# then the macro expansion is limited to the macros specified with the | # the macro expansion is limited to the macros specified with the PREDEFINED and | |||
# PREDEFINED and EXPAND_AS_DEFINED tags. | # EXPAND_AS_DEFINED tags. | |||
# The default value is: NO. | ||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||||
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 include files in the | |||
# pointed to by INCLUDE_PATH will be searched when a #include is found. | # INCLUDE_PATH will be searched if a #include is found. | |||
# The default value is: YES. | ||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||||
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 | |||
# the preprocessor. | # preprocessor. | |||
# This tag requires that the tag SEARCH_INCLUDES is set to YES. | ||||
INCLUDE_PATH = | INCLUDE_PATH = | |||
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | |||
# patterns (like *.h and *.hpp) to filter out the header-files in the | # patterns (like *.h and *.hpp) to filter out the header-files in the | |||
# directories. If left blank, the patterns specified with FILE_PATTERNS will | # directories. If left blank, the patterns specified with FILE_PATTERNS will be | |||
# be used. | # used. | |||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||||
INCLUDE_FILE_PATTERNS = | INCLUDE_FILE_PATTERNS = | |||
# The PREDEFINED tag can be used to specify one or more macro names that | # The PREDEFINED tag can be used to specify one or more macro names that are | |||
# are defined before the preprocessor is started (similar to the -D option of | # defined before the preprocessor is started (similar to the -D option of e.g. | |||
# gcc). The argument of the tag is a list of macros of the form: name | # gcc). The argument of the tag is a list of macros of the form: name or | |||
# or name=definition (no spaces). If the definition and the = are | # name=definition (no spaces). If the definition and the "=" are omitted, "=1" | |||
# omitted =1 is assumed. To prevent a macro definition from being | # is assumed. To prevent a macro definition from being undefined via #undef or | |||
# undefined via #undef or recursively expanded use the := operator | # recursively expanded use the := operator instead of the = operator. | |||
# instead of the = operator. | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | |||
PREDEFINED = DOXYGEN \ | PREDEFINED = DOXYGEN \ | |||
OSIP_MT \ | OSIP_MT \ | |||
HAVE_PTHREAD_H \ | HAVE_PTHREAD_H \ | |||
HAVE_SEMAPHORE_H | HAVE_SEMAPHORE_H | |||
# 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 | |||
# this tag can be used to specify a list of macro names that should be expanded. | # tag can be used to specify a list of macro names that should be expanded. The | |||
# The macro definition that is found in the sources will be used. | # macro definition that is found in the sources will be used. Use the PREDEFINED | |||
# Use the PREDEFINED tag if you want to use a different macro definition that | # tag if you want to use a different macro definition that overrules the | |||
# overrules the definition found in the source code. | # definition found in the source code. | |||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||||
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 then doxygen's preprocessor will | |||
# doxygen's preprocessor will remove all references to function-like macros | # remove all references to function-like macros that are alone on a line, have | |||
# that are alone on a line, have an all uppercase name, and do not end with a | # an all uppercase name, and do not end with a semicolon. Such function macros | |||
# semicolon, because these will confuse the parser if not removed. | # are typically used for boiler-plate code, and will confuse the parser if not | |||
# removed. | ||||
# The default value is: YES. | ||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||||
SKIP_FUNCTION_MACROS = YES | SKIP_FUNCTION_MACROS = YES | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# Configuration::additions related to external references | # Configuration options related to external references | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# The TAGFILES option can be used to specify one or more tagfiles. For each | # The TAGFILES tag can be used to specify one or more tag files. For each tag | |||
# tag file the location of the external documentation should be added. The | # file the location of the external documentation should be added. The format of | |||
# format of a tag file without this location is as follows: | # a tag file without 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 | # where loc1 and loc2 can be relative or absolute paths or URLs. See the | |||
# or URLs. Note that each tag file must have a unique name (where the name does | # section "Linking to external documentation" for more information about the use | |||
# NOT include the path). If a tag file is not located in the directory in which | # of tag files. | |||
# doxygen is run, you must also specify the path to the tagfile here. | # Note: Each tag file must have a unique name (where the name does NOT include | |||
# the path). If a tag file is not located in the directory in which doxygen is | ||||
# run, you must also specify the path to the tagfile here. | ||||
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 | |||
# a tag file that is based on the input files it reads. | # tag file that is based on the input files it reads. See section "Linking to | |||
# external documentation" for more information about the usage of tag files. | ||||
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 class will be listed in | |||
# in the class index. If set to NO only the inherited external classes | # the class index. If set to NO, only the inherited external classes will be | |||
# will be listed. | # listed. | |||
# The default value is: NO. | ||||
ALLEXTERNALS = NO | ALLEXTERNALS = NO | |||
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed | |||
# in the modules index. If set to NO, only the current project's groups will | # in the modules index. If set to NO, only the current project's groups will be | |||
# be listed. | # listed. | |||
# The default value is: YES. | ||||
EXTERNAL_GROUPS = YES | EXTERNAL_GROUPS = YES | |||
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in | ||||
# the related pages index. If set to NO, only the current project's pages will | ||||
# be listed. | ||||
# The default value is: YES. | ||||
EXTERNAL_PAGES = YES | ||||
# The PERL_PATH should be the absolute path and name of the perl script | # The PERL_PATH should be the absolute path and name of the perl script | |||
# interpreter (i.e. the result of `which perl'). | # interpreter (i.e. the result of 'which perl'). | |||
# The default file (with absolute path) is: /usr/bin/perl. | ||||
PERL_PATH = /usr/bin/perl | PERL_PATH = /usr/bin/perl | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# Configuration options related to the dot tool | # Configuration options related to the dot tool | |||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | |||
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram | |||
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to | |||
# or super classes. Setting the tag to NO turns the diagrams off. Note that | # NO turns the diagrams off. Note that this option also works with HAVE_DOT | |||
# this option also works with HAVE_DOT disabled, but it is recommended to | # disabled, but it is recommended to install and use dot, since it yields more | |||
# install and use dot, since it yields more powerful graphs. | # powerful graphs. | |||
# The default value is: YES. | ||||
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 where | # documentation. The MSCGEN_PATH tag allows you to specify the directory where | |||
# the mscgen tool resides. If left empty the tool is assumed to be found in the | # the mscgen tool resides. If left empty the tool is assumed to be found in the | |||
# default search path. | # default search path. | |||
MSCGEN_PATH = | MSCGEN_PATH = | |||
# If set to YES, the inheritance and collaboration graphs will hide | # You can include diagrams made with dia in doxygen documentation. Doxygen will | |||
# inheritance and usage relations if the target is undocumented | # then run dia to produce the diagram and insert it in the documentation. The | |||
# or is not a class. | # DIA_PATH tag allows you to specify the directory where the dia binary resides. | |||
# If left empty dia is assumed to be found in the default search path. | ||||
DIA_PATH = | ||||
# If set to YES the inheritance and collaboration graphs will hide inheritance | ||||
# and usage relations if the target is undocumented or is not a class. | ||||
# The default value is: YES. | ||||
HIDE_UNDOC_RELATIONS = YES | HIDE_UNDOC_RELATIONS = YES | |||
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | |||
# available from the path. This tool is part of Graphviz, a graph visualization | # available from the path. This tool is part of Graphviz (see: | |||
# toolkit from AT&T and Lucent Bell Labs. The other options in this section | # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent | |||
# have no effect if this option is set to NO (the default) | # Bell Labs. The other options in this section have no effect if this option is | |||
# set to NO | ||||
# The default value is: YES. | ||||
HAVE_DOT = NO | HAVE_DOT = NO | |||
# 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 | |||
# allowed to run in parallel. When set to 0 (the default) doxygen will | # to run in parallel. When set to 0 doxygen will base this on the number of | |||
# base this on the number of processors available in the system. You can set it | # processors available in the system. You can set it explicitly to a value | |||
# explicitly to a value larger than 0 to get control over the balance | # larger than 0 to get control over the balance between CPU load and processing | |||
# between CPU load and processing speed. | # speed. | |||
# Minimum value: 0, maximum value: 32, default value: 0. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_NUM_THREADS = 0 | DOT_NUM_THREADS = 0 | |||
# By default doxygen will use the Helvetica font for all dot files that | # When you want a differently looking font in the dot files that doxygen | |||
# doxygen generates. When you want a differently looking font you can specify | # generates you can specify the font name using DOT_FONTNAME. You need to make | |||
# the font name using DOT_FONTNAME. You need to make sure dot is able to find | # sure dot is able to find the font, which can be done by putting it in a | |||
# the font, which can be done by putting it in a standard location or by setting | # standard location or by setting the DOTFONTPATH environment variable or by | |||
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the | # setting DOT_FONTPATH to the directory containing the font. | |||
# directory containing the font. | # The default value is: Helvetica. | |||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_FONTNAME = Helvetica | DOT_FONTNAME = Helvetica | |||
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. | # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of | |||
# The default size is 10pt. | # dot graphs. | |||
# Minimum value: 4, maximum value: 24, default value: 10. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_FONTSIZE = 10 | DOT_FONTSIZE = 10 | |||
# By default doxygen will tell dot to use the Helvetica font. | # By default doxygen will tell dot to use the default font as specified with | |||
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to | # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set | |||
# set the path where dot can find it. | # the path where dot can find it using this tag. | |||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_FONTPATH = | DOT_FONTPATH = | |||
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for | |||
# will generate a graph for each documented class showing the direct and | # each documented class showing the direct and indirect inheritance relations. | |||
# indirect inheritance relations. Setting this tag to YES will force the | # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. | |||
# CLASS_DIAGRAMS tag to NO. | # The default value is: YES. | |||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
CLASS_GRAPH = YES | CLASS_GRAPH = YES | |||
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a | |||
# will generate a graph for each documented class showing the direct and | # graph for each documented class showing the direct and indirect implementation | |||
# indirect implementation dependencies (inheritance, containment, and | # dependencies (inheritance, containment, and class references variables) of the | |||
# class references variables) of the class with other documented classes. | # class with other documented classes. | |||
# The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
COLLABORATION_GRAPH = YES | COLLABORATION_GRAPH = YES | |||
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen | # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for | |||
# will generate a graph for groups, showing the direct groups dependencies | # groups, showing the direct groups dependencies. | |||
# The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
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. | |||
# The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
UML_LOOK = NO | UML_LOOK = NO | |||
# If the UML_LOOK tag is enabled, the fields and methods are shown inside | # If the UML_LOOK tag is enabled, the fields and methods are shown inside the | |||
# the class node. If there are many fields or methods and many nodes the | # class node. If there are many fields or methods and many nodes the graph may | |||
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS | # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the | |||
# threshold limits the number of items for each type to make the size more | # number of items for each type to make the size more manageable. Set this to 0 | |||
# managable. Set this to 0 for no limit. Note that the threshold may be | # for no limit. Note that the threshold may be exceeded by 50% before the limit | |||
# exceeded by 50% before the limit is enforced. | # is enforced. So when you set the threshold to 10, up to 15 fields may appear, | |||
# but if the number exceeds 15, the total amount of fields shown is limited to | ||||
# 10. | ||||
# Minimum value: 0, maximum value: 100, default value: 10. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
UML_LIMIT_NUM_FIELDS = 10 | UML_LIMIT_NUM_FIELDS = 10 | |||
# If set to YES, the inheritance and collaboration graphs will show the | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and | |||
# relations between templates and their instances. | # collaboration graphs will show the relations between templates and their | |||
# instances. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
TEMPLATE_RELATIONS = YES | TEMPLATE_RELATIONS = YES | |||
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to | |||
# tags are set to YES then doxygen will generate a graph for each documented | # YES then doxygen will generate a graph for each documented file showing the | |||
# file showing the direct and indirect include dependencies of the file with | # direct and indirect include dependencies of the file with other documented | |||
# other documented files. | # files. | |||
# The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
INCLUDE_GRAPH = YES | INCLUDE_GRAPH = YES | |||
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are | |||
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each | # set to YES then doxygen will generate a graph for each documented file showing | |||
# documented header file showing the documented files that directly or | # the direct and indirect include dependencies of the file with other documented | |||
# indirectly include this file. | # files. | |||
# The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
INCLUDED_BY_GRAPH = YES | INCLUDED_BY_GRAPH = YES | |||
# If the CALL_GRAPH and HAVE_DOT options are set to YES then | # If the CALL_GRAPH tag is set to YES then doxygen will generate a call | |||
# doxygen will generate a call dependency graph for every global function | # dependency graph for every global function or class method. | |||
# or class method. Note that enabling this option will significantly increase | # | |||
# the time of a run. So in most cases it will be better to enable call graphs | # Note that enabling this option will significantly increase the time of a run. | |||
# for selected functions only using the \callgraph command. | # So in most cases it will be better to enable call graphs for selected | |||
# functions only using the \callgraph command. Disabling a call graph can be | ||||
# accomplished by means of the command \hidecallgraph. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
CALL_GRAPH = NO | CALL_GRAPH = NO | |||
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller | |||
# doxygen will generate a caller dependency graph for every global function | # dependency graph for every global function or class method. | |||
# or class method. Note that enabling this option will significantly increase | # | |||
# the time of a run. So in most cases it will be better to enable caller | # Note that enabling this option will significantly increase the time of a run. | |||
# graphs for selected functions only using the \callergraph command. | # So in most cases it will be better to enable caller graphs for selected | |||
# functions only using the \callergraph command. Disabling a caller graph can be | ||||
# accomplished by means of the command \hidecallergraph. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
CALLER_GRAPH = NO | CALLER_GRAPH = NO | |||
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical | |||
# will generate a graphical hierarchy of all classes instead of a textual one. | # hierarchy of all classes instead of a textual one. | |||
# The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
GRAPHICAL_HIERARCHY = YES | GRAPHICAL_HIERARCHY = YES | |||
# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES | # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the | |||
# then doxygen will show the dependencies a directory has on other directories | # dependencies a directory has on other directories in a graphical way. The | |||
# in a graphical way. The dependency relations are determined by the #include | # dependency relations are determined by the #include relations between the | |||
# relations between the files in the directories. | # files in the directories. | |||
# The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DIRECTORY_GRAPH = YES | DIRECTORY_GRAPH = YES | |||
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | |||
# generated by dot. Possible values are svg, png, jpg, or gif. | # generated by dot. For an explanation of the image formats see the section | |||
# If left blank png will be used. If you choose svg you need to set | # output formats in the documentation of the dot tool (Graphviz (see: | |||
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files | # http://www.graphviz.org/)). | |||
# visible in IE 9+ (other browsers do not have this requirement). | # Note: 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). | ||||
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, | ||||
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, | ||||
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, | ||||
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and | ||||
# png:gdiplus:gdiplus. | ||||
# The default value is: png. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
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 | # 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 panning. | # enable generation of interactive SVG images that allow zooming and panning. | |||
# Note that this requires a modern browser other than Internet Explorer. | # | |||
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you | # Note that this requires a modern browser other than Internet Explorer. Tested | |||
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files | # and working are Firefox, Chrome, Safari, and Opera. | |||
# visible. Older versions of IE do not have SVG support. | # Note: 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. | ||||
# The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
INTERACTIVE_SVG = NO | INTERACTIVE_SVG = NO | |||
# The tag DOT_PATH can be used to specify the path where the dot tool can be | # The DOT_PATH tag can be used to specify the path where the dot tool can be | |||
# found. If left blank, it is assumed the dot tool can be found in the path. | # found. If left blank, it is assumed the dot tool can be found in the path. | |||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_PATH = | DOT_PATH = | |||
# The DOTFILE_DIRS tag can be used to specify one or more directories that | # The DOTFILE_DIRS tag can be used to specify one or more directories that | |||
# contain dot files that are included in the documentation (see the | # contain dot files that are included in the documentation (see the \dotfile | |||
# \dotfile command). | # command). | |||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOTFILE_DIRS = | DOTFILE_DIRS = | |||
# The MSCFILE_DIRS tag can be used to specify one or more directories that | # 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 | # contain msc files that are included in the documentation (see the \mscfile | |||
# \mscfile command). | # command). | |||
MSCFILE_DIRS = | MSCFILE_DIRS = | |||
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | # The DIAFILE_DIRS tag can be used to specify one or more directories that | |||
# nodes that will be shown in the graph. If the number of nodes in a graph | # contain dia files that are included in the documentation (see the \diafile | |||
# becomes larger than this value, doxygen will truncate the graph, which is | # command). | |||
# 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 than | DIAFILE_DIRS = | |||
# 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. | # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the | |||
# path where java can find the plantuml.jar file. If left blank, it is assumed | ||||
# PlantUML is not used or called during a preprocessing step. Doxygen will | ||||
# generate a warning when it encounters a \startuml command in this case and | ||||
# will not generate output for the diagram. | ||||
PLANTUML_JAR_PATH = | ||||
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a | ||||
# configuration file for plantuml. | ||||
PLANTUML_CFG_FILE = | ||||
# When using plantuml, the specified paths are searched for files specified by | ||||
# the !include statement in a plantuml block. | ||||
PLANTUML_INCLUDE_PATH = | ||||
# 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 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 number of direct | ||||
# children of the root node in a graph is already larger than | ||||
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that | ||||
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | ||||
# Minimum value: 0, maximum value: 10000, default value: 50. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_GRAPH_MAX_NODES = 50 | DOT_GRAPH_MAX_NODES = 50 | |||
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs | |||
# graphs generated by dot. A depth value of 3 means that only nodes reachable | # generated by dot. A depth value of 3 means that only nodes reachable from the | |||
# from the root by following a path via at most 3 edges will be shown. Nodes | # root by following a path via at most 3 edges will be shown. Nodes that lay | |||
# that lay further from the root node will be omitted. Note that setting this | # further from the root node will be omitted. Note that setting this option to 1 | |||
# option to 1 or 2 may greatly reduce the computation time needed for large | # or 2 may greatly reduce the computation time needed for large code bases. Also | |||
# code bases. Also note that the size of a graph can be further restricted by | # note that the size of a graph can be further restricted by | |||
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | |||
# Minimum value: 0, maximum value: 1000, default value: 0. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
MAX_DOT_GRAPH_DEPTH = 0 | MAX_DOT_GRAPH_DEPTH = 0 | |||
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | |||
# background. This is disabled by default, because dot on Windows does not | # background. This is disabled by default, because dot on Windows does not seem | |||
# seem to support this out of the box. Warning: Depending on the platform used, | # to support this out of the box. | |||
# enabling this option may lead to badly anti-aliased labels on the edges of | # | |||
# a graph (i.e. they become hard to read). | # Warning: Depending on the platform used, enabling this option may lead to | |||
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to | ||||
# read). | ||||
# The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_TRANSPARENT = NO | DOT_TRANSPARENT = NO | |||
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output | |||
# files in one run (i.e. multiple -o and -T options on the command line). This | # files in one run (i.e. multiple -o and -T options on the command line). This | |||
# makes dot run faster, but since only newer versions of dot (>1.8.10) | # makes dot run faster, but since only newer versions of dot (>1.8.10) support | |||
# support this, this feature is disabled by default. | # this, this feature is disabled by default. | |||
# The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_MULTI_TARGETS = YES | DOT_MULTI_TARGETS = YES | |||
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page | |||
# generate a legend page explaining the meaning of the various boxes and | # explaining the meaning of the various boxes and arrows in the dot generated | |||
# arrows in the dot generated graphs. | # graphs. | |||
# The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
GENERATE_LEGEND = YES | GENERATE_LEGEND = YES | |||
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot | |||
# remove the intermediate dot files that are used to generate | # files that are used to generate the various graphs. | |||
# the various graphs. | # The default value is: YES. | |||
# This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_CLEANUP = YES | DOT_CLEANUP = YES | |||
End of changes. 282 change blocks. | ||||
930 lines changed or deleted | 1575 lines changed or added |