Fixed docstrings of classes

TimSchneider42 · May 27, 2024 · 35911e5 · 35911e5
1 parent 0d54e97
commit 35911e5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/include/franky/robot_pose.hpp b/include/franky/robot_pose.hpp
@@ -9,8 +9,7 @@
 namespace franky {
 
 /**
- * @class RobotPose
- * @brief A class to represent the cartesian pose of a robot.
+ * @brief Represents the cartesian pose of a robot.
  *
  * This class encapsulates the cartesian pose of a robot, which comprises the end effector pose and the elbow position.
  */

diff --git a/include/franky/robot_velocity.hpp b/include/franky/robot_velocity.hpp
@@ -10,8 +10,10 @@
 namespace franky {
 
 /**
- * @brief Class to represent  the cartesian velocity of a robot. It comprists the twist of the end effector and the
- * joint velocity of the elbow.
+ * @brief Represents the cartesian velocity of a robot.
+ *
+ * This class encapsulates the cartesian velocity of a robot, which comproses the end effector twist and the elbow
+ * velocity.
  */
 class RobotVelocity {
  public:

diff --git a/include/franky/twist.hpp b/include/franky/twist.hpp
@@ -7,7 +7,7 @@
 namespace franky {
 
 /**
- * @brief Class to represent the twist of a robot.
+ * @brief Represents the twist of a frame.
  */
 class Twist {
  public: