Corrected function comments

Signed-off-by: Jasmeet Singh <[email protected]>

include/sdf/Box.hh

@@ -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.

include/sdf/Capsule.hh

@@ -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.

include/sdf/Collision.hh

@@ -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.

include/sdf/Cylinder.hh

@@ -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.

include/sdf/Ellipsoid.hh

@@ -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.

include/sdf/Geometry.hh

@@ -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

include/sdf/Sphere.hh

@@ -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.