Commit a9eb39c0 authored by florent's avatar florent
Browse files

Add comments

    * include/hpp/core/freeflyer-joint.hh,
    * include/hpp/core/rotation-joint.hh,
    * include/hpp/core/translation-joint.hh: add explanation about purpose of
      these classes.
parent 658c131e
......@@ -8,6 +8,18 @@
namespace hpp {
namespace core {
KIT_PREDEF_CLASS(FreeflyerJoint);
///
/// \brief Intermediate freeflyer joint.
///
/// This class implements a freeflyer joint deriving from
/// CkppFreeFlyerJointComponent only for kxml input output purposes.
///
/// Joints of this class contain inertia data as CkppDoubleProperty
/// attributes.
///
/// Once read from a file the device containing this joint will be
/// transformed into a ChppHumanoidRobot.
class FreeflyerJoint : public CkppFreeFlyerJointComponent,
public JointProperties
{
......
......@@ -8,6 +8,18 @@
namespace hpp {
namespace core {
KIT_PREDEF_CLASS(RotationJoint);
///
/// \brief Intermediate rotation joint.
///
/// This class implements a rotation joint deriving from
/// CkppRotationJointComponent only for kxml input output purposes.
///
/// Joints of this class contain inertia data as CkppDoubleProperty
/// attributes.
///
/// Once read from a file the device containing this joint will be
/// transformed into a ChppHumanoidRobot.
class RotationJoint : public CkppRotationJointComponent,
public JointProperties
{
......
......@@ -8,6 +8,18 @@
namespace hpp {
namespace core {
KIT_PREDEF_CLASS(TranslationJoint);
///
/// \brief Intermediate translation joint.
///
/// This class implements a translation joint deriving from
/// CkppTranslationJointComponent only for kxml input output purposes.
///
/// Joints of this class contain inertia data as CkppDoubleProperty
/// attributes.
///
/// Once read from a file the device containing this joint will be
/// transformed into a ChppHumanoidRobot.
class TranslationJoint : public CkppTranslationJointComponent,
public JointProperties
{
......
Markdown is supported
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