Skip to content

Commit bd6fece

Browse files
Reset several Doxygen options to their default values
The goal is to minimize the output of `doxygen -x DOCS/Doxyfile` so that it contains only the settings specified in CMakeLists.txt. In all cases, the changed values are intended to match what CMake is generating when using -DBUILD_HTML_DOCUMENTATION=ON, and ideally the changes should have no effect. Comments for ABBREVIATE_BRIEF and EXAMPLE_PATTERNS describe the default behavior when they are blank, but our blank values show up in the output of `doxygen -x DOCS/Doxyfile` indicating that blank is not the default value. Setting values to match the current default behavior should have no effect, unless Doxygen changes in the future. On the other hand, MATHJAX_RELPATH has changed and will change again in newer Doxygen versions. CMake automatically inserts its own set of EXCLUDE_PATTERNS that contains none of the patterns previously listed here. Neither the previous values nor the CMake-generated ones should have any effect due to our choice of INPUT and FILE_PATTERNS. MATHJAX_RELPATH, LATEX_CMD_NAME, RTF_HYPERLINKS, and MAN_LINKS all require some other option (USE_MATHJAX, GENERATE_LATEX, GENERATE_RTF, and GENERATE_MAN, respectively) to be set to YES to take effect, and all are set to NO, so these changes should have no effect. Note that the CMake-generated Doxyfile.man sets MAN_LINKS=YES in addition to GENERATE_MAN=YES.
1 parent 62c9cd8 commit bd6fece

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

DOCS/Doxyfile

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,17 @@ REPEAT_BRIEF = YES
126126
# the entity):The $name class, The $name widget, The $name file, is, provides,
127127
# specifies, contains, represents, a, an and the.
128128

129-
ABBREVIATE_BRIEF =
129+
ABBREVIATE_BRIEF = "The $name class" \
130+
"The $name widget" \
131+
"The $name file" \
132+
is \
133+
provides \
134+
specifies \
135+
contains \
136+
represents \
137+
a \
138+
an \
139+
the
130140

131141
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
132142
# doxygen will generate a detailed section even if there is only a brief
@@ -927,11 +937,7 @@ EXCLUDE_SYMLINKS = NO
927937
# Note that the wildcards are matched against the file with absolute path, so to
928938
# exclude all test directories for example use the pattern */test/*
929939

930-
EXCLUDE_PATTERNS = *.py \
931-
*.txt \
932-
*.in \
933-
*.inc \
934-
Makefile
940+
EXCLUDE_PATTERNS =
935941

936942
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
937943
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -955,7 +961,7 @@ EXAMPLE_PATH =
955961
# *.h) to filter out the source-files in the directories. If left blank all
956962
# files are included.
957963

958-
EXAMPLE_PATTERNS =
964+
EXAMPLE_PATTERNS = *
959965

960966
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
961967
# searched for input files to be used with the \include or \dontinclude commands
@@ -1602,7 +1608,7 @@ MATHJAX_FORMAT = HTML-CSS
16021608
# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
16031609
# This tag requires that the tag USE_MATHJAX is set to YES.
16041610

1605-
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1611+
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
16061612

16071613
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
16081614
# extension names that should be enabled during MathJax rendering. For example
@@ -1735,7 +1741,7 @@ LATEX_OUTPUT = latex
17351741
# the output language.
17361742
# This tag requires that the tag GENERATE_LATEX is set to YES.
17371743

1738-
LATEX_CMD_NAME = latex
1744+
LATEX_CMD_NAME =
17391745

17401746
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
17411747
# index for LaTeX.
@@ -1938,7 +1944,7 @@ COMPACT_RTF = NO
19381944
# The default value is: NO.
19391945
# This tag requires that the tag GENERATE_RTF is set to YES.
19401946

1941-
RTF_HYPERLINKS = YES
1947+
RTF_HYPERLINKS = NO
19421948

19431949
# Load stylesheet definitions from file. Syntax is similar to doxygen's
19441950
# configuration file, i.e. a series of assignments. You only have to provide
@@ -2009,7 +2015,7 @@ MAN_SUBDIR =
20092015
# The default value is: NO.
20102016
# This tag requires that the tag GENERATE_MAN is set to YES.
20112017

2012-
MAN_LINKS = YES
2018+
MAN_LINKS = NO
20132019

20142020
#---------------------------------------------------------------------------
20152021
# Configuration options related to the XML output

0 commit comments

Comments
 (0)