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
This commit is contained in:
Jitse Niesen
2011-12-08 14:22:06 +00:00
parent a1fa05f14e
commit dd232e30b0
6 changed files with 14 additions and 7 deletions

View File

@@ -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
};

View File

@@ -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>
{