CFD/eigen
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Workaround for doxygen class template titles in which the template

Browse Source 
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.

(cherry picked from commit 68f69414f7)
This commit is contained in:
Jim Lersch 2020-11-26 13:17:54 -07:00 committed by Christoph Hertzberg
parent 2a4fcb2c31
commit 0c26611d2d
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/Doxyfile.in
View File

@ -736,6 +736,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.