Skip to content

Commit

Permalink
Merge pull request gazebosim#859 from gazebosim/capsule_desc
Browse files Browse the repository at this point in the history
Add more doc mentioning the reason for a Capsule class
  • Loading branch information
iche033 authored Jun 6, 2023
2 parents e39e10f + 5056784 commit b32cbd3
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion include/gz/rendering/Capsule.hh
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@ namespace gz
{
inline namespace GZ_RENDERING_VERSION_NAMESPACE {
/// \class Capsule Capsule.hh gz/rendering/Capsule
/// \brief Geometry for a capsule shape.
/// \brief Geometry for a capsule shape. The APIs allow setting
/// the capsule's radius and length directly which ensure that the
/// the geometry remains the shape of a capsule. In comparison, if
/// the size is changed via the parent Node's Set*Scale function, the
/// capsule may become deformed.
class GZ_RENDERING_VISIBLE Capsule :
public virtual Geometry
{
Expand Down

0 comments on commit b32cbd3

Please sign in to comment.