Improve documentation of TriangularView.

This commit is contained in:
Gael Guennebaud
2015-10-09 12:10:58 +02:00
parent 1429daf850
commit 2632b3446c
3 changed files with 71 additions and 42 deletions

View File

@@ -189,8 +189,8 @@ const unsigned int HereditaryBits = RowMajorBit
*/
/** \ingroup enums
* Enum containing possible values for the \p Mode parameter of
* MatrixBase::selfadjointView() and MatrixBase::triangularView(). */
* Enum containing possible values for the \c Mode or \c UpLo parameter of
* MatrixBase::selfadjointView() and MatrixBase::triangularView(), and selfadjoint solvers. */
enum {
/** View matrix as a lower triangular matrix. */
Lower=0x1,