Skip to content

Commit 87b54b0

Browse files
authored
Bump Doxygen version to 1.15.0 with misc. improvements (#1488)
* Bump required doxygen version to 1.15.0 * Update Doxyfile for 1.15.0 * Update DoxygenLayout.xml for 1.15.0 * Exclude mainpage sections from ToC
1 parent dcff0a0 commit 87b54b0

File tree

4 files changed

+60
-31
lines changed

4 files changed

+60
-31
lines changed

Doxyfile

Lines changed: 50 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.14.0
1+
# Doxyfile 1.15.0
22

33
# This file describes the settings to be used by the documentation system
44
# Doxygen (www.doxygen.org) for a project.
@@ -353,6 +353,20 @@ EXTENSION_MAPPING =
353353

354354
MARKDOWN_SUPPORT = YES
355355

356+
# If the MARKDOWN_STRICT tag is enabled then Doxygen treats text in comments as
357+
# Markdown formatted also in cases where Doxygen's native markup format
358+
# conflicts with that of Markdown. This is only relevant in cases where
359+
# backticks are used. Doxygen's native markup style allows a single quote to end
360+
# a text fragment started with a backtick and then treat it as a piece of quoted
361+
# text, whereas in Markdown such text fragment is treated as verbatim and only
362+
# ends when a second matching backtick is found. Also, Doxygen's native markup
363+
# format requires double quotes to be escaped when they appear in a backtick
364+
# section, whereas this is not needed for Markdown.
365+
# The default value is: YES.
366+
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
367+
368+
MARKDOWN_STRICT = YES
369+
356370
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
357371
# to that level are automatically included in the table of contents, even if
358372
# they do not have an id attribute.
@@ -502,9 +516,9 @@ LOOKUP_CACHE_SIZE = 0
502516
# which effectively disables parallel processing. Please report any issues you
503517
# encounter. Generating dot graphs in parallel is controlled by the
504518
# DOT_NUM_THREADS setting.
505-
# Minimum value: 0, maximum value: 32, default value: 1.
519+
# Minimum value: 0, maximum value: 512, default value: 1.
506520

507-
NUM_PROC_THREADS = 1
521+
NUM_PROC_THREADS = 0
508522

509523
# If the TIMESTAMP tag is set different from NO then each generated page will
510524
# contain the date or date and time when the page was generated. Setting this to
@@ -1817,7 +1831,7 @@ USE_MATHJAX = NO
18171831
# regards to the different settings, so it is possible that also other MathJax
18181832
# settings have to be changed when switching between the different MathJax
18191833
# versions.
1820-
# Possible values are: MathJax_2 and MathJax_3.
1834+
# Possible values are: MathJax_2, MathJax_3 and MathJax_4.
18211835
# The default value is: MathJax_2.
18221836
# This tag requires that the tag USE_MATHJAX is set to YES.
18231837

@@ -1826,9 +1840,10 @@ MATHJAX_VERSION = MathJax_2
18261840
# When MathJax is enabled you can set the default output format to be used for
18271841
# the MathJax output. For more details about the output format see MathJax
18281842
# version 2 (see:
1829-
# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1843+
# https://docs.mathjax.org/en/v2.7/output.html), MathJax version 3 (see:
1844+
# https://docs.mathjax.org/en/v3.2/output/index.html) and MathJax version 4
18301845
# (see:
1831-
# http://docs.mathjax.org/en/latest/web/components/output.html).
1846+
# https://docs.mathjax.org/en/v4.0/output/index.htm).
18321847
# Possible values are: HTML-CSS (which is slower, but has the best
18331848
# compatibility. This is the name for Mathjax version 2, for MathJax version 3
18341849
# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
@@ -1841,36 +1856,50 @@ MATHJAX_VERSION = MathJax_2
18411856
MATHJAX_FORMAT = HTML-CSS
18421857

18431858
# When MathJax is enabled you need to specify the location relative to the HTML
1844-
# output directory using the MATHJAX_RELPATH option. The destination directory
1845-
# should contain the MathJax.js script. For instance, if the mathjax directory
1846-
# is located at the same level as the HTML output directory, then
1847-
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1848-
# Content Delivery Network so you can quickly see the result without installing
1849-
# MathJax. However, it is strongly recommended to install a local copy of
1850-
# MathJax from https://www.mathjax.org before deployment. The default value is:
1859+
# output directory using the MATHJAX_RELPATH option. For Mathjax version 2 the
1860+
# destination directory should contain the MathJax.js script. For instance, if
1861+
# the mathjax directory is located at the same level as the HTML output
1862+
# directory, then MATHJAX_RELPATH should be ../mathjax.s For Mathjax versions 3
1863+
# and 4 the destination directory should contain the tex-<format>.js script
1864+
# (where <format> is either chtml or svg). The default value points to the
1865+
# MathJax Content Delivery Network so you can quickly see the result without
1866+
# installing MathJax. However, it is strongly recommended to install a local
1867+
# copy of MathJax from https://www.mathjax.org before deployment. The default
1868+
# value is:
18511869
# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
18521870
# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1871+
# - in case of MathJax version 4: https://cdn.jsdelivr.net/npm/mathjax@4
18531872
# This tag requires that the tag USE_MATHJAX is set to YES.
18541873

18551874
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
18561875

18571876
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
18581877
# extension names that should be enabled during MathJax rendering. For example
1859-
# for MathJax version 2 (see
1860-
# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1878+
# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7/tex.html):
18611879
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
18621880
# For example for MathJax version 3 (see
1863-
# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1881+
# https://docs.mathjax.org/en/v3.2/input/tex/extensions/):
18641882
# MATHJAX_EXTENSIONS = ams
1883+
# For example for MathJax version 4 (see
1884+
# https://docs.mathjax.org/en/v4.0/input/tex/extensions/):
1885+
# MATHJAX_EXTENSIONS = units
1886+
# Note that for Mathjax version 4 quite a few extensions are already
1887+
# automatically loaded. To disable a package in Mathjax version 4 one can use
1888+
# the package name prepended with a minus sign (- like MATHJAX_EXTENSIONS +=
1889+
# -textmacros)
18651890
# This tag requires that the tag USE_MATHJAX is set to YES.
18661891

18671892
MATHJAX_EXTENSIONS =
18681893

18691894
# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces
1870-
# of code that will be used on startup of the MathJax code. See the MathJax site
1871-
# (see:
1872-
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1873-
# example see the documentation.
1895+
# of code that will be used on startup of the MathJax code. See the Mathjax site
1896+
# for more details:
1897+
# - MathJax version 2 (see:
1898+
# https://docs.mathjax.org/en/v2.7/)
1899+
# - MathJax version 3 (see:
1900+
# https://docs.mathjax.org/en/v3.2/)
1901+
# - MathJax version 4 (see:
1902+
# https://docs.mathjax.org/en/v4.0/) For an example see the documentation.
18741903
# This tag requires that the tag USE_MATHJAX is set to YES.
18751904

18761905
MATHJAX_CODEFILE =
@@ -2538,7 +2567,7 @@ HAVE_DOT = NO
25382567
# processors available in the system. You can set it explicitly to a value
25392568
# larger than 0 to get control over the balance between CPU load and processing
25402569
# speed.
2541-
# Minimum value: 0, maximum value: 32, default value: 0.
2570+
# Minimum value: 0, maximum value: 512, default value: 0.
25422571
# This tag requires that the tag HAVE_DOT is set to YES.
25432572

25442573
DOT_NUM_THREADS = 0

docs/DoxygenLayout.xml

Lines changed: 3 additions & 3 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.14.0 -->
3+
<!-- Generated by doxygen 1.15.0 -->
44
<!-- Navigation index tabs for HTML output -->
55
<navindex>
66
<tab type="mainpage" visible="yes" title=""/>
@@ -121,7 +121,7 @@
121121
<functions visible="yes" title=""/>
122122
<variables visible="yes" title=""/>
123123
<properties visible="yes" title=""/>
124-
<membergroups visible="yes" visible="yes"/>
124+
<membergroups visible="yes"/>
125125
</memberdecl>
126126
<memberdef>
127127
<inlineclasses 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" title=""/>
172+
<membergroups visible="yes"/>
173173
</memberdecl>
174174
<memberdef>
175175
<inlineclasses visible="yes" title=""/>

etc/apidocmenu.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MongoDB C++ Driver
22

3-
## Driver Documentation By Version
3+
<h1>Driver Documentation By Version</h1>
44

55
[4.1.4](../mongocxx-4.1.4) |
66
[4.1.3](../mongocxx-4.1.3) |
@@ -47,7 +47,7 @@
4747
[3.0.1](../mongocxx-3.0.1/) |
4848
[3.0.0](../mongocxx-3.0.0/)
4949

50-
## Driver Development Status
50+
<h1>Driver Development Status</h1>
5151

5252
> [!IMPORTANT]
5353
> Relevant bug fixes will be backported from the current major version to the previous major version for a period of one year after the new major version is released.
@@ -64,22 +64,22 @@
6464
| ... | ... | ... | ... |
6565
| 3.0.0 | None | Ready for Use | Not Supported |
6666

67-
## MongoDB Server Compatibility
67+
<h1>MongoDB Server Compatibility</h1>
6868

6969
MongoDB server version compatibility per driver version is documented in the [MongoDB Manual](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/compatibility/).
7070

71-
## Resources
71+
<h1>Resources</h1>
7272

7373
* [MongoDB C++ Driver Quickstart](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/tutorial/)
7474
* [MongoDB C++ Driver Manual](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/)
7575
* [MongoDB C++ Driver Source Code on GitHub](https://github.com/mongodb/mongo-cxx-driver)
7676
* [MongoDB Database Manual](https://www.mongodb.com/docs/manual/)
7777

78-
## Bugs and issues
78+
<h1>Bugs and issues</h1>
7979

8080
See our [JIRA project](https://jira.mongodb.com/browse/CXX).
8181

82-
## License
82+
<h1>License</h1>
8383

8484
The source files in this repository are made available under the terms of
8585
the Apache License, version 2.0.

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.4"
14-
DOXYGEN_VERSION_REQUIRED="1.14.0"
14+
DOXYGEN_VERSION_REQUIRED="1.15.0"
1515

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

0 commit comments

Comments
 (0)