Fix rosdoc2 warnings in sensor_msgs. #162
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make sure the build of documentation is clean. No functional changes in here, though there are some formatting changes to make things easier to document. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>
gbiggs
reviewed
Nov 15, 2021
Comment on lines
-162
to
-178
| /** | ||
| * @brief Function setting some fields in a PointCloud and adjusting the | ||
| * internals of the PointCloud2 | ||
| * @param n_fields the number of fields to add. The fields are given as | ||
| * triplets: name of the field as char*, number of elements in the | ||
| * field, the datatype of the elements in the field | ||
| * | ||
| * E.g, you create your PointCloud2 message with XYZ/RGB as follows: | ||
| * <PRE> | ||
| * setPointCloud2FieldsByString(cloud_msg, 4, "x", 1, sensor_msgs::msg::PointField::FLOAT32, | ||
| * "y", 1, sensor_msgs::msg::PointField::FLOAT32, | ||
| * "z", 1, sensor_msgs::msg::PointField::FLOAT32, | ||
| * "rgb", 1, sensor_msgs::msg::PointField::FLOAT32); | ||
| * </PRE> | ||
| * WARNING: THIS DOES NOT TAKE INTO ACCOUNT ANY PADDING AS DONE UNTIL HYDRO | ||
| * For simple usual cases, the overloaded setPointCloud2FieldsByString is what you want. | ||
| */ |
There was a problem hiding this comment.
Is this documentation block removed because it's an implementation file?
There was a problem hiding this comment.
Yes, exactly. Doxygen was complaining that n_fields was documented twice, and that was because we had the same docblock on the declaration and definition. Removing one of them gets rid of that warning.
Comment on lines
-201
to
-210
| /** | ||
| * @brief Function setting some fields in a PointCloud and adjusting the | ||
| * internals of the PointCloud2 | ||
| * @param n_fields the number of fields to add. The fields are given as | ||
| * strings: "xyz" (3 floats), "rgb" (3 uchar stacked in a float), | ||
| * "rgba" (4 uchar stacked in a float) | ||
| * @return void | ||
| * | ||
| * WARNING: THIS FUNCTION DOES ADD ANY NECESSARY PADDING TRANSPARENTLY | ||
| */ |
There was a problem hiding this comment.
Is this documentation block removed because it's an implementation file?
There was a problem hiding this comment.
Same answer as above.
gbiggs
approved these changes
Nov 17, 2021
|
Since this is "just" a change to the comments (and a bit of formatting fixes), I'm going to merge it just based on the Rpr results. Thanks for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make sure the build of documentation is clean. No functional
changes in here, though there are some formatting changes to make
things easier to document.
Signed-off-by: Chris Lalancette clalancette@openrobotics.org