Small fixed in doxygen (#355)

Signed-off-by: Alejandro Hernández <[email protected]>
gazebosim · Dec 30, 2021 · 5e25570 · 5e25570
1 parent 3fc159b
commit 5e25570
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/include/ignition/math/PID.hh b/include/ignition/math/PID.hh
@@ -100,7 +100,7 @@ namespace ignition
       /// \param[in] _i integral gain value
       public: void SetIGain(const double _i);
 
-      /// \brief Set the derivtive Gain.
+      /// \brief Set the derivative Gain.
       /// \param[in] _d derivative gain value
       public: void SetDGain(const double _d);
 
@@ -149,7 +149,7 @@ namespace ignition
       /// \return The maximum value
       public: double CmdMax() const;
 
-      /// \brief Get the maximum value for the command.
+      /// \brief Get the minimun value for the command.
       /// \return The maximum value
       public: double CmdMin() const;
 

diff --git a/include/ignition/math/Quaternion.hh b/include/ignition/math/Quaternion.hh
@@ -449,8 +449,8 @@ namespace ignition
       }
 
       /// \brief Return rotation as axis and angle
-      /// \param[in] _axis rotation axis
-      /// \param[in] _angle ccw angle in radians
+      /// \param[out] _axis rotation axis
+      /// \param[out] _angle ccw angle in radians
       public: void ToAxis(Vector3<T> &_axis, T &_angle) const
       {
         T len = this->qx*this->qx + this->qy*this->qy + this->qz*this->qz;
@@ -590,7 +590,7 @@ namespace ignition
         }
       }
 
-      /// \brief Scale a Quaternion<T>ion
+      /// \brief Scale a Quaternion<T>
       /// \param[in] _scale Amount to scale this rotation
       public: void Scale(T _scale)
       {

diff --git a/include/ignition/math/Spline.hh b/include/ignition/math/Spline.hh
@@ -58,13 +58,13 @@ namespace ignition
       /// \return arc length or INF on error.
       public: double ArcLength() const;
 
-      /// \brief Gets spline arc length up to
+      /// \brief Sets spline arc length up to
       /// a given parameter value \p _t.
       /// \param[in] _t parameter value (range 0 to 1).
       /// \return arc length up to \p _t or INF on error.
       public: double ArcLength(const double _t) const;
 
-      /// \brief Gets a spline segment arc length.
+      /// \brief Sets a spline segment arc length.
       /// \param[in] _index of the spline segment.
       /// \param[in] _t parameter value (range 0 to 1).
       /// \return arc length of a given segment up to