From 2026ea7ff2be0473511cc74c56538cb98c13d301 Mon Sep 17 00:00:00 2001 From: Jitse Niesen Date: Fri, 11 Dec 2009 15:54:21 +0000 Subject: [PATCH] Coax doxygen in producing better docs for MatrixFunctions. The //@{ ... //@} in unsupported/Eigen/MatrixFunctions for some reason caused doxygen to list the constructor of the MatrixExponential class as a separate function in the MatrixFunctions module without any reference to the class; very confusing. --- doc/Doxyfile.in | 2 +- unsupported/Eigen/MatrixFunctions | 3 --- unsupported/Eigen/src/MatrixFunctions/MatrixExponential.h | 8 ++++++-- unsupported/doc/Doxyfile.in | 2 +- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 3d79a300d..64bb7bd01 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -610,7 +610,7 @@ EXCLUDE_PATTERNS = CMake* \ *.sh \ *.orig \ *.diff \ - diff + diff \ *~ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names diff --git a/unsupported/Eigen/MatrixFunctions b/unsupported/Eigen/MatrixFunctions index 0d785c344..5614f915e 100644 --- a/unsupported/Eigen/MatrixFunctions +++ b/unsupported/Eigen/MatrixFunctions @@ -41,12 +41,9 @@ namespace Eigen { * #include * \endcode */ -//@{ #include "src/MatrixFunctions/MatrixExponential.h" -//@} - } diff --git a/unsupported/Eigen/src/MatrixFunctions/MatrixExponential.h b/unsupported/Eigen/src/MatrixFunctions/MatrixExponential.h index bb4706c35..add000c44 100644 --- a/unsupported/Eigen/src/MatrixFunctions/MatrixExponential.h +++ b/unsupported/Eigen/src/MatrixFunctions/MatrixExponential.h @@ -29,7 +29,9 @@ template Scalar log2(Scalar v) { return std::log(v)/std::log(Scalar(2)); } #endif -/** \brief Compute the matrix exponential. +/** \ingroup MatrixFunctions_Module + * + * \brief Compute the matrix exponential. * * \param M matrix whose exponential is to be computed. * \param result pointer to the matrix in which to store the result. @@ -81,7 +83,9 @@ template EIGEN_STRONG_INLINE void ei_matrix_exponential(const MatrixBase &M, typename MatrixBase::PlainMatrixType* result); -/** \brief Class for computing the matrix exponential.*/ +/** \ingroup MatrixFunctions_Module + * \brief Class for computing the matrix exponential. + */ template class MatrixExponential { diff --git a/unsupported/doc/Doxyfile.in b/unsupported/doc/Doxyfile.in index e55d53f7e..12f2f39eb 100644 --- a/unsupported/doc/Doxyfile.in +++ b/unsupported/doc/Doxyfile.in @@ -602,7 +602,7 @@ EXCLUDE_PATTERNS = CMake* \ *.sh \ *.diff \ *.orig \ - diff + diff \ *~ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names