diff options
| author |  Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-05-03 17:08:14 +0100 |
|---|---|---|
| committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-05-03 17:08:14 +0100 |
| commit | a96c849c20cd787c40c2cbf30a496fed7bf2bf1e (patch) | |
| tree | afb8853eb08908695e45b3d9ed237557ae2ac571 /Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h | |
| parent | 1947da39ab18813ac5611f81c034eaca3ddc98a5 (diff) | |
Document enums in Constants.h (bug #248).
To get the links to work, I also had to document the Eigen namespace.
Unfortunately, this means that the word Eigen is linked whenever it appears
in the docs.
Diffstat (limited to 'Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h')
| -rw-r--r-- | Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h b/Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h index a0ece70c4..980af14ce 100644 --- a/Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h +++ b/Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h @@ -98,8 +98,8 @@ class GeneralizedSelfAdjointEigenSolver : public SelfAdjointEigenSolver<_MatrixT * Only the lower triangular part of the matrix is referenced. * \param[in] matB Positive-definite matrix in matrix pencil. * Only the lower triangular part of the matrix is referenced. - * \param[in] options A or-ed set of flags {ComputeEigenvectors,EigenvaluesOnly} | {Ax_lBx,ABx_lx,BAx_lx}. - * Default is ComputeEigenvectors|Ax_lBx. + * \param[in] options A or-ed set of flags {#ComputeEigenvectors,#EigenvaluesOnly} | {#Ax_lBx,#ABx_lx,#BAx_lx}. + * Default is #ComputeEigenvectors|#Ax_lBx. * * This constructor calls compute(const MatrixType&, const MatrixType&, int) * to compute the eigenvalues and (if requested) the eigenvectors of the @@ -131,8 +131,8 @@ class GeneralizedSelfAdjointEigenSolver : public SelfAdjointEigenSolver<_MatrixT * Only the lower triangular part of the matrix is referenced. * \param[in] matB Positive-definite matrix in matrix pencil. * Only the lower triangular part of the matrix is referenced. - * \param[in] options A or-ed set of flags {ComputeEigenvectors,EigenvaluesOnly} | {Ax_lBx,ABx_lx,BAx_lx}. - * Default is ComputeEigenvectors|Ax_lBx. + * \param[in] options A or-ed set of flags {#ComputeEigenvectors,#EigenvaluesOnly} | {#Ax_lBx,#ABx_lx,#BAx_lx}. + * Default is #ComputeEigenvectors|#Ax_lBx. * * \returns Reference to \c *this * |