aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Jim Lersch <3578051-jlersch@users.noreply.gitlab.com>2020-11-26 13:17:54 -0700
committerGravatar Jim Lersch <3578051-jlersch@users.noreply.gitlab.com>2020-11-27 19:52:16 -0700
commit68f69414f7d358deac4876ede5be15e990da496b (patch)
tree86c56d7afdd15fbe384dc9bbc99416b1ee134b15 /doc
parenta7170f2aca4103abc95e983238a02aba2385b198 (diff)
Workaround for doxygen class template titles in which the template
part of the class signature is lost due to a problem with forward declarations. The problem is probably caused by doxygen bug #7689. It is confirmed to be fixed in doxygen >= 1.8.19.
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile.in8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index ddfd7e87f..bc1e03c40 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -737,6 +737,14 @@ EXCLUDE = "${Eigen_SOURCE_DIR}/Eigen/src/Core/products" \
"${Eigen_SOURCE_DIR}/unsupported/doc/examples" \
"${Eigen_SOURCE_DIR}/unsupported/doc/snippets"
+# Forward declarations of class templates cause the title of the main page for
+# the class template to not contain the template signature. This only happens
+# when the \class command is used to document the class. Possibly caused
+# by https://github.com/doxygen/doxygen/issues/7698. Confirmed fixed by
+# doxygen release 1.8.19.
+
+EXCLUDE += "${Eigen_SOURCE_DIR}/Eigen/src/Core/util/ForwardDeclarations.h"
+
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.