Skip to content

Commit 37df792

Browse files
authored
Bump Doxygen to 1.14.0 with dark theme and three column layout (#1452)
* Bump doxygen to 1.14.0 * Run `doxygen -u Doxyfile` * Update DoxygenLayout.xml for Doxygen 1.14.0 * doxygen: set HTML_COLORSTYLE = AUTO_LIGHT * Enable three column layout
1 parent 0acb422 commit 37df792

File tree

3 files changed

+41
-23
lines changed

3 files changed

+41
-23
lines changed

Doxyfile

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.13.2
1+
# Doxyfile 1.14.0
22

33
# This file describes the settings to be used by the documentation system
44
# Doxygen (www.doxygen.org) for a project.
@@ -384,8 +384,8 @@ AUTOLINK_SUPPORT = YES
384384

385385
# This tag specifies a list of words that, when matching the start of a word in
386386
# the documentation, will suppress auto links generation, if it is enabled via
387-
# AUTOLINK_SUPPORT. This list does not affect affect links explicitly created
388-
# using \# or the \link or commands.
387+
# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \#
388+
# or the \link or commands.
389389
# This tag requires that the tag AUTOLINK_SUPPORT is set to YES.
390390

391391
AUTOLINK_IGNORE_WORDS =
@@ -1019,9 +1019,9 @@ INPUT_FILE_ENCODING =
10191019
#
10201020
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
10211021
# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
1022-
# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d,
1023-
# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to
1024-
# be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
1022+
# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php,
1023+
# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
1024+
# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
10251025
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
10261026

10271027
FILE_PATTERNS = *.hpp
@@ -1387,7 +1387,7 @@ HTML_EXTRA_FILES =
13871387
# The default value is: AUTO_LIGHT.
13881388
# This tag requires that the tag GENERATE_HTML is set to YES.
13891389

1390-
HTML_COLORSTYLE = LIGHT
1390+
HTML_COLORSTYLE = AUTO_LIGHT
13911391

13921392
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
13931393
# will adjust the colors in the style sheet and background images according to
@@ -1695,10 +1695,10 @@ ECLIPSE_DOC_ID = org.doxygen.Project
16951695
# of each HTML page. A value of NO enables the index and the value YES disables
16961696
# it. Since the tabs in the index contain the same information as the navigation
16971697
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1698-
# The default value is: YES.
1698+
# The default value is: NO.
16991699
# This tag requires that the tag GENERATE_HTML is set to YES.
17001700

1701-
DISABLE_INDEX = NO
1701+
DISABLE_INDEX = YES
17021702

17031703
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
17041704
# structure should be generated to display hierarchical information. If the tag
@@ -1710,24 +1710,33 @@ DISABLE_INDEX = NO
17101710
# further fine tune the look of the index (see "Fine-tuning the output"). As an
17111711
# example, the default style sheet generated by Doxygen has an example that
17121712
# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1713-
# Since the tree basically has the same information as the tab index, you could
1714-
# consider setting DISABLE_INDEX to YES when enabling this option.
1713+
# Since the tree basically has more details information than the tab index, you
1714+
# could consider setting DISABLE_INDEX to YES when enabling this option.
1715+
# The default value is: YES.
1716+
# This tag requires that the tag GENERATE_HTML is set to YES.
1717+
1718+
GENERATE_TREEVIEW = YES
1719+
1720+
# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines
1721+
# if an additional navigation panel is shown at the right hand side of the
1722+
# screen, displaying an outline of the contents of the main page, similar to
1723+
# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to
1724+
# NO, this option has no effect.
17151725
# The default value is: YES.
17161726
# This tag requires that the tag GENERATE_HTML is set to YES.
17171727

1718-
GENERATE_TREEVIEW = NO
1728+
PAGE_OUTLINE_PANEL = YES
17191729

1720-
# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1721-
# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1722-
# area (value NO) or if it should extend to the full height of the window (value
1723-
# YES). Setting this to YES gives a layout similar to
1724-
# https://docs.readthedocs.io with more room for contents, but less room for the
1725-
# project logo, title, and description. If either GENERATE_TREEVIEW or
1726-
# DISABLE_INDEX is set to NO, this option has no effect.
1730+
# When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if
1731+
# the side bar is limited to only the treeview area (value NO) or if it should
1732+
# extend to the full height of the window (value YES). Setting this to YES gives
1733+
# a layout similar to e.g. https://docs.readthedocs.io with more room for
1734+
# contents, but less room for the project logo, title, and description. If
1735+
# GENERATE_TREEVIEW is set to NO, this option has no effect.
17271736
# The default value is: NO.
17281737
# This tag requires that the tag GENERATE_HTML is set to YES.
17291738

1730-
FULL_SIDEBAR = NO
1739+
FULL_SIDEBAR = YES
17311740

17321741
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
17331742
# Doxygen will group on one line in the generated HTML documentation.
@@ -2631,6 +2640,15 @@ UML_LOOK = NO
26312640

26322641
UML_LIMIT_NUM_FIELDS = 10
26332642

2643+
# If the UML_LOOK tag is enabled, field labels are shown along the edge between
2644+
# two class nodes. If there are many fields and many nodes the graph may become
2645+
# too cluttered. The UML_MAX_EDGE_LABELS threshold limits the number of items to
2646+
# make the size more manageable. Set this to 0 for no limit.
2647+
# Minimum value: 0, maximum value: 100, default value: 10.
2648+
# This tag requires that the tag UML_LOOK is set to YES.
2649+
2650+
UML_MAX_EDGE_LABELS = 10
2651+
26342652
# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
26352653
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
26362654
# tag is set to YES, Doxygen will add type and arguments for attributes and

docs/DoxygenLayout.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<doxygenlayout version="2.0">
3-
<!-- Generated by doxygen 1.13.2 -->
3+
<!-- Generated by doxygen 1.14.0 -->
44
<!-- Navigation index tabs for HTML output -->
55
<navindex>
66
<tab type="mainpage" visible="yes" title=""/>
@@ -169,7 +169,7 @@
169169
<functions visible="yes" title=""/>
170170
<variables visible="yes" title=""/>
171171
<properties visible="yes" title=""/>
172-
<membergroups visible="yes" visible="yes"/>
172+
<membergroups visible="yes" title=""/>
173173
</memberdecl>
174174
<memberdef>
175175
<inlineclasses visible="yes" title=""/>

etc/generate-latest-apidocs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ set -o errexit
1111
set -o pipefail
1212

1313
LATEST_VERSION="4.1.1"
14-
DOXYGEN_VERSION_REQUIRED="1.13.2"
14+
DOXYGEN_VERSION_REQUIRED="1.14.0"
1515

1616
# Permit using a custom Doxygen binary.
1717
: "${DOXYGEN_BINARY:=doxygen}"

0 commit comments

Comments
 (0)