diff options
author | 2011-12-08 14:22:06 +0000 | |
---|---|---|
committer | 2011-12-08 14:22:06 +0000 | |
commit | dd232e30b0a0ce4e8fe13622fe28d293b1ed40f5 (patch) | |
tree | cd4c7f761f6e20c009e165fcf0b7785578363a2d /Eigen | |
parent | a1fa05f14e312d3e05914d2fe40ef04c2ac34b66 (diff) |
Document QuaternionBase, minor doc improvements.
* Document class QuaternionBase so that docs for members are displayed.
* Remove obsolete \redstar refering to Array module
* Fix typo in Constants.h
* Document EIGEN_NO_AUTOMATIC_RESIZING
Diffstat (limited to 'Eigen')
-rw-r--r-- | Eigen/src/Core/util/Constants.h | 4 | ||||
-rw-r--r-- | Eigen/src/Geometry/Quaternion.h | 6 |
2 files changed, 8 insertions, 2 deletions
diff --git a/Eigen/src/Core/util/Constants.h b/Eigen/src/Core/util/Constants.h index cd7cdfd7c..da67649c3 100644 --- a/Eigen/src/Core/util/Constants.h +++ b/Eigen/src/Core/util/Constants.h @@ -378,7 +378,7 @@ enum QRPreconditioners { #error The preprocessor symbol 'Success' is defined, possibly by the X11 header file X.h #endif -/** \ingroups enums +/** \ingroup enums * Enum for reporting the status of a computation. */ enum ComputationInfo { /** Computation was successful. */ @@ -387,7 +387,7 @@ enum ComputationInfo { NumericalIssue = 1, /** Iterative procedure did not converge. */ NoConvergence = 2, - /** The inputs are invalid, or the algorithm has been properly called. + /** The inputs are invalid, or the algorithm has been improperly called. * When assertions are enabled, such errors trigger an assert. */ InvalidInput = 3 }; diff --git a/Eigen/src/Geometry/Quaternion.h b/Eigen/src/Geometry/Quaternion.h index b2f127b6a..c6c2213ab 100644 --- a/Eigen/src/Geometry/Quaternion.h +++ b/Eigen/src/Geometry/Quaternion.h @@ -38,6 +38,12 @@ template<typename Other, struct quaternionbase_assign_impl; } +/** \geometry_module \ingroup Geometry_Module + * \class QuaternionBase + * \brief Base class for quaternion expressions + * \tparam Derived derived type (CRTP) + * \sa class Quaternion + */ template<class Derived> class QuaternionBase : public RotationBase<Derived, 3> { |