From 7cbf8a30fe3014ca0fbc1b11c36573224160a3d7 Mon Sep 17 00:00:00 2001 From: Gabriel Pacheco Date: Thu, 20 Feb 2025 13:02:08 -0300 Subject: [PATCH] Fix and improve new methods API documentation Signed-off-by: Gabriel Pacheco --- include/gz/sim/Link.hh | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/include/gz/sim/Link.hh b/include/gz/sim/Link.hh index 9ea5d95f63..c809843fb5 100644 --- a/include/gz/sim/Link.hh +++ b/include/gz/sim/Link.hh @@ -362,18 +362,18 @@ namespace gz /// collision shapes attached to the it. The link bounding box is /// generated by merging all the bounding boxes of the collision /// geometries. - /// \param _ecm + /// \param[in] _ecm Entity-component manager. /// \return Link's axis-aligned bounding box in the link frame or - /// nullopt if the link does not have collisions. It may return an - /// empty bounding box if all of the link collisions are empty. + /// nullopt if the link does not have collisions. It returns an + /// invalid bounding box if all of the link collisions are empty. public: std::optional AxisAlignedBox( const EntityComponentManager &_ecm) const; /// \brief Get the link's axis-aligned bounding box in the world frame - /// \param _ecm Entity-component manager. + /// \param[in] _ecm Entity-component manager. /// \return Link's axis-aligned bounding box in the world frame or - /// nullopt if the link does not have collisions. It may return an - /// empty bounding box if all of the link collisions are empty. + /// nullopt if the link does not have collisions. It returns an + /// invalid bounding box if all of the link collisions are empty. /// \sa AxisAlignedBox public: std::optional WorldAxisAlignedBox( const EntityComponentManager &_ecm) const;