devtools/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2026-04-10 11:34:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Several changes in comments to keep Doxygen happy.

Browse Source
This commit is contained in:
Jitse Niesen
2010-07-25 20:29:07 +01:00
parent 3d9764ee24
commit 1420f8b3a1
10 changed files with 30 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Eigen/src/Geometry/Homogeneous.h
View File

@@ -135,7 +135,7 @@ template<typename MatrixType,int _Direction> class Homogeneous
*
* \return an expression of the equivalent homogeneous vector
*
* \vectoronly
* \only_for_vectors
*
* Example: \include MatrixBase_homogeneous.cpp
* Output: \verbinclude MatrixBase_homogeneous.out

23
Eigen/src/Geometry/Quaternion.h
View File

@@ -277,19 +277,6 @@ typedef Quaternion<double> Quaterniond;
* Specialization of Map<Quaternion<Scalar>>
***************************************************************************/
/** \class Map<Quaternion>
*
*
* \brief Expression of a quaternion from a memory buffer
*
* \param _Scalar the type of the Quaternion coefficients
* \param PacketAccess see class Map
*
* This is a specialization of class Map for Quaternion. This class allows to view
* a 4 scalar memory buffer as an Eigen's Quaternion object.
*
* \sa class Map, class Quaternion, class QuaternionBase
*/
template<typename _Scalar, int _PacketAccess>
struct ei_traits<Map<Quaternion<_Scalar>, _PacketAccess> >:
ei_traits<Quaternion<_Scalar> >
@@ -301,6 +288,16 @@ ei_traits<Quaternion<_Scalar> >
};
};
/** \brief Expression of a quaternion from a memory buffer
*
* \param _Scalar the type of the Quaternion coefficients
* \param PacketAccess see class Map
*
* This is a specialization of class Map for Quaternion. This class allows to view
* a 4 scalar memory buffer as an Eigen's Quaternion object.
*
* \sa class Map, class Quaternion, class QuaternionBase
*/
template<typename _Scalar, int PacketAccess>
class Map<Quaternion<_Scalar>, PacketAccess >
: public QuaternionBase<Map<Quaternion<_Scalar>, PacketAccess> >

2
Eigen/src/Geometry/Transform.h
View File

@@ -914,7 +914,7 @@ struct ei_projective_transform_inverse<TransformType, Projective>
* \returns the inverse transformation according to some given knowledge
* on \c *this.
*
* \param traits allows to optimize the inversion process when the transformation
* \param hint allows to optimize the inversion process when the transformation
* is known to be not a general transformation. The possible values are:
* - Projective if the transformation is not necessarily affine, i.e., if the
* last row is not guaranteed to be [0 ... 0 1]