search

gazebosim / gazebo-classic

Gazebo classic. For the latest version, see https://github.com/gazebosim/gz-sim
http://classic.gazebosim.org/
Other
1.15k stars 477 forks source link

Doxygen documentation for Pose gazebo::math::Pose::operator+ is unhelpful #1313

Open osrf-migration opened 9 years ago

osrf-migration commented 9 years ago

Original report (archived issue) by Jackie K (Bitbucket: jacquelinekay).

The documentation is as follows:

Pose gazebo::math::Pose::operator+ ( const Pose & _pose ) const

Addition operator A is the transform from O to P specified in frame O B is the transform from P to Q specified in frame P then, B + A is the transform from O to Q specified in frame O.

Parameters: [in] _pose Pose to add to this pose Returns: The resulting pose

I have no idea what A, O, P, B, or Q are. I mean, I can guess, but it's not immediately clear how they relate to the input and output parameters.

osrf-migration commented 9 years ago

Original comment by Steve Peters (Bitbucket: Steven Peters, GitHub: scpeters).

We need pictures.

osrf-migration commented 9 years ago

Original comment by Steve Peters (Bitbucket: Steven Peters, GitHub: scpeters).

See also #216

osrf-migration commented 9 years ago

Original comment by Steve Peters (Bitbucket: Steven Peters, GitHub: scpeters).

osrf-migration commented 7 years ago

Original comment by Nate Koenig (Bitbucket: Nathan Koenig).