Skip to content

Commit

Permalink
docs: Comment out recently added doxygen options
Browse files Browse the repository at this point in the history
These would create warnings when running with a slightly older
doxygen version. The set values were anyway the default values,
with the exception of TIMESTAMP: For some reason, running
doxygen -u in commit a9e6cab gave it the non-default YES
value.

Signed-off-by: Tormod Volden <[email protected]>
  • Loading branch information
tormodvolden committed Nov 13, 2024
1 parent bff008e commit cac025d
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions doc/doxygen.cfg.in
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ CREATE_SUBDIRS = NO
# Minimum value: 0, maximum value: 8, default value: 8.
# This tag requires that the tag CREATE_SUBDIRS is set to YES.

CREATE_SUBDIRS_LEVEL = 8
#CREATE_SUBDIRS_LEVEL = 8

# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
Expand Down Expand Up @@ -362,7 +362,7 @@ TOC_INCLUDE_HEADINGS = 5
# The default value is: DOXYGEN.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.

MARKDOWN_ID_STYLE = DOXYGEN
#MARKDOWN_ID_STYLE = DOXYGEN

# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
Expand Down Expand Up @@ -494,7 +494,7 @@ NUM_PROC_THREADS = 1
# Possible values are: YES, NO, DATETIME and DATE.
# The default value is: NO.

TIMESTAMP = YES
#TIMESTAMP = YES

#---------------------------------------------------------------------------
# Build related configuration options
Expand Down Expand Up @@ -639,7 +639,7 @@ HIDE_COMPOUND_REFERENCE= NO
# will show which file needs to be included to use the class.
# The default value is: YES.

SHOW_HEADERFILE = YES
#SHOW_HEADERFILE = YES

# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
Expand Down Expand Up @@ -857,7 +857,7 @@ WARN_IF_DOC_ERROR = YES
# parameters have no documentation without warning.
# The default value is: YES.

WARN_IF_INCOMPLETE_DOC = YES
#WARN_IF_INCOMPLETE_DOC = YES

# 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
Expand All @@ -875,7 +875,7 @@ WARN_NO_PARAMDOC = NO
# will automatically be disabled.
# The default value is: NO.

WARN_IF_UNDOC_ENUM_VAL = NO
#WARN_IF_UNDOC_ENUM_VAL = NO

# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
Expand Down Expand Up @@ -912,7 +912,7 @@ WARN_FORMAT = "$file:$line: $text"
# See also: WARN_FORMAT
# The default value is: at line $line of file $file.

WARN_LINE_FORMAT = "at line $line of file $file"
#WARN_LINE_FORMAT = "at line $line of file $file"

# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
Expand Down Expand Up @@ -953,7 +953,7 @@ INPUT_ENCODING = UTF-8
# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
# "INPUT_ENCODING" for further information on supported encodings.

INPUT_FILE_ENCODING =
#INPUT_FILE_ENCODING =

# 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
Expand Down Expand Up @@ -1112,7 +1112,7 @@ USE_MDFILE_AS_MAINPAGE =
# be processed before the automatic comment starts.
# Minimum value: 7, maximum value: 10000, default value: 72.

FORTRAN_COMMENT_AFTER = 72
#FORTRAN_COMMENT_AFTER = 72

#---------------------------------------------------------------------------
# Configuration options related to source browsing
Expand Down Expand Up @@ -1365,7 +1365,7 @@ HTML_EXTRA_FILES =
# The default value is: AUTO_LIGHT.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_COLORSTYLE = AUTO_LIGHT
#HTML_COLORSTYLE = AUTO_LIGHT

# 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
Expand Down Expand Up @@ -1421,7 +1421,7 @@ HTML_DYNAMIC_SECTIONS = YES
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_CODE_FOLDING = YES
#HTML_CODE_FOLDING = YES

# 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
Expand Down Expand Up @@ -1464,7 +1464,7 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
# (such as a company or product suite) can be grouped.
# This tag requires that the tag GENERATE_DOCSET is set to YES.

DOCSET_FEEDURL =
#DOCSET_FEEDURL =

# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
Expand Down Expand Up @@ -1561,7 +1561,7 @@ TOC_EXPAND = NO
# protocol see https://www.sitemaps.org
# This tag requires that the tag GENERATE_HTML is set to YES.

SITEMAP_URL =
#SITEMAP_URL =

# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
Expand Down Expand Up @@ -1685,7 +1685,7 @@ GENERATE_TREEVIEW = NO
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

FULL_SIDEBAR = NO
#FULL_SIDEBAR = NO

# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
Expand Down Expand Up @@ -1716,7 +1716,7 @@ EXT_LINKS_IN_WINDOW = NO
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.

OBFUSCATE_EMAILS = YES
#OBFUSCATE_EMAILS = YES

# 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
Expand Down Expand Up @@ -1764,7 +1764,7 @@ USE_MATHJAX = NO
# The default value is: MathJax_2.
# This tag requires that the tag USE_MATHJAX is set to YES.

MATHJAX_VERSION = MathJax_2
#MATHJAX_VERSION = MathJax_2

# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. For more details about the output format see MathJax
Expand Down Expand Up @@ -2261,23 +2261,23 @@ GENERATE_AUTOGEN_DEF = NO
# database with symbols found by doxygen stored in tables.
# The default value is: NO.

GENERATE_SQLITE3 = NO
#GENERATE_SQLITE3 = NO

# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
# in front of it.
# The default directory is: sqlite3.
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.

SQLITE3_OUTPUT = sqlite3
#SQLITE3_OUTPUT = sqlite3

# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
# database file will be recreated with each doxygen run. If set to NO, doxygen
# will warn if an a database file is already found and not modify it.
# The default value is: YES.
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.

SQLITE3_RECREATE_DB = YES
#SQLITE3_RECREATE_DB = YES

#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
Expand Down Expand Up @@ -2485,7 +2485,7 @@ DOT_NUM_THREADS = 0
# The default value is: fontname=Helvetica,fontsize=10.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
#DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"

# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
Expand All @@ -2494,15 +2494,15 @@ DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
# The default value is: labelfontname=Helvetica,labelfontsize=10.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
#DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"

# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
# around nodes set 'shape=plain' or 'shape=plaintext' <a
# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
# The default value is: shape=box,height=0.2,width=0.4.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
#DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"

# You can set the path where dot can find font specified with fontname in
# DOT_COMMON_ATTR and others dot attributes.
Expand Down Expand Up @@ -2668,7 +2668,7 @@ DIRECTORY_GRAPH = YES
# Minimum value: 1, maximum value: 25, default value: 1.
# This tag requires that the tag DIRECTORY_GRAPH is set to YES.

DIR_GRAPH_MAX_DEPTH = 1
#DIR_GRAPH_MAX_DEPTH = 1

# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
Expand Down Expand Up @@ -2764,7 +2764,7 @@ DOT_GRAPH_MAX_NODES = 50
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.

MAX_DOT_GRAPH_DEPTH = 0
#MAX_DOT_GRAPH_DEPTH = 0

# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
Expand Down Expand Up @@ -2802,7 +2802,7 @@ DOT_CLEANUP = YES
# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
# output file formats "png", "eps", "svg", and "ismap".

MSCGEN_TOOL =
#MSCGEN_TOOL =

# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
Expand Down

0 comments on commit cac025d

Please sign in to comment.