Skip to content

Commit

Permalink
Corrected function comments
Browse files Browse the repository at this point in the history
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
  • Loading branch information
jasmeet0915 committed Jul 17, 2023
1 parent bbacbe9 commit b092904
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 17 deletions.
6 changes: 4 additions & 2 deletions include/sdf/Box.hh
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,10 @@ namespace sdf
/// \return A reference to a gz::math::Boxd object.
public: gz::math::Boxd &Shape();

/// \brief Calculate an return the Mass Matrix values for the Box
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double density);
/// \brief Calculate and return the Mass Matrix values for the Box
/// \param[in] density Density of the box in kg/m^3
/// \return A std::optional with gz::math::MassMatrix3d object or std::nullopt
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double _density);

/// \brief Create and return an SDF element filled with data from this
/// box.
Expand Down
6 changes: 4 additions & 2 deletions include/sdf/Capsule.hh
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,10 @@ namespace sdf
/// \return A reference to a gz::math::Capsuled object.
public: gz::math::Capsuled &Shape();

/// \brief Calculate an return the Mass Matrix values for the Capsule
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double density);
/// \brief Calculate and return the Mass Matrix values for the Capsule
/// \param[in] density Density of the capsule in kg/m^3
/// \return A std::optional with gz::math::MassMatrix3d object or std::nullopt
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double _density);

/// \brief Create and return an SDF element filled with data from this
/// capsule.
Expand Down
4 changes: 2 additions & 2 deletions include/sdf/Collision.hh
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ namespace sdf

/// \brief Set the density of the collision.
/// The density of the collision must be unique within the scope of a Link.
/// \param[in] _name Density of the collision.
public: void SetDensity(const double density);
/// \param[in] _density Density of the collision.
public: void SetDensity(const double _density);

/// \brief Get a pointer to the collisions's geometry.
/// \return The collision's geometry.
Expand Down
6 changes: 4 additions & 2 deletions include/sdf/Cylinder.hh
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,10 @@ namespace sdf
/// \return A reference to a gz::math::Cylinderd object.
public: gz::math::Cylinderd &Shape();

/// \brief Calculate an return the Mass Matrix values for the Cylinder
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double density);
/// \brief Calculate and return the Mass Matrix values for the Cylinder
/// \param[in] density Density of the cylinder in kg/m^3
/// \return A std::optional with gz::math::MassMatrix3d object or std::nullopt
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double _density);

/// \brief Create and return an SDF element filled with data from this
/// cylinder.
Expand Down
6 changes: 4 additions & 2 deletions include/sdf/Ellipsoid.hh
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,10 @@ namespace sdf
/// \return A reference to a gz::math::Ellipsoidd object.
public: gz::math::Ellipsoidd &Shape();

/// \brief Calculate an return the Mass Matrix values for the Cylinder
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double density);
/// \brief Calculate and return the Mass Matrix values for the Ellipsoid
/// \param[in] density Density of the ellipsoid in kg/m^3
/// \return A std::optional with gz::math::MassMatrix3d object or std::nullopt
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double _density);

/// \brief Create and return an SDF element filled with data from this
/// ellipsoid.
Expand Down
6 changes: 1 addition & 5 deletions include/sdf/Geometry.hh
Original file line number Diff line number Diff line change
Expand Up @@ -212,12 +212,8 @@ namespace sdf
public: void SetHeightmapShape(const Heightmap &_heightmap);

/// \brief Calculate and return the Mass Matrix values for the Geometry
/// \param[in] _xxyyzz A vector 3d representing the diagonal elements
/// of the mass matrix
/// \param[in] _xyxzyx A vector 3d representing the off-diagonal elements
/// of the mass matrix
/// \param[in] _density The density of the geometry element.
/// \return Boolean that indicates whether the calculation was successfull
/// \return A std::optional with gz::math::MassMatrix3d object or std::nullopt
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double _density);

/// \brief Get a pointer to the SDF element that was used during
Expand Down
6 changes: 4 additions & 2 deletions include/sdf/Sphere.hh
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,10 @@ namespace sdf
/// not been called.
public: sdf::ElementPtr Element() const;

/// \brief Calculate an return the Mass Matrix values for the Cylinder
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double density);
/// \brief Calculate and return the Mass Matrix values for the Sphere
/// \param[in] density Density of the sphere in kg/m^3
/// \return A std::optional with gz::math::MassMatrix3d object or std::nullopt
public: std::optional< gz::math::MassMatrix3d > MassMatrix(const double _density);

/// \brief Create and return an SDF element filled with data from this
/// sphere.
Expand Down

0 comments on commit b092904

Please sign in to comment.