Skip to content

Commit

Permalink
Fix doxygen warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Louise Poubel <[email protected]>
  • Loading branch information
chapulina committed Mar 11, 2022
1 parent f3a01c3 commit cb30517
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions include/ignition/msgs/PointCloudPackedUtils.hh
Original file line number Diff line number Diff line change
Expand Up @@ -38,29 +38,30 @@ namespace msgs
/// \brief Class that can iterate over a PointCloudPacked message.
///
/// E.g, you create your message and reserve space for data as follows:
/// \verbatim
///
/// \code{.cpp}
/// ignition::msgs::PointCloudPacked pcMsg;
/// ignition::msgs::InitPointCloudPacked(pcMsg, "my_new_frame", false,
/// {{"a", PointCloudPacked::Field::FLOAT32}});
/// pcMsg.mutable_data()->resize(numPts * pcMsg.point_step());
/// \endverbatim
/// \endcode
///
/// For iterating over "a", you do :
///
/// \verbatim
/// \code{.cpp}
/// ignition::msgs::PointCloudPackedIterator<float> iterA(pcMsg, "a");
/// \endverbatim
/// \endcode
///
/// And then access it through iterA[0] or *iterA.
///
/// For iterating over RGBA, you can access each element as uint8_t:
///
/// \verbatim
/// \code{.cpp}
/// ignition::msgs::PointCloudPackedIterator<uint8_t> iterR(pcMsg, "r");
/// ignition::msgs::PointCloudPackedIterator<uint8_t> iterG(pcMsg, "g");
/// ignition::msgs::PointCloudPackedIterator<uint8_t> iterB(pcMsg, "b");
/// ignition::msgs::PointCloudPackedIterator<uint8_t> iterA(pcMsg, "a");
/// \endverbatim
/// \endcode
///
/// \tparam FieldType Type of the element being iterated upon
template<typename FieldType>
Expand Down

0 comments on commit cb30517

Please sign in to comment.