GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-07-27 15:22:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Coax doxygen in producing better docs for MatrixFunctions.

Browse Source 
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.
This commit is contained in:
Jitse Niesen 2009-12-11 15:54:21 +00:00
parent 7d444375e7
commit 2026ea7ff2
4 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Doxyfile.in
View File

@ -610,7 +610,7 @@ EXCLUDE_PATTERNS = CMake* \
*.sh \ *.sh \
*.orig \ *.orig \
*.diff \ *.diff \
diff diff \
*~ *~
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

3
unsupported/Eigen/MatrixFunctions
View File

@ -41,12 +41,9 @@ namespace Eigen {
* #include <unsupported/Eigen/MatrixFunctions> * #include <unsupported/Eigen/MatrixFunctions>
* \endcode * \endcode
*/ */
//@{
#include "src/MatrixFunctions/MatrixExponential.h" #include "src/MatrixFunctions/MatrixExponential.h"
//@}
} }

8
unsupported/Eigen/src/MatrixFunctions/MatrixExponential.h
View File

@ -29,7 +29,9 @@
template <typename Scalar> Scalar log2(Scalar v) { return std::log(v)/std::log(Scalar(2)); } template <typename Scalar> Scalar log2(Scalar v) { return std::log(v)/std::log(Scalar(2)); }
#endif #endif
/** \brief Compute the matrix exponential. /** \ingroup MatrixFunctions_Module
*
* \brief Compute the matrix exponential.
* *
* \param M matrix whose exponential is to be computed. * \param M matrix whose exponential is to be computed.
* \param result pointer to the matrix in which to store the result. * \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, EIGEN_STRONG_INLINE void ei_matrix_exponential(const MatrixBase<Derived> &M,
typename MatrixBase<Derived>::PlainMatrixType* result); 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> template <typename MatrixType>
class MatrixExponential { class MatrixExponential {

2
unsupported/doc/Doxyfile.in
View File

@ -602,7 +602,7 @@ EXCLUDE_PATTERNS = CMake* \
*.sh \ *.sh \
*.diff \ *.diff \
*.orig \ *.orig \
diff diff \
*~ *~
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names