mirror of
https://gitlab.com/libeigen/eigen.git
synced 2024-12-09 07:00:27 +08:00
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.
This commit is contained in:
parent
7d444375e7
commit
2026ea7ff2
@ -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
|
||||
|
@ -41,12 +41,9 @@ namespace Eigen {
|
||||
* #include <unsupported/Eigen/MatrixFunctions>
|
||||
* \endcode
|
||||
*/
|
||||
//@{
|
||||
|
||||
#include "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 {
|
||||
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user