Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Small fixed in doxygen #355

Merged
merged 1 commit into from
Dec 30, 2021
Merged

Small fixed in doxygen #355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions include/ignition/math/PID.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down Expand Up @@ -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;

Expand Down
6 changes: 3 additions & 3 deletions include/ignition/math/Quaternion.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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)
{
Expand Down
4 changes: 2 additions & 2 deletions include/ignition/math/Spline.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down