diff options
| author |  Jitse Niesen <jitse@maths.leeds.ac.uk> | 2009-12-11 15:54:21 +0000 |
|---|---|---|
| committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2009-12-11 15:54:21 +0000 |
| commit | 2026ea7ff2be0473511cc74c56538cb98c13d301 (patch) | |
| tree | 53126133fcedaba05817b09b62bce10954825a93 /unsupported/Eigen | |
| parent | 7d444375e744f8f666c15ccd97e9d3dc4b342389 (diff) | |
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.
Diffstat (limited to 'unsupported/Eigen')
| -rw-r--r-- | unsupported/Eigen/MatrixFunctions | 3 | ||||
| -rw-r--r-- | unsupported/Eigen/src/MatrixFunctions/MatrixExponential.h | 8 |
2 files changed, 6 insertions, 5 deletions
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 <unsupported/Eigen/MatrixFunctions> * \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 <typename Scalar> 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 <typename Derived> EIGEN_STRONG_INLINE void ei_matrix_exponential(const MatrixBase<Derived> &M, typename MatrixBase<Derived>::PlainMatrixType* result); -/** \brief Class for computing the matrix exponential.*/ +/** \ingroup MatrixFunctions_Module + * \brief Class for computing the matrix exponential. + */ template <typename MatrixType> class MatrixExponential { |