Improve documentation, mostly by adding links to Quick Start Guide.

This commit is contained in:
Jitse Niesen
2010-07-05 10:59:29 +01:00
parent efb79600b9
commit 9fa4e9a098
3 changed files with 10 additions and 10 deletions

View File

@@ -1,6 +1,6 @@
namespace Eigen {
/** \page TutorialMatrixClass Tutorial page 1 - the %Matrix class
/** \page TutorialMatrixClass Tutorial page 1 - The %Matrix class
\ingroup Tutorial
@@ -243,7 +243,7 @@ Eigen defines the following Matrix typedefs:
\li RowVectorNt for Matrix<type, 1, N>. For example, RowVector3d for Matrix<double, 1, 3>.
Where:
\li N can be any one of \c 2,\c 3,\c 4, or \c d (meaning \c Dynamic).
\li N can be any one of \c 2,\c 3,\c 4, or \c X (meaning \c Dynamic).
\li t can be any one of \c i (meaning int), \c f (meaning float), \c d (meaning double),
\c cf (meaning complex<float>), or \c cd (meaning complex<double>). The fact that typedefs are only
defined for these 5 types doesn't mean that they are the only supported scalar types. For example,