Improve AxisAlignedBox methods documentation

Signed-off-by: Gabriel Pacheco <[email protected]>
gazebosim · Mar 10, 2025 · 529d2e6 · 529d2e6
1 parent 546b34b
commit 529d2e6
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 7 deletions.
diff --git a/include/sdf/Box.hh b/include/sdf/Box.hh
@@ -78,7 +78,8 @@ namespace sdf
             CalculateInertial(double _density);
 
     /// \brief Get the Axis-aligned box for this Box.
-    /// \return A gz::math::AxisAlignedBox object.
+    /// \return A gz::math::AxisAlignedBox object centered at this
+    /// Box's center.
     public: gz::math::AxisAlignedBox AxisAlignedBox() const;
 
     /// \brief Create and return an SDF element filled with data from this

diff --git a/include/sdf/Capsule.hh b/include/sdf/Capsule.hh
@@ -85,7 +85,8 @@ namespace sdf
       double _density);
 
     /// \brief Get the Axis-aligned box for this Capsule.
-    /// \return A gz::math::AxisAlignedBox object.
+    /// \return A gz::math::AxisAlignedBox object centered at this
+    /// Capsules's center.
     public: gz::math::AxisAlignedBox AxisAlignedBox() const;
 
     /// \brief Create and return an SDF element filled with data from this

diff --git a/include/sdf/Cone.hh b/include/sdf/Cone.hh
@@ -87,7 +87,8 @@ namespace sdf
             CalculateInertial(double _density);
 
     /// \brief Get the Axis-aligned box for this Cone.
-    /// \return A gz::math::AxisAlignedBox object.
+    /// \return A gz::math::AxisAlignedBox object centered at this
+    /// Cones's center.
     public: gz::math::AxisAlignedBox AxisAlignedBox() const;
 
     /// \brief Create and return an SDF element filled with data from this

diff --git a/include/sdf/Cylinder.hh b/include/sdf/Cylinder.hh
@@ -85,7 +85,8 @@ namespace sdf
             CalculateInertial(double _density);
 
     /// \brief Get the Axis-aligned box for this Cylinder.
-    /// \return A gz::math::AxisAlignedBox object.
+    /// \return A gz::math::AxisAlignedBox object centered at this
+    /// Cylinder's center.
     public: gz::math::AxisAlignedBox AxisAlignedBox() const;
 
     /// \brief Create and return an SDF element filled with data from this

diff --git a/include/sdf/Ellipsoid.hh b/include/sdf/Ellipsoid.hh
@@ -77,7 +77,8 @@ namespace sdf
             CalculateInertial(double _density);
 
     /// \brief Get the Axis-aligned box for this Ellipsoid.
-    /// \return A gz::math::AxisAlignedBox object.
+    /// \return A gz::math::AxisAlignedBox object centered at this
+    /// Ellipsoids's center.
     public: gz::math::AxisAlignedBox AxisAlignedBox() const;
 
     /// \brief Create and return an SDF element filled with data from this

diff --git a/include/sdf/Mesh.hh b/include/sdf/Mesh.hh
@@ -213,7 +213,8 @@ namespace sdf
     /// \brief Get the Axis-aligned box for this Mesh.
     /// \param[in] _aabbCalc A custom function that calculates the
     /// AxisAlignedBox for the Mesh.
-    /// \return A gz::math::AxisAlignedBox object.
+    /// \return A gz::math::AxisAlignedBox object centered at this
+    /// Mesh's origin.
     public: std::optional<gz::math::AxisAlignedBox>
             AxisAlignedBox(const AxisAlignedBoxCalculator &_aabbCalc) const;
 

diff --git a/include/sdf/Sphere.hh b/include/sdf/Sphere.hh
@@ -78,7 +78,8 @@ namespace sdf
             CalculateInertial(double _density);
 
     /// \brief Get the Axis-aligned box for this Sphere.
-    /// \return A gz::math::AxisAlignedBox object.
+    /// \return A gz::math::AxisAlignedBox object centered at this
+    /// Sphere's center.
     public: gz::math::AxisAlignedBox AxisAlignedBox() const;
 
     /// \brief Create and return an SDF element filled with data from this