diff options
author | 2011-05-03 17:08:14 +0100 | |
---|---|---|
committer | 2011-05-03 17:08:14 +0100 | |
commit | a96c849c20cd787c40c2cbf30a496fed7bf2bf1e (patch) | |
tree | afb8853eb08908695e45b3d9ed237557ae2ac571 /Eigen/src/Geometry | |
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/Geometry')
-rw-r--r-- | Eigen/src/Geometry/Hyperplane.h | 8 | ||||
-rw-r--r-- | Eigen/src/Geometry/Quaternion.h | 4 | ||||
-rw-r--r-- | Eigen/src/Geometry/Transform.h | 16 |
3 files changed, 14 insertions, 14 deletions
diff --git a/Eigen/src/Geometry/Hyperplane.h b/Eigen/src/Geometry/Hyperplane.h index e43c9d07d..00e027040 100644 --- a/Eigen/src/Geometry/Hyperplane.h +++ b/Eigen/src/Geometry/Hyperplane.h @@ -213,8 +213,8 @@ public: /** Applies the transformation matrix \a mat to \c *this and returns a reference to \c *this. * * \param mat the Dim x Dim transformation matrix - * \param traits specifies whether the matrix \a mat represents an Isometry - * or a more generic Affine transformation. The default is Affine. + * \param traits specifies whether the matrix \a mat represents an #Isometry + * or a more generic #Affine transformation. The default is #Affine. */ template<typename XprType> inline Hyperplane& transform(const MatrixBase<XprType>& mat, TransformTraits traits = Affine) @@ -233,8 +233,8 @@ public: /** Applies the transformation \a t to \c *this and returns a reference to \c *this. * * \param t the transformation of dimension Dim - * \param traits specifies whether the transformation \a t represents an Isometry - * or a more generic Affine transformation. The default is Affine. + * \param traits specifies whether the transformation \a t represents an #Isometry + * or a more generic #Affine transformation. The default is #Affine. * Other kind of transformations are not supported. */ template<int TrOptions> diff --git a/Eigen/src/Geometry/Quaternion.h b/Eigen/src/Geometry/Quaternion.h index 7abe3c702..20e69736b 100644 --- a/Eigen/src/Geometry/Quaternion.h +++ b/Eigen/src/Geometry/Quaternion.h @@ -357,7 +357,7 @@ class Map<const Quaternion<_Scalar>, _Options > * The pointer \a coeffs must reference the four coeffecients of Quaternion in the following order: * \code *coeffs == {x, y, z, w} \endcode * - * If the template parameter _Options is set to Aligned, then the pointer coeffs must be aligned. */ + * If the template parameter _Options is set to #Aligned, then the pointer coeffs must be aligned. */ EIGEN_STRONG_INLINE Map(const Scalar* coeffs) : m_coeffs(coeffs) {} inline const Coefficients& coeffs() const { return m_coeffs;} @@ -393,7 +393,7 @@ class Map<Quaternion<_Scalar>, _Options > * The pointer \a coeffs must reference the four coeffecients of Quaternion in the following order: * \code *coeffs == {x, y, z, w} \endcode * - * If the template parameter _Options is set to Aligned, then the pointer coeffs must be aligned. */ + * If the template parameter _Options is set to #Aligned, then the pointer coeffs must be aligned. */ EIGEN_STRONG_INLINE Map(Scalar* coeffs) : m_coeffs(coeffs) {} inline Coefficients& coeffs() { return m_coeffs; } diff --git a/Eigen/src/Geometry/Transform.h b/Eigen/src/Geometry/Transform.h index 289077c1b..d8ec8236e 100644 --- a/Eigen/src/Geometry/Transform.h +++ b/Eigen/src/Geometry/Transform.h @@ -86,11 +86,11 @@ template<typename TransformType> struct transform_take_affine_part; * \tparam _Scalar the scalar type, i.e., the type of the coefficients * \tparam _Dim the dimension of the space * \tparam _Mode the type of the transformation. Can be: - * - Affine: the transformation is stored as a (Dim+1)^2 matrix, - * where the last row is assumed to be [0 ... 0 1]. - * - AffineCompact: the transformation is stored as a (Dim)x(Dim+1) matrix. - * - Projective: the transformation is stored as a (Dim+1)^2 matrix - * without any assumption. + * - #Affine: the transformation is stored as a (Dim+1)^2 matrix, + * where the last row is assumed to be [0 ... 0 1]. + * - #AffineCompact: the transformation is stored as a (Dim)x(Dim+1) matrix. + * - #Projective: the transformation is stored as a (Dim+1)^2 matrix + * without any assumption. * \tparam _Options has the same meaning as in class Matrix. It allows to specify DontAlign and/or RowMajor. * These Options are passed directly to the underlying matrix type. * @@ -1082,10 +1082,10 @@ struct projective_transform_inverse<TransformType, Projective> * * \param hint allows to optimize the inversion process when the transformation * is known to be not a general transformation (optional). The possible values are: - * - Projective if the transformation is not necessarily affine, i.e., if the + * - #Projective if the transformation is not necessarily affine, i.e., if the * last row is not guaranteed to be [0 ... 0 1] - * - Affine if the last row can be assumed to be [0 ... 0 1] - * - Isometry if the transformation is only a concatenations of translations + * - #Affine if the last row can be assumed to be [0 ... 0 1] + * - #Isometry if the transformation is only a concatenations of translations * and rotations. * The default is the template class parameter \c Mode. * |