Changeset View
Changeset View
Standalone View
Standalone View
contrib/ldns/libdns.doxygen.in
- This file was moved from contrib/ldns/libdns.doxygen.
# Doxyfile 1.8.11 | # Doxyfile 1.9.1 | ||||
# 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 double hash (##) is considered a comment and is placed in | # All text after a double hash (##) is considered a comment and is placed in | ||||
# front of the TAG it is preceding. | # front of the TAG it is preceding. | ||||
# | # | ||||
# All text after a single hash (#) is considered a comment and will be ignored. | # 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 configuration | ||||
# that follow. The default is UTF-8 which is also the encoding used for all text | # file that follow. The default is UTF-8 which is also the encoding used for all | ||||
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv | # text before the first occurrence of this tag. Doxygen uses libiconv (or the | ||||
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv | # iconv built into libc) for the transcoding. See | ||||
# for the list of possible encodings. | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. | ||||
# The default value is: UTF-8. | # The default value is: UTF-8. | ||||
DOXYFILE_ENCODING = UTF-8 | DOXYFILE_ENCODING = UTF-8 | ||||
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by | ||||
# double-quotes, unless you are using Doxywizard) that should identify the | # double-quotes, unless you are using Doxywizard) that should identify the | ||||
# project for which the documentation is generated. This name is used in the | # project for which the documentation is generated. This name is used in the | ||||
# title of most generated pages and in a few other places. | # title of most generated pages and in a few other places. | ||||
# The default value is: My Project. | # The default value is: My Project. | ||||
PROJECT_NAME = ldns | PROJECT_NAME = @PACKAGE_NAME@ | ||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This | ||||
# could be handy for archiving the generated documentation or if some version | # could be handy for archiving the generated documentation or if some version | ||||
# control system is used. | # control system is used. | ||||
PROJECT_NUMBER = 1.7.0 | PROJECT_NUMBER = @PACKAGE_VERSION@ | ||||
# 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 a | # for a project that appears at the top of each page and should give viewer a | ||||
# quick idea about the purpose of the project. Keep the description short. | # quick idea about the purpose of the project. Keep the description short. | ||||
PROJECT_BRIEF = | PROJECT_BRIEF = | ||||
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included | ||||
Show All 38 Lines | |||||
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, | ||||
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, | ||||
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, | ||||
# Ukrainian and Vietnamese. | # Ukrainian and Vietnamese. | ||||
# The default value is: English. | # The default value is: English. | ||||
OUTPUT_LANGUAGE = English | OUTPUT_LANGUAGE = English | ||||
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all | |||||
# documentation generated by doxygen is written. Doxygen will use this | |||||
# information to generate all generated output in the proper direction. | |||||
# Possible values are: None, LTR, RTL and Context. | |||||
# The default value is: None. | |||||
OUTPUT_TEXT_DIRECTION = None | |||||
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member | ||||
# descriptions after the members that are listed in the file and class | # descriptions after the members that are listed in the file and class | ||||
# documentation (similar to Javadoc). Set to NO to disable this. | # documentation (similar to Javadoc). Set to NO to disable this. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
BRIEF_MEMBER_DESC = YES | BRIEF_MEMBER_DESC = YES | ||||
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief | ||||
▲ Show 20 Lines • Show All 70 Lines • ▼ Show 20 Lines | |||||
# first line (until the first dot) of a Javadoc-style comment as the brief | # first line (until the first dot) of a Javadoc-style comment as the brief | ||||
# description. If set to NO, the Javadoc-style will behave just like regular Qt- | # description. If set to NO, the Javadoc-style will behave just like regular Qt- | ||||
# style comments (thus requiring an explicit @brief command for a brief | # style comments (thus requiring an explicit @brief command for a brief | ||||
# description.) | # description.) | ||||
# The default value is: NO. | # The default value is: NO. | ||||
JAVADOC_AUTOBRIEF = YES | JAVADOC_AUTOBRIEF = YES | ||||
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line | |||||
# such as | |||||
# /*************** | |||||
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the | |||||
# Javadoc-style will behave just like regular comments and it will not be | |||||
# interpreted by doxygen. | |||||
# The default value is: NO. | |||||
JAVADOC_BANNER = NO | |||||
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first | ||||
# line (until the first dot) of a Qt-style comment as the brief description. If | # line (until the first dot) of a Qt-style comment as the brief description. If | ||||
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus | ||||
# requiring an explicit \brief command for a brief description.) | # requiring an explicit \brief command for a brief description.) | ||||
# The default value is: NO. | # 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 treat a | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a | ||||
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as | ||||
# a brief description. This used to be the default behavior. The new default is | # a brief description. This used to be the default behavior. The new default is | ||||
# to treat a multi-line C++ comment block as a detailed description. Set this | # to treat a multi-line C++ comment block as a detailed description. Set this | ||||
# tag to YES if you prefer the old behavior 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 | # Note that setting this tag to YES also means that rational rose comments are | ||||
# not recognized any more. | # not recognized any more. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
MULTILINE_CPP_IS_BRIEF = NO | MULTILINE_CPP_IS_BRIEF = NO | ||||
# By default Python docstrings are displayed as preformatted text and doxygen's | |||||
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the | |||||
# doxygen's special commands can be used and the contents of the docstring | |||||
# documentation blocks is shown as doxygen documentation. | |||||
# The default value is: YES. | |||||
PYTHON_DOCSTRING = YES | |||||
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the | ||||
# documentation from any documented member that it re-implements. | # documentation from any documented member that it re-implements. | ||||
# The default value is: YES. | # 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 a new | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new | ||||
# page for each member. If set to NO, the documentation of a member will be part | # page for each member. If set to NO, the documentation of a member will be part | ||||
Show All 11 Lines | |||||
# This tag can be used to specify a number of aliases that act as commands in | # This tag can be used to specify a number of aliases that act as commands in | ||||
# the documentation. An alias has the form: | # the documentation. An alias has the form: | ||||
# name=value | # name=value | ||||
# For example adding | # For example adding | ||||
# "sideeffect=@par Side Effects:\n" | # "sideeffect=@par Side Effects:\n" | ||||
# will allow you to put the command \sideeffect (or @sideeffect) in the | # will allow you to put the command \sideeffect (or @sideeffect) in the | ||||
# documentation, which will result in a user-defined paragraph with heading | # 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 | # "Side Effects:". You can put \n's in the value part of an alias to insert | ||||
# newlines. | # newlines (in the resulting output). You can put ^^ in the value part of an | ||||
# alias to insert a newline as if a physical newline was in the original file. | |||||
# When you need a literal { or } or , in the value part of an alias you have to | |||||
# escape them by means of a backslash (\), this can lead to conflicts with the | |||||
# commands \{ and \} for these it is advised to use the version @{ and @} or use | |||||
# a double escape (\\{ and \\}) | |||||
ALIASES = | ALIASES = | ||||
# 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 "class=itcl::class" | |||||
# will allow you to use the command class in the itcl::class meaning. | |||||
TCL_SUBST = | |||||
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | ||||
# only. Doxygen will then generate output that is more tailored for C. For | # only. Doxygen will then generate output that is more tailored for C. For | ||||
# instance, some of the names that are used will be different. The list of all | # instance, some of the names that are used will be different. The list of all | ||||
# members will be omitted, etc. | # members will be omitted, etc. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
OPTIMIZE_OUTPUT_FOR_C = YES | OPTIMIZE_OUTPUT_FOR_C = YES | ||||
Show All 12 Lines | |||||
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 VHDL. | # sources. Doxygen will then generate output that is tailored for VHDL. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
OPTIMIZE_OUTPUT_VHDL = NO | OPTIMIZE_OUTPUT_VHDL = NO | ||||
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice | |||||
# sources only. Doxygen will then generate output that is more tailored for that | |||||
# language. For instance, namespaces will be presented as modules, types will be | |||||
# separated into more groups, etc. | |||||
# The default value is: NO. | |||||
OPTIMIZE_OUTPUT_SLICE = 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 | # 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 | # extension. Doxygen has a built-in mapping, but you can override or extend it | ||||
# using this tag. The format is ext=language, where ext is a file extension, and | # using this tag. The format is ext=language, where ext is a file extension, and | ||||
# language is one of the parsers supported by doxygen: IDL, Java, Javascript, | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, | ||||
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, | ||||
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: | ||||
# Fortran. In the later case the parser tries to guess whether the code is fixed | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser | ||||
# or free formatted code, this is the default for Fortran type files), VHDL. For | # tries to guess whether the code is fixed or free formatted code, this is the | ||||
# instance to make doxygen treat .inc files as Fortran files (default is PHP), | # default for Fortran type files). For instance to make doxygen treat .inc files | ||||
# and .f files as C (default is Fortran), use: inc=Fortran f=C. | # 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: 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 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise | ||||
# the files are not read by doxygen. | # the files are not read by doxygen. When specifying no_extension you should add | ||||
# * to the FILE_PATTERNS. | |||||
# | |||||
# Note see also the list of default file extension mappings. | |||||
EXTENSION_MAPPING = | EXTENSION_MAPPING = | ||||
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all 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 https://daringfireball.net/projects/markdown/ for details. | ||||
# The output of markdown processing is further processed by doxygen, so you can | # The output of markdown processing is further processed by doxygen, so you can | ||||
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in | ||||
# case of backward compatibilities issues. | # case of backward compatibilities issues. | ||||
# The default value is: YES. | # 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: 5. | |||||
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. | |||||
TOC_INCLUDE_HEADINGS = 5 | |||||
# When enabled doxygen tries to link words that correspond to documented | # When enabled doxygen tries to link words that correspond to documented | ||||
# classes, or namespaces to their corresponding documentation. Such a link can | # 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 | # be prevented in individual cases by putting a % sign in front of the word or | ||||
# globally by setting AUTOLINK_SUPPORT to NO. | # globally by setting AUTOLINK_SUPPORT to NO. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
AUTOLINK_SUPPORT = YES | AUTOLINK_SUPPORT = YES | ||||
Show All 9 Lines | |||||
# 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. | # 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 (see: | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: | ||||
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen | ||||
# will parse them like normal C++ but will assume all classes use public instead | # will parse them like normal C++ but will assume all classes use public instead | ||||
# of private inheritance when no explicit protection keyword is present. | # of private inheritance when no explicit protection keyword is present. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
SIP_SUPPORT = NO | SIP_SUPPORT = NO | ||||
# For Microsoft's IDL there are propget and propput attributes to indicate | # For Microsoft's IDL there are propget and propput attributes to indicate | ||||
# getter and setter methods for a property. Setting this option to YES will make | # getter and setter methods for a property. Setting this option to YES will make | ||||
▲ Show 20 Lines • Show All 69 Lines • ▼ Show 20 Lines | |||||
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range | # 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 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 | ||||
# symbols. At the end of a run doxygen will report the cache usage and suggest | # symbols. At the end of a run doxygen will report the cache usage and suggest | ||||
# the optimal cache size from a speed point of view. | # the optimal cache size from a speed point of view. | ||||
# Minimum value: 0, maximum value: 9, default value: 0. | # Minimum value: 0, maximum value: 9, default value: 0. | ||||
LOOKUP_CACHE_SIZE = 0 | LOOKUP_CACHE_SIZE = 0 | ||||
# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use | |||||
# during processing. When set to 0 doxygen will based this on the number of | |||||
# cores available in the system. You can set it explicitly to a value larger | |||||
# than 0 to get more control over the balance between CPU load and processing | |||||
# speed. At this moment only the input processing can be done using multiple | |||||
# threads. Since this is still an experimental feature the default is set to 1, | |||||
# which efficively disables parallel processing. Please report any issues you | |||||
# encounter. Generating dot graphs in parallel is controlled by the | |||||
# DOT_NUM_THREADS setting. | |||||
# Minimum value: 0, maximum value: 32, default value: 1. | |||||
NUM_PROC_THREADS = 1 | |||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# 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. Private | # documentation are documented, even if no documentation was available. Private | ||||
# class members and static file members will be hidden unless the | # class members and static file members will be hidden unless the | ||||
# EXTRACT_PRIVATE respectively 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 | # Note: This will also disable the warnings about undocumented members that are | ||||
# normally produced when WARNINGS is set to YES. | # normally produced when WARNINGS is set to YES. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
EXTRACT_ALL = YES | EXTRACT_ALL = YES | ||||
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will | ||||
# be included in the documentation. | # be included in the documentation. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
EXTRACT_PRIVATE = NO | EXTRACT_PRIVATE = NO | ||||
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual | |||||
# methods of a class will be included in the documentation. | |||||
# The default value is: NO. | |||||
EXTRACT_PRIV_VIRTUAL = 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. | # 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 will be | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be | ||||
# included in the documentation. | # included in the documentation. | ||||
Show All 21 Lines | |||||
# 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 name of | # 'anonymous_namespace{file}', where file will be replaced with the base name of | ||||
# the file that contains the anonymous namespace. By default anonymous namespace | # the file that contains the anonymous namespace. By default anonymous namespace | ||||
# are hidden. | # are hidden. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
EXTRACT_ANON_NSPACES = NO | EXTRACT_ANON_NSPACES = NO | ||||
# If this flag is set to YES, the name of an unnamed parameter in a declaration | |||||
# will be determined by the corresponding definition. By default unnamed | |||||
# parameters remain unnamed in the output. | |||||
# The default value is: YES. | |||||
RESOLVE_UNNAMED_PARAMS = YES | |||||
# 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 inside documented classes or files. If set to NO these | # undocumented members inside documented classes or files. If set to NO these | ||||
# members will be included in the various overviews, but no documentation | # members will be included in the various overviews, but no documentation | ||||
# section is generated. This option has no effect if EXTRACT_ALL is enabled. | # section is generated. This option has no effect if EXTRACT_ALL is enabled. | ||||
# The default value is: NO. | # 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. If set | # undocumented classes that are normally visible in the class hierarchy. If set | ||||
# to NO, these classes will be included in the various overviews. This option | # to NO, these classes will be included in the various overviews. This option | ||||
# has no effect if EXTRACT_ALL is enabled. | # has no effect if EXTRACT_ALL is enabled. | ||||
# The default value is: NO. | # 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 friend | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend | ||||
# (class|struct|union) declarations. If set to NO, these declarations will be | # declarations. If set to NO, these declarations will be included in the | ||||
# included in the documentation. | # documentation. | ||||
# The default value is: NO. | # 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. If set to NO, these | # documentation blocks found inside the body of a function. If set to NO, these | ||||
# blocks will be appended to the function's detailed documentation block. | # blocks will be appended to the function's detailed documentation block. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
HIDE_IN_BODY_DOCS = NO | HIDE_IN_BODY_DOCS = NO | ||||
# The INTERNAL_DOCS tag determines if documentation that is typed after a | # The INTERNAL_DOCS tag determines if documentation that is typed after a | ||||
# \internal command is included. If the tag is set to NO then the documentation | # \internal command is included. If the tag is set to NO then the documentation | ||||
# will be excluded. Set it to YES to include the internal documentation. | # will be excluded. Set it to YES to include the internal documentation. | ||||
# The default value is: NO. | # 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 file | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be | ||||
# names in lower-case letters. If set to YES, upper-case letters are also | # able to match the capabilities of the underlying filesystem. In case the | ||||
# allowed. This is useful if you have classes or files whose names only differ | # filesystem is case sensitive (i.e. it supports files in the same directory | ||||
# in case and if your file system supports case sensitive file names. Windows | # whose names only differ in casing), the option must be set to YES to properly | ||||
# and Mac users are advised to set this option to NO. | # deal with such files in case they appear in the input. For filesystems that | ||||
# are not case sensitive the option should be be set to NO to properly deal with | |||||
# output files written for symbols that only differ in casing, such as for two | |||||
# classes, one named CLASS and the other named Class, and to also support | |||||
# references to files without having to specify the exact matching casing. On | |||||
# Windows (including Cygwin) and MacOS, users should typically set this option | |||||
# to NO, whereas on Linux or other Unix flavors it should typically be set to | |||||
# YES. | |||||
# The default value is: system dependent. | # The default value is: system dependent. | ||||
CASE_SENSE_NAMES = YES | CASE_SENSE_NAMES = YES | ||||
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with | ||||
# their full class and namespace scopes in the documentation. If set to YES, the | # their full class and namespace scopes in the documentation. If set to YES, the | ||||
# scope will be hidden. | # scope will be hidden. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
▲ Show 20 Lines • Show All 170 Lines • ▼ Show 20 Lines | |||||
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE | ||||
# tag is left empty. | # tag is left empty. | ||||
LAYOUT_FILE = | LAYOUT_FILE = | ||||
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing | ||||
# the reference definitions. This must be a list of .bib files. The .bib | # the reference definitions. This must be a list of .bib files. The .bib | ||||
# extension is automatically appended if omitted. This requires the bibtex tool | # extension is automatically appended if omitted. This requires the bibtex tool | ||||
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. | ||||
# For LaTeX the style of the bibliography can be controlled using | # For LaTeX the style of the bibliography can be controlled using | ||||
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the | ||||
# search path. See also \cite for info how to create references. | # 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 | ||||
Show All 28 Lines | |||||
# markup commands wrongly. | # markup commands wrongly. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
WARN_IF_DOC_ERROR = YES | WARN_IF_DOC_ERROR = YES | ||||
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that | ||||
# are documented, but have no documentation for their parameters or return | # are documented, but have no documentation for their parameters or return | ||||
# value. If set to NO, doxygen will only warn about wrong or incomplete | # value. If set to NO, doxygen will only warn about wrong or incomplete | ||||
# parameter documentation, but not about the absence of documentation. | # parameter documentation, but not about the absence of documentation. If | ||||
# EXTRACT_ALL is set to YES then this flag will automatically be disabled. | |||||
# The default value is: NO. | # The default value is: NO. | ||||
WARN_NO_PARAMDOC = NO | WARN_NO_PARAMDOC = NO | ||||
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when | ||||
# a warning is encountered. | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS | ||||
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but | |||||
# at the end of the doxygen process doxygen will return with a non-zero status. | |||||
# Possible values are: NO, YES and FAIL_ON_WARNINGS. | |||||
# The default value is: NO. | # The default value is: NO. | ||||
WARN_AS_ERROR = NO | WARN_AS_ERROR = NO | ||||
# The WARN_FORMAT tag determines the format of the warning messages that doxygen | # 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 | # 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 | # 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 | # and the warning text. Optionally the format may contain $version, which will | ||||
Show All 24 Lines | INPUT = . \ | ||||
doc/ \ | doc/ \ | ||||
examples/ldns-mx.c \ | examples/ldns-mx.c \ | ||||
examples/ldns-read-zone.c \ | examples/ldns-read-zone.c \ | ||||
examples/ldns-signzone.c | examples/ldns-signzone.c | ||||
# 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. Doxygen uses | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses | ||||
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv | ||||
# documentation (see: http://www.gnu.org/software/libiconv) for the list of | # documentation (see: | ||||
# possible encodings. | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. | ||||
# The default value is: UTF-8. | # 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 patterns (like *.cpp and | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and | ||||
# *.h) to filter out the source-files in the directories. | # *.h) to filter out the source-files in the directories. | ||||
# | # | ||||
# Note that for custom extensions or not directly supported extensions you also | # 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 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||||
# read by doxygen. | # read by doxygen. | ||||
# | # | ||||
# Note the list of default checked file patterns might differ from the list of | |||||
# default file extension mappings. | |||||
# | |||||
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | ||||
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | ||||
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, | ||||
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, | # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), | ||||
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. | # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, | ||||
# *.ucf, *.qsf and *.ice. | |||||
FILE_PATTERNS = | FILE_PATTERNS = | ||||
# The RECURSIVE tag can be used to specify whether or not subdirectories should | # The RECURSIVE tag can be used to specify whether or not subdirectories should | ||||
# be searched for input files as well. | # be searched for input files as well. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
RECURSIVE = NO | RECURSIVE = NO | ||||
▲ Show 20 Lines • Show All 138 Lines • ▼ Show 20 Lines | |||||
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any | ||||
# special comment blocks from generated source code fragments. Normal C, C++ and | # special comment blocks from generated source code fragments. Normal C, C++ and | ||||
# Fortran comments will always remain visible. | # Fortran comments will always remain visible. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
STRIP_CODE_COMMENTS = YES | STRIP_CODE_COMMENTS = YES | ||||
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented | ||||
# function all documented functions referencing it will be listed. | # entity all documented functions referencing it will be listed. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
REFERENCED_BY_RELATION = NO | REFERENCED_BY_RELATION = NO | ||||
# If the REFERENCES_RELATION tag is set to YES then for each documented function | # If the REFERENCES_RELATION tag is set to YES then for each documented function | ||||
# all documented entities called/used by that function will be listed. | # all documented entities called/used by that function will be listed. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
Show All 15 Lines | |||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag SOURCE_BROWSER is set to YES. | # This tag requires that the tag SOURCE_BROWSER is set to YES. | ||||
SOURCE_TOOLTIPS = YES | SOURCE_TOOLTIPS = YES | ||||
# If the USE_HTAGS tag is set to YES then the references to source code will | # 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 | # 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 | # 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 | # (see https://www.gnu.org/software/global/global.html). You will need version | ||||
# 4.8.6 or higher. | # 4.8.6 or higher. | ||||
# | # | ||||
# To use it do the following: | # To use it do the following: | ||||
# - Install the latest version of global | # - Install the latest version of global | ||||
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file | ||||
# - Make sure the INPUT points to the root of the source tree | # - Make sure the INPUT points to the root of the source tree | ||||
# - Run doxygen as normal | # - Run doxygen as normal | ||||
# | # | ||||
# Doxygen will invoke htags (and that will in turn invoke gtags), so these | # 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). | # 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 | # The result: instead of the source browser generated by doxygen, the links to | ||||
# source code will now point to the output of htags. | # source code will now point to the output of htags. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag SOURCE_BROWSER is set to YES. | # 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 the YES then doxygen will generate a | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a | ||||
# verbatim copy of the header file for each class for which an include is | # verbatim copy of the header file for each class for which an include is | ||||
# specified. Set to NO to disable this. | # specified. Set to NO to disable this. | ||||
# See also: Section \class. | # See also: Section \class. | ||||
# The default value is: YES. | # 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 | # 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 | # clang parser (see: | ||||
# cost of reduced performance. This can be particularly helpful with template | # http://clang.llvm.org/) for more accurate parsing at the cost of reduced | ||||
# rich C++ code for which doxygen's built-in parser lacks the necessary type | # performance. This can be particularly helpful with template rich C++ code for | ||||
# information. | # which doxygen's built-in parser lacks the necessary type information. | ||||
# Note: The availability of this option depends on whether or not doxygen was | # Note: The availability of this option depends on whether or not doxygen was | ||||
# generated with the -Duse-libclang=ON option for CMake. | # generated with the -Duse_libclang=ON option for CMake. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
CLANG_ASSISTED_PARSING = NO | CLANG_ASSISTED_PARSING = NO | ||||
# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to | |||||
# YES then doxygen will add the directory of each input to the include path. | |||||
# The default value is: YES. | |||||
CLANG_ADD_INC_PATHS = YES | |||||
# If clang assisted parsing is enabled you can provide the compiler with command | # 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 | # 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 | # the include paths will already be set by doxygen for the files and directories | ||||
# specified with INPUT and INCLUDE_PATH. | # specified with INPUT and INCLUDE_PATH. | ||||
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | ||||
CLANG_OPTIONS = | CLANG_OPTIONS = | ||||
# If clang assisted parsing is enabled you can provide the clang parser with the | |||||
# path to the directory containing a file called compile_commands.json. This | |||||
# file is the compilation database (see: | |||||
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the | |||||
# options used when the source files were built. This is equivalent to | |||||
# specifying the -p option to a clang tool, such as clang-check. These options | |||||
# will then be passed to the parser. Any options specified with CLANG_OPTIONS | |||||
# will be added as well. | |||||
# Note: The availability of this option depends on whether or not doxygen was | |||||
# generated with the -Duse_libclang=ON option for CMake. | |||||
CLANG_DATABASE_PATH = | |||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# 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 of all | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all | ||||
# compounds will be generated. Enable this if the project contains a lot of | # compounds will be generated. Enable this if the project contains a lot of | ||||
# classes, structs, unions or interfaces. | # classes, structs, unions or interfaces. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
ALPHABETICAL_INDEX = YES | ALPHABETICAL_INDEX = YES | ||||
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in | |||||
# which the alphabetical index list will be split. | |||||
# 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 = 3 | |||||
# In case all classes in a project start with a common prefix, all classes will | # In case all classes in a project start with a common prefix, all classes will | ||||
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag | ||||
# can be used to specify a prefix (or a list of prefixes) that should be ignored | # can be used to specify a prefix (or a list of prefixes) that 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. | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | ||||
IGNORE_PREFIX = ldns_ | IGNORE_PREFIX = ldns_ | ||||
▲ Show 20 Lines • Show All 84 Lines • ▼ Show 20 Lines | |||||
# 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. | # 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. Doxygen | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen | ||||
# will adjust the colors in the style sheet and background images according to | # will adjust the colors in the style sheet and background images according to | ||||
# this color. Hue is specified as an angle on a colorwheel, see | # this color. Hue is specified as an angle on a colorwheel, see | ||||
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value | ||||
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 | ||||
# purple, and 360 is red again. | # purple, and 360 is red again. | ||||
# Minimum value: 0, maximum value: 359, default value: 220. | # Minimum value: 0, maximum value: 359, default value: 220. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # 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 colors | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors | ||||
Show All 19 Lines | |||||
# page will contain the date and time when the page was generated. Setting this | # page will contain the date and time when the page was generated. Setting this | ||||
# to YES can help to show when doxygen was last run and thus if the | # to YES can help to show when doxygen was last run and thus if the | ||||
# documentation is up to date. | # documentation is up to date. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # This tag requires that the tag GENERATE_HTML is set to YES. | ||||
HTML_TIMESTAMP = YES | HTML_TIMESTAMP = YES | ||||
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML | |||||
# documentation will contain a main index with vertical navigation menus that | |||||
# are dynamically created via JavaScript. If disabled, the navigation index will | |||||
# consists of multiple levels of tabs that are statically embedded in every HTML | |||||
# page. Disable this option to support browsers that do not have JavaScript, | |||||
# like the Qt help browser. | |||||
# The default value is: YES. | |||||
# This tag requires that the tag GENERATE_HTML is set to YES. | |||||
HTML_DYNAMIC_MENUS = 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. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # 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 entries | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries | ||||
# shown in the various tree structured indices initially; the user can expand | # shown in the various tree structured indices initially; the user can expand | ||||
# and collapse entries dynamically later on. Doxygen will expand the tree to | # and collapse entries dynamically later on. Doxygen will expand the tree to | ||||
# such a level that at most the specified number of entries are visible (unless | # such a level that at most the specified number of entries are visible (unless | ||||
# a fully collapsed tree already exceeds this amount). So setting the number of | # a fully collapsed tree already exceeds this amount). So setting the number of | ||||
# entries 1 will produce a full collapsed tree by default. 0 is a special value | # entries 1 will produce a full collapsed tree by default. 0 is a special value | ||||
# representing an infinite number of entries and will result in a full expanded | # representing an infinite number of entries and will result in a full expanded | ||||
# tree by default. | # tree by default. | ||||
# Minimum value: 0, maximum value: 9999, default value: 100. | # Minimum value: 0, maximum value: 9999, default value: 100. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # 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 will be | # If the GENERATE_DOCSET tag is set to YES, additional index files will be | ||||
# generated that can be used as input for Apple's Xcode 3 integrated development | # generated that can be used as input for Apple's Xcode 3 integrated development | ||||
# environment (see: http://developer.apple.com/tools/xcode/), introduced with | # environment (see: | ||||
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To | ||||
# Makefile in the HTML output directory. Running make will produce the docset in | # create a documentation set, doxygen will generate a Makefile in the HTML | ||||
# that directory and running make install will install the docset in | # output directory. Running make will produce the docset in that directory and | ||||
# running make install will install the docset in | |||||
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at | ||||
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy | ||||
# for more information. | # genXcode/_index.html for more information. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # This tag requires that the tag GENERATE_HTML is set to YES. | ||||
GENERATE_DOCSET = NO | GENERATE_DOCSET = NO | ||||
# This tag determines the name of the docset feed. A documentation feed provides | # This tag determines the name of the docset feed. A documentation feed provides | ||||
# an umbrella under which multiple documentation sets from a single provider | # an umbrella under which multiple documentation sets from a single provider | ||||
# (such as a company or product suite) can be grouped. | # (such as a company or product suite) can be grouped. | ||||
Show All 22 Lines | |||||
# The default value is: Publisher. | # The default value is: Publisher. | ||||
# This tag requires that the tag GENERATE_DOCSET is set to YES. | # 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 then doxygen generates three | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three | ||||
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The | ||||
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop | ||||
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on | # (see: | ||||
# Windows. | # https://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 | # 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 | # 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 | # 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 | # 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 | # 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 | # words in the documentation. The HTML workshop also contains a viewer for | ||||
# compressed HTML files. | # compressed HTML files. | ||||
Show All 13 Lines | |||||
# including file name) of the HTML help compiler (hhc.exe). If non-empty, | # including file name) of the HTML help compiler (hhc.exe). If non-empty, | ||||
# doxygen will try to run the HTML help compiler on the generated index.hhp. | # doxygen will try to run the HTML help compiler on the generated index.hhp. | ||||
# The file has to be specified with full path. | # The file has to be specified with full path. | ||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||||
HHC_LOCATION = | HHC_LOCATION = | ||||
# The GENERATE_CHI flag controls if a separate .chi index file is generated | # The GENERATE_CHI flag controls if a separate .chi index file is generated | ||||
# (YES) or that it should be included in the master .chm file (NO). | # (YES) or that it should be included in the main .chm file (NO). | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||||
GENERATE_CHI = NO | GENERATE_CHI = NO | ||||
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) | ||||
# and project file content. | # and project file content. | ||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||||
Show All 28 Lines | |||||
# the file name of the resulting .qch file. The path specified is relative to | # the file name of the resulting .qch file. 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. | # 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 Qt Help | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help | ||||
# Project output. For more information please see Qt Help Project / Namespace | # Project output. For more information please see Qt Help Project / Namespace | ||||
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). | # (see: | ||||
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). | |||||
# The default value is: org.doxygen.Project. | # The default value is: org.doxygen.Project. | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | # 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 Qt | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt | ||||
# Help Project output. For more information please see Qt Help Project / Virtual | # Help Project output. For more information please see Qt Help Project / Virtual | ||||
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- | # Folders (see: | ||||
# folders). | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). | ||||
# The default value is: doc. | # The default value is: doc. | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | # This tag requires that the tag GENERATE_QHP is set to YES. | ||||
QHP_VIRTUAL_FOLDER = doc | QHP_VIRTUAL_FOLDER = doc | ||||
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom | ||||
# filter to add. For more information please see Qt Help Project / Custom | # filter to add. For more information please see Qt Help Project / Custom | ||||
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- | # Filters (see: | ||||
# filters). | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | # This tag requires that the tag GENERATE_QHP is set to YES. | ||||
QHP_CUST_FILTER_NAME = | QHP_CUST_FILTER_NAME = | ||||
# The QHP_CUST_FILTER_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 Qt Help Project / Custom | # custom filter to add. For more information please see Qt Help Project / Custom | ||||
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- | # Filters (see: | ||||
# filters). | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | # 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 filter section matches. Qt Help Project / Filter Attributes (see: | # project's filter section matches. Qt Help Project / Filter Attributes (see: | ||||
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | # This tag requires that the tag GENERATE_QHP is set to YES. | ||||
QHP_SECT_FILTER_ATTRS = | QHP_SECT_FILTER_ATTRS = | ||||
# The QHG_LOCATION tag can be used to specify the location of Qt's | # The QHG_LOCATION tag can be used to specify the location (absolute path | ||||
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to | ||||
# generated .qhp file. | # run qhelpgenerator on the generated .qhp file. | ||||
# This tag requires that the tag GENERATE_QHP is set to YES. | # 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 will be | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be | ||||
# generated, together with the HTML files, they form an Eclipse help plugin. To | # generated, together with the HTML files, they form an Eclipse help plugin. To | ||||
# install this plugin and make it available under the help contents menu in | # install this plugin and make it available under the help contents menu in | ||||
# Eclipse, the contents of the directory containing the HTML and XML files needs | # Eclipse, the contents of the directory containing the HTML and XML files needs | ||||
▲ Show 20 Lines • Show All 60 Lines • ▼ Show 20 Lines | |||||
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to | ||||
# external symbols imported via tag files in a separate window. | # external symbols imported via tag files in a separate window. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # This tag requires that the tag GENERATE_HTML is set to YES. | ||||
EXT_LINKS_IN_WINDOW = NO | EXT_LINKS_IN_WINDOW = NO | ||||
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg | |||||
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see | |||||
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for | |||||
# the HTML output. These images will generally look nicer at scaled resolutions. | |||||
# Possible values are: png (the default) and svg (looks nicer but requires the | |||||
# pdf2svg or inkscape tool). | |||||
# The default value is: png. | |||||
# This tag requires that the tag GENERATE_HTML is set to YES. | |||||
HTML_FORMULA_FORMAT = png | |||||
# Use this tag to change the font size of LaTeX formulas included as images in | # Use this tag to change the font size of LaTeX formulas included as images in | ||||
# the HTML documentation. When you change the font size after a successful | # the HTML documentation. When you change the font size after a successful | ||||
# doxygen run you need to manually remove any form_*.png images from the HTML | # doxygen run you need to manually remove any form_*.png images from the HTML | ||||
# output directory to force them to be regenerated. | # output directory to force them to be regenerated. | ||||
# Minimum value: 8, maximum value: 50, default value: 10. | # Minimum value: 8, maximum value: 50, default value: 10. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # 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_TRANSPARENT tag to determine whether or not the images | ||||
# generated for formulas are transparent PNGs. Transparent PNGs are not | # generated for formulas are transparent PNGs. Transparent PNGs are 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 | # 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 HTML output directory before the changes have effect. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # This tag requires that the tag GENERATE_HTML is set to YES. | ||||
FORMULA_TRANSPARENT = YES | FORMULA_TRANSPARENT = YES | ||||
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands | |||||
# to create new LaTeX commands to be used in formulas as building blocks. See | |||||
# the section "Including formulas" for details. | |||||
FORMULA_MACROFILE = | |||||
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see | ||||
# http://www.mathjax.org) which uses client side Javascript for the rendering | # https://www.mathjax.org) which uses client side JavaScript for the rendering | ||||
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX | ||||
# installed or if you want to formulas look prettier in the HTML output. When | # installed or if you want to formulas look prettier in the HTML output. When | ||||
# enabled you may also need to install MathJax separately and configure the path | # enabled you may also need to install MathJax separately and configure the path | ||||
# to it using the MATHJAX_RELPATH option. | # to it using the MATHJAX_RELPATH option. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # This tag requires that the tag GENERATE_HTML is set to YES. | ||||
USE_MATHJAX = NO | USE_MATHJAX = NO | ||||
# When MathJax is enabled you can set the default output format to be used for | # When MathJax is enabled you can set the default output format to be used for | ||||
# the MathJax output. See the MathJax site (see: | # the MathJax output. See the MathJax site (see: | ||||
# http://docs.mathjax.org/en/latest/output.html) for more details. | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. | ||||
# Possible values are: HTML-CSS (which is slower, but has the best | # Possible values are: HTML-CSS (which is slower, but has the best | ||||
# compatibility), NativeMML (i.e. MathML) and SVG. | # compatibility), NativeMML (i.e. MathML) and SVG. | ||||
# The default value is: HTML-CSS. | # The default value is: HTML-CSS. | ||||
# This tag requires that the tag USE_MATHJAX is set to YES. | # This tag requires that the tag USE_MATHJAX is set to YES. | ||||
MATHJAX_FORMAT = HTML-CSS | MATHJAX_FORMAT = HTML-CSS | ||||
# When MathJax is enabled you need to specify the location relative to the HTML | # When MathJax is enabled you need to specify the location relative to the HTML | ||||
# output directory using the MATHJAX_RELPATH option. The destination directory | # output directory using the MATHJAX_RELPATH option. The destination directory | ||||
# should contain the MathJax.js script. For instance, if the mathjax 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 | # is located at the same level as the HTML output directory, then | ||||
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax | ||||
# Content Delivery Network so you can quickly see the result without installing | # 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. However, it is strongly recommended to install a local copy of | ||||
# MathJax from http://www.mathjax.org before deployment. | # MathJax from https://www.mathjax.org before deployment. | ||||
# The default value is: http://cdn.mathjax.org/mathjax/latest. | # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. | ||||
# This tag requires that the tag USE_MATHJAX is set to YES. | # This tag requires that the tag USE_MATHJAX is set to YES. | ||||
MATHJAX_RELPATH = http://www.mathjax.org/mathjax | MATHJAX_RELPATH = http://www.mathjax.org/mathjax | ||||
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax | ||||
# extension names that should be enabled during MathJax rendering. For example | # extension names that should be enabled during MathJax rendering. For example | ||||
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols | ||||
# This tag requires that the tag USE_MATHJAX is set to YES. | # This tag requires that the tag USE_MATHJAX is set to YES. | ||||
MATHJAX_EXTENSIONS = | MATHJAX_EXTENSIONS = | ||||
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces | ||||
# of code that will be used on startup of the MathJax code. See the MathJax site | # of code that will be used on startup of the MathJax code. See the MathJax site | ||||
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an | # (see: | ||||
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an | |||||
# example see the documentation. | # example see the documentation. | ||||
# This tag requires that the tag USE_MATHJAX is set to YES. | # This tag requires that the tag USE_MATHJAX is set to YES. | ||||
MATHJAX_CODEFILE = | MATHJAX_CODEFILE = | ||||
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for | # 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 | # the HTML output. The underlying search engine uses javascript and DHTML and | ||||
# should work on any modern browser. Note that when using HTML help | # should work on any modern browser. Note that when using HTML help | ||||
Show All 11 Lines | |||||
# to select a filter and <Enter> or <escape> to activate or cancel the filter | # to select a filter and <Enter> or <escape> to activate or cancel the filter | ||||
# option. | # option. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag GENERATE_HTML is set to 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 web server instead of a web client using Javascript. There | # implemented using a web server instead of a web client using JavaScript. There | ||||
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH | # are two flavors of web server based searching depending on the EXTERNAL_SEARCH | ||||
# setting. When disabled, doxygen will generate a PHP script for searching and | # setting. When disabled, doxygen will generate a PHP script for searching and | ||||
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing | # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing | ||||
# and searching needs to be provided by external tools. See the section | # and searching needs to be provided by external tools. See the section | ||||
# "External Indexing and Searching" for details. | # "External Indexing and Searching" for details. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag SEARCHENGINE is set to YES. | # 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 | # 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 | # 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 | # 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 | # external search engine pointed to by the SEARCHENGINE_URL option to obtain the | ||||
# search results. | # search results. | ||||
# | # | ||||
# Doxygen ships with an example indexer (doxyindexer) and search engine | # Doxygen ships with an example indexer (doxyindexer) and search engine | ||||
# (doxysearch.cgi) which are based on the open source search engine library | # (doxysearch.cgi) which are based on the open source search engine library | ||||
# Xapian (see: http://xapian.org/). | # Xapian (see: | ||||
# https://xapian.org/). | |||||
# | # | ||||
# See the section "External Indexing and Searching" for details. | # See the section "External Indexing and Searching" for details. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag SEARCHENGINE is set to YES. | # This tag requires that the tag SEARCHENGINE is set to YES. | ||||
EXTERNAL_SEARCH = NO | EXTERNAL_SEARCH = NO | ||||
# The SEARCHENGINE_URL should point to a search engine hosted by a web server | # 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. | # which will return the search results when EXTERNAL_SEARCH is enabled. | ||||
# | # | ||||
# Doxygen ships with an example indexer (doxyindexer) and search engine | # Doxygen ships with an example indexer (doxyindexer) and search engine | ||||
# (doxysearch.cgi) which are based on the open source search engine library | # (doxysearch.cgi) which are based on the open source search engine library | ||||
# Xapian (see: http://xapian.org/). See the section "External Indexing and | # Xapian (see: | ||||
# Searching" for details. | # https://xapian.org/). See the section "External Indexing and Searching" for | ||||
# details. | |||||
# This tag requires that the tag SEARCHENGINE is set to YES. | # This tag requires that the tag SEARCHENGINE is set to YES. | ||||
SEARCHENGINE_URL = | SEARCHENGINE_URL = | ||||
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed | # 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 | # 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. | # SEARCHDATA_FILE tag the name of this file can be specified. | ||||
# The default file is: searchdata.xml. | # The default file is: searchdata.xml. | ||||
Show All 34 Lines | |||||
# The default directory is: latex. | # The default directory is: latex. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # 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. | # invoked. | ||||
# | # | ||||
# Note that when enabling USE_PDFLATEX this option is only used for generating | # Note that when not enabling USE_PDFLATEX the default is latex when enabling | ||||
# bitmaps for formulas in the HTML output, but not in the Makefile that is | # USE_PDFLATEX the default is pdflatex and when in the later case latex is | ||||
# written to the output directory. | # chosen this is overwritten by pdflatex. For specific output languages the | ||||
# The default file is: latex. | # default can have been set differently, this depends on the implementation of | ||||
# the output language. | |||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # 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 generate | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate | ||||
# index for LaTeX. | # index for LaTeX. | ||||
# Note: This tag is used in the Makefile / make.bat. | |||||
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file | |||||
# (.tex). | |||||
# The default file is: makeindex. | # The default file is: makeindex. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
MAKEINDEX_CMD_NAME = makeindex | MAKEINDEX_CMD_NAME = makeindex | ||||
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to | |||||
# generate index for LaTeX. In case there is no backslash (\) as first character | |||||
# it will be automatically added in the LaTeX code. | |||||
# Note: This tag is used in the generated output file (.tex). | |||||
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. | |||||
# The default value is: makeindex. | |||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | |||||
LATEX_MAKEINDEX_CMD = makeindex | |||||
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX | # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX | ||||
# documents. This may be useful for small projects and may help to save some | # documents. This may be useful for small projects and may help to save some | ||||
# trees in general. | # trees in general. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
COMPACT_LATEX = NO | COMPACT_LATEX = NO | ||||
▲ Show 20 Lines • Show All 68 Lines • ▼ Show 20 Lines | |||||
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will | # 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 | # contain links (just like the HTML output) instead of page references. This | ||||
# makes the output suitable for online browsing using a PDF viewer. | # makes the output suitable for online browsing using a PDF viewer. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
PDF_HYPERLINKS = YES | PDF_HYPERLINKS = YES | ||||
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate | # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as | ||||
# the PDF file directly from the LaTeX files. Set this option to YES, to get a | # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX | ||||
# higher quality PDF documentation. | # files. Set this option to YES, to get a higher quality PDF documentation. | ||||
# | |||||
# See also section LATEX_CMD_NAME for selecting the engine. | |||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
USE_PDFLATEX = YES | USE_PDFLATEX = YES | ||||
# 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 running | # command to the generated LaTeX files. This will instruct LaTeX to keep running | ||||
# if errors occur, instead of asking the user for help. This option is also used | # if errors occur, instead of asking the user for help. This option is also used | ||||
Show All 17 Lines | |||||
# SOURCE_BROWSER. | # SOURCE_BROWSER. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # 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. See | # bibliography, e.g. plainnat, or ieeetr. See | ||||
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. | # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. | ||||
# The default value is: plain. | # The default value is: plain. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # 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 | # 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 | # 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. | # to NO can help when comparing the output of multiple runs. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_TIMESTAMP = NO | LATEX_TIMESTAMP = NO | ||||
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) | |||||
# path from which the emoji images will be read. If a relative path is entered, | |||||
# it will be relative to the LATEX_OUTPUT directory. If left blank the | |||||
# LATEX_OUTPUT directory will be used. | |||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | |||||
LATEX_EMOJI_DIRECTORY = | |||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# 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. The | # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The | ||||
# RTF output is optimized for Word 97 and may not look too pretty with other RTF | # RTF output is optimized for Word 97 and may not look too pretty with other RTF | ||||
# readers/editors. | # readers/editors. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
Show All 23 Lines | |||||
# 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. | # The default value is: NO. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | # This tag requires that the tag GENERATE_RTF is set to YES. | ||||
RTF_HYPERLINKS = NO | RTF_HYPERLINKS = NO | ||||
# Load stylesheet definitions from file. Syntax is similar to doxygen's config | # Load stylesheet definitions from file. Syntax is similar to doxygen's | ||||
# file, i.e. a series of assignments. You only have to provide replacements, | # configuration file, i.e. a series of assignments. You only have to provide | ||||
# missing definitions are set to their default value. | # replacements, missing definitions are set to their default value. | ||||
# | # | ||||
# See also section "Doxygen usage" for information on how to generate the | # See also section "Doxygen usage" for information on how to generate the | ||||
# default style sheet that doxygen normally uses. | # default style sheet that doxygen normally uses. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | # 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. Syntax is | # Set optional variables used in the generation of an RTF document. Syntax is | ||||
# similar to doxygen's config file. A template extensions file can be generated | # similar to doxygen's configuration file. A template extensions file can be | ||||
# using doxygen -e rtf extensionFile. | # generated using doxygen -e rtf extensionFile. | ||||
# This tag requires that the tag GENERATE_RTF is set to YES. | # 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 | # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code | ||||
# with syntax highlighting in the RTF output. | # with syntax highlighting in the RTF output. | ||||
# | # | ||||
# Note that which sources are shown also depends on other settings such as | # Note that which sources are shown also depends on other settings such as | ||||
▲ Show 20 Lines • Show All 69 Lines • ▼ Show 20 Lines | |||||
# listings (including syntax highlighting and cross-referencing information) to | # listings (including syntax highlighting and cross-referencing information) to | ||||
# the XML output. Note that enabling this will significantly increase the size | # the XML output. Note that enabling this will significantly increase the size | ||||
# of the XML output. | # of the XML output. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag GENERATE_XML is set to YES. | # This tag requires that the tag GENERATE_XML is set to YES. | ||||
XML_PROGRAMLISTING = YES | XML_PROGRAMLISTING = YES | ||||
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include | |||||
# namespace members in file scope as well, matching the HTML output. | |||||
# The default value is: NO. | |||||
# This tag requires that the tag GENERATE_XML is set to YES. | |||||
XML_NS_MEMB_FILE_SCOPE = NO | |||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# Configuration options related to the DOCBOOK output | # Configuration options related to the DOCBOOK output | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files | # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files | ||||
# that can be used to generate PDF. | # that can be used to generate PDF. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
Show All 16 Lines | |||||
DOCBOOK_PROGRAMLISTING = NO | DOCBOOK_PROGRAMLISTING = NO | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# Configuration options for the AutoGen Definitions output | # Configuration options for the AutoGen Definitions output | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an | # 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 | # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures | ||||
# structure of the code including all documentation. Note that this feature is | # the structure of the code including all documentation. Note that this feature | ||||
# still experimental and incomplete at the moment. | # is still experimental and incomplete at the moment. | ||||
# The default value is: NO. | # 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 | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
▲ Show 20 Lines • Show All 150 Lines • ▼ Show 20 Lines | |||||
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in | # 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 | # the related pages index. If set to NO, only the current project's pages will | ||||
# be listed. | # be listed. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
EXTERNAL_PAGES = YES | EXTERNAL_PAGES = YES | ||||
# The PERL_PATH should be the absolute path and name of the perl script | |||||
# interpreter (i.e. the result of 'which perl'). | |||||
# The default file (with absolute path) is: /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, doxygen will generate a class diagram | # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram | ||||
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to | ||||
# NO turns the diagrams off. Note that this option also works with HAVE_DOT | # NO turns the diagrams off. Note that this option also works with HAVE_DOT | ||||
# disabled, but it is recommended to install and use dot, since it yields more | # disabled, but it is recommended to install and use dot, since it yields more | ||||
# powerful graphs. | # powerful graphs. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
CLASS_DIAGRAMS = YES | CLASS_DIAGRAMS = YES | ||||
# You can define message sequence charts within doxygen comments using the \msc | |||||
# command. Doxygen will then run the mscgen tool (see: | |||||
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the | |||||
# documentation. The MSCGEN_PATH tag allows you to specify the directory where | |||||
# the mscgen tool resides. If left empty the tool is assumed to be found in the | |||||
# default search path. | |||||
MSCGEN_PATH = | |||||
# You can include diagrams made with dia in doxygen documentation. Doxygen will | # You can include diagrams made with dia in doxygen documentation. Doxygen will | ||||
# then run dia to produce the diagram and insert it in the documentation. The | # then run dia to produce the diagram and insert it in the documentation. The | ||||
# DIA_PATH tag allows you to specify the directory where the dia binary resides. | # 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. | # If left empty dia is assumed to be found in the default search path. | ||||
DIA_PATH = | DIA_PATH = | ||||
# If set to YES the inheritance and collaboration graphs will hide inheritance | # If set to YES the inheritance and collaboration graphs will hide inheritance | ||||
▲ Show 20 Lines • Show All 81 Lines • ▼ Show 20 Lines | |||||
# class node. If there are many fields or methods and many nodes the graph may | # class node. If there are many fields or methods and many nodes the graph may | ||||
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the | # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the | ||||
# number of items for each type to make the size more manageable. Set this to 0 | # number of items for each type to make the size more manageable. Set this to 0 | ||||
# for no limit. Note that the threshold may be exceeded by 50% before the limit | # for no limit. Note that the threshold may be exceeded by 50% before the limit | ||||
# is enforced. So when you set the threshold to 10, up to 15 fields may appear, | # 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 | # but if the number exceeds 15, the total amount of fields shown is limited to | ||||
# 10. | # 10. | ||||
# Minimum value: 0, maximum value: 100, default value: 10. | # Minimum value: 0, maximum value: 100, default value: 10. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | # This tag requires that the tag UML_LOOK is set to YES. | ||||
UML_LIMIT_NUM_FIELDS = 10 | UML_LIMIT_NUM_FIELDS = 10 | ||||
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and | |||||
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS | |||||
# tag is set to YES, doxygen will add type and arguments for attributes and | |||||
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen | |||||
# will not generate fields with class member information in the UML graphs. The | |||||
# class diagrams will look similar to the default class diagrams but using UML | |||||
# notation for the relationships. | |||||
# Possible values are: NO, YES and NONE. | |||||
# The default value is: NO. | |||||
# This tag requires that the tag UML_LOOK is set to YES. | |||||
DOT_UML_DETAILS = NO | |||||
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters | |||||
# to display on a single line. If the actual line length exceeds this threshold | |||||
# significantly it will wrapped across multiple lines. Some heuristics are apply | |||||
# to avoid ugly line breaks. | |||||
# Minimum value: 0, maximum value: 1000, default value: 17. | |||||
# This tag requires that the tag HAVE_DOT is set to YES. | |||||
DOT_WRAP_THRESHOLD = 17 | |||||
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and | ||||
# collaboration graphs will show the relations between templates and their | # collaboration graphs will show the relations between templates and their | ||||
# instances. | # instances. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | # This tag requires that the tag HAVE_DOT is set to YES. | ||||
TEMPLATE_RELATIONS = NO | TEMPLATE_RELATIONS = NO | ||||
▲ Show 20 Lines • Show All 112 Lines • ▼ Show 20 Lines | |||||
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the | # 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 | # 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 | # 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 | # generate a warning when it encounters a \startuml command in this case and | ||||
# will not generate output for the diagram. | # will not generate output for the diagram. | ||||
PLANTUML_JAR_PATH = | 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 | # When using plantuml, the specified paths are searched for files specified by | ||||
# the !include statement in a plantuml block. | # the !include statement in a plantuml block. | ||||
PLANTUML_INCLUDE_PATH = | PLANTUML_INCLUDE_PATH = | ||||
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes | # 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 | # 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 | # larger than this value, doxygen will truncate the graph, which is visualized | ||||
▲ Show 20 Lines • Show All 42 Lines • ▼ Show 20 Lines | |||||
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page | ||||
# explaining the meaning of the various boxes and arrows in the dot generated | # explaining the meaning of the various boxes and arrows in the dot generated | ||||
# graphs. | # graphs. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to 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, doxygen will remove the intermediate dot | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate | ||||
# files that are used to generate the various graphs. | # files that are used to generate the various graphs. | ||||
# | |||||
# Note: This setting is not only used for dot files but also for msc and | |||||
# plantuml temporary files. | |||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | |||||
DOT_CLEANUP = YES | DOT_CLEANUP = YES |