Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Focal CI: static checkers and doxygen linters #230

Merged
merged 2 commits into from
Mar 12, 2022
Merged

Focal CI: static checkers and doxygen linters #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3a01c3
Focal CI: static checkers and doxygen linters
chapulina Mar 11, 2022
cb30517
Fix doxygen warnings
chapulina Mar 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@ jobs:
- name: Compile and test
id: ci
uses: ignition-tooling/action-ignition-ci@focal
with:
cppcheck-enabled: true
cpplint-enabled: true
doxygen-enabled: true
13 changes: 7 additions & 6 deletions include/ignition/msgs/PointCloudPackedUtils.hh
View file
Open in desktop
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