Skip to content

Commit cac025d

Browse files
committed
docs: Comment out recently added doxygen options
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]>
1 parent bff008e commit cac025d

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

doc/doxygen.cfg.in

+25-25
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ CREATE_SUBDIRS = NO
9090
# Minimum value: 0, maximum value: 8, default value: 8.
9191
# This tag requires that the tag CREATE_SUBDIRS is set to YES.
9292

93-
CREATE_SUBDIRS_LEVEL = 8
93+
#CREATE_SUBDIRS_LEVEL = 8
9494

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

365-
MARKDOWN_ID_STYLE = DOXYGEN
365+
#MARKDOWN_ID_STYLE = DOXYGEN
366366

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

497-
TIMESTAMP = YES
497+
#TIMESTAMP = YES
498498

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

642-
SHOW_HEADERFILE = YES
642+
#SHOW_HEADERFILE = YES
643643

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

860-
WARN_IF_INCOMPLETE_DOC = YES
860+
#WARN_IF_INCOMPLETE_DOC = YES
861861

862862
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
863863
# are documented, but have no documentation for their parameters or return
@@ -875,7 +875,7 @@ WARN_NO_PARAMDOC = NO
875875
# will automatically be disabled.
876876
# The default value is: NO.
877877

878-
WARN_IF_UNDOC_ENUM_VAL = NO
878+
#WARN_IF_UNDOC_ENUM_VAL = NO
879879

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

915-
WARN_LINE_FORMAT = "at line $line of file $file"
915+
#WARN_LINE_FORMAT = "at line $line of file $file"
916916

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

956-
INPUT_FILE_ENCODING =
956+
#INPUT_FILE_ENCODING =
957957

958958
# If the value of the INPUT tag contains directories, you can use the
959959
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
@@ -1112,7 +1112,7 @@ USE_MDFILE_AS_MAINPAGE =
11121112
# be processed before the automatic comment starts.
11131113
# Minimum value: 7, maximum value: 10000, default value: 72.
11141114

1115-
FORTRAN_COMMENT_AFTER = 72
1115+
#FORTRAN_COMMENT_AFTER = 72
11161116

11171117
#---------------------------------------------------------------------------
11181118
# Configuration options related to source browsing
@@ -1365,7 +1365,7 @@ HTML_EXTRA_FILES =
13651365
# The default value is: AUTO_LIGHT.
13661366
# This tag requires that the tag GENERATE_HTML is set to YES.
13671367

1368-
HTML_COLORSTYLE = AUTO_LIGHT
1368+
#HTML_COLORSTYLE = AUTO_LIGHT
13691369

13701370
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
13711371
# will adjust the colors in the style sheet and background images according to
@@ -1421,7 +1421,7 @@ HTML_DYNAMIC_SECTIONS = YES
14211421
# The default value is: YES.
14221422
# This tag requires that the tag GENERATE_HTML is set to YES.
14231423

1424-
HTML_CODE_FOLDING = YES
1424+
#HTML_CODE_FOLDING = YES
14251425

14261426
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
14271427
# shown in the various tree structured indices initially; the user can expand
@@ -1464,7 +1464,7 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
14641464
# (such as a company or product suite) can be grouped.
14651465
# This tag requires that the tag GENERATE_DOCSET is set to YES.
14661466

1467-
DOCSET_FEEDURL =
1467+
#DOCSET_FEEDURL =
14681468

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

1564-
SITEMAP_URL =
1564+
#SITEMAP_URL =
15651565

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

1688-
FULL_SIDEBAR = NO
1688+
#FULL_SIDEBAR = NO
16891689

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

1719-
OBFUSCATE_EMAILS = YES
1719+
#OBFUSCATE_EMAILS = YES
17201720

17211721
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
17221722
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
@@ -1764,7 +1764,7 @@ USE_MATHJAX = NO
17641764
# The default value is: MathJax_2.
17651765
# This tag requires that the tag USE_MATHJAX is set to YES.
17661766

1767-
MATHJAX_VERSION = MathJax_2
1767+
#MATHJAX_VERSION = MathJax_2
17681768

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

2264-
GENERATE_SQLITE3 = NO
2264+
#GENERATE_SQLITE3 = NO
22652265

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

2272-
SQLITE3_OUTPUT = sqlite3
2272+
#SQLITE3_OUTPUT = sqlite3
22732273

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

2280-
SQLITE3_RECREATE_DB = YES
2280+
#SQLITE3_RECREATE_DB = YES
22812281

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

2488-
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2488+
#DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
24892489

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

2497-
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
2497+
#DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
24982498

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

2505-
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
2505+
#DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
25062506

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

2671-
DIR_GRAPH_MAX_DEPTH = 1
2671+
#DIR_GRAPH_MAX_DEPTH = 1
26722672

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

2767-
MAX_DOT_GRAPH_DEPTH = 0
2767+
#MAX_DOT_GRAPH_DEPTH = 0
27682768

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

2805-
MSCGEN_TOOL =
2805+
#MSCGEN_TOOL =
28062806

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

0 commit comments

Comments
 (0)