mirror of
https://gitlab.com/libeigen/eigen.git
synced 2026-04-10 11:34:33 +08:00
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:
@@ -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
|
||||
};
|
||||
|
||||
@@ -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>
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user