Commit 9a38d55c authored by Joseph Mirabel's avatar Joseph Mirabel
Browse files

Clean documentation.

parent ef30f428
......@@ -6,3 +6,5 @@ INPUT = @CMAKE_SOURCE_DIR@/include \
@CMAKE_SOURCE_DIR@/doc
LAYOUT_FILE = @CMAKE_SOURCE_DIR@/doc/layout.xml
PREDEFINED = HPP_PINOCCHIO_PARSED_BY_DOXYGEN
......@@ -31,7 +31,19 @@ namespace hpp {
/// \addtogroup liegroup
/// \{
#ifdef HPP_PINOCCHIO_PARSED_BY_DOXYGEN
/// Elementary Lie groups
/// A boost variant with the following classes:
/// \li \f$\mathbf{R}^n\f$, where \f$n\f$ is either 1, 2, 3 or dynamic,
/// \li \f$\mathbf{R}^n \times SO(n) \f$, where \f$n\f$ is either 2 or 3,
/// \li \f$SO(n) \f$, where \f$n\f$ is either 2 or 3,
/// \li \f$SE(n) \f$, where \f$n\f$ is either 2 or 3.
/// \sa hpp::pinocchio::liegroup::VectorSpaceOperation,
/// hpp::pinocchio::liegroup::CartesianProductOperation,
/// hpp::pinocchio::liegroup::SpecialOrthogonalOperation,
/// hpp::pinocchio::liegroup::SpecialEuclideanOperation,
typedef ABoostVariant LiegroupType;
#else
typedef boost::variant <liegroup::VectorSpaceOperation
<Eigen::Dynamic, false>,
liegroup::VectorSpaceOperation <1, true>,
......@@ -50,6 +62,7 @@ namespace hpp {
se3::SpecialEuclideanOperation <2>,
se3::SpecialEuclideanOperation <3> >
LiegroupType;
#endif
enum DerivativeProduct {
DerivativeTimesInput,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment