Skip to content

Commit 3d9f88c

Browse files
authored
replace use of PRE tags with \verbatim in doxygen (ros2#57)
* replace use of PRE tags with \verbatim in doxygen * mismatched parameter name in doxygen
1 parent cecbbde commit 3d9f88c

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

sensor_msgs/include/sensor_msgs/impl/point_cloud2_iterator.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ PointCloud2IteratorBase<T, TT, U, C, V>::PointCloud2IteratorBase()
262262
}
263263

264264
/**
265-
* @param cloud_msg_ The PointCloud2 to iterate upon
265+
* @param cloud_msg The PointCloud2 to iterate upon
266266
* @param field_name The field to iterate upon
267267
*/
268268
template<typename T, typename TT, typename U, typename C, template<typename> class V>

sensor_msgs/include/sensor_msgs/point_cloud2_iterator.hpp

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
*
4747
* This file provides two sets of utilities to modify and parse PointCloud2
4848
* The first set allows you to conveniently set the fields by hand:
49-
* <PRE>
49+
* \verbatim
5050
* #include <sensor_msgs/point_cloud_iterator.h>
5151
* // Create a PointCloud2
5252
* sensor_msgs::msg::PointCloud2 cloud_msg;
@@ -67,10 +67,10 @@
6767
* modifier.setPointCloud2FieldsByString(2, "xyz", "rgb");
6868
* // You can then reserve / resize as usual
6969
* modifier.resize(100);
70-
* </PRE>
70+
* \endverbatim
7171
*
7272
* The second set allow you to traverse your PointCloud using an iterator:
73-
* <PRE>
73+
* \verbatim
7474
* // Define some raw data we'll put in the PointCloud2
7575
* float point_data[] = {1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0};
7676
* uint8_t color_data[] = {40, 80, 120, 160, 200, 240, 20, 40, 60, 80, 100, 120};
@@ -95,7 +95,7 @@
9595
* *iter_g = color_data[3*i+1];
9696
* *iter_b = color_data[3*i+2];
9797
* }
98-
* </PRE>
98+
* \endverbatim
9999
*/
100100

101101
namespace sensor_msgs
@@ -140,12 +140,12 @@ class PointCloud2Modifier
140140
* field, the datatype of the elements in the field
141141
*
142142
* E.g, you create your PointCloud2 message with XYZ/RGB as follows:
143-
* <PRE>
143+
* \verbatim
144144
* setPointCloud2Fields(cloud_msg, 4, "x", 1, sensor_msgs::msg::PointField::FLOAT32,
145145
* "y", 1, sensor_msgs::msg::PointField::FLOAT32,
146146
* "z", 1, sensor_msgs::msg::PointField::FLOAT32,
147147
* "rgb", 1, sensor_msgs::msg::PointField::FLOAT32);
148-
* </PRE>
148+
* \endverbatim
149149
* WARNING: THIS DOES NOT TAKE INTO ACCOUNT ANY PADDING AS DONE UNTIL HYDRO
150150
* For simple usual cases, the overloaded setPointCloud2FieldsByString is what you want.
151151
*/
@@ -261,22 +261,22 @@ class PointCloud2IteratorBase
261261
*
262262
* T type of the element being iterated upon
263263
* E.g, you create your PointClou2 message as follows:
264-
* <PRE>
264+
* \verbatim
265265
* setPointCloud2FieldsByString(cloud_msg, 2, "xyz", "rgb");
266-
* </PRE>
266+
* \endverbatim
267267
*
268268
* For iterating over XYZ, you do :
269-
* <PRE>
269+
* \verbatim
270270
* sensor_msgs::msg::PointCloud2Iterator<float> iter_x(cloud_msg, "x");
271-
* </PRE>
271+
* \endverbatim
272272
* and then access X through iter_x[0] or *iter_x
273273
* You could create an iterator for Y and Z too but as they are consecutive,
274274
* you can just use iter_x[1] and iter_x[2]
275275
*
276276
* For iterating over RGB, you do:
277-
* <PRE>
277+
* \verbatim
278278
* sensor_msgs::msg::PointCloud2Iterator<uint8_t> iter_rgb(cloud_msg, "rgb");
279-
* </PRE>
279+
* \endverbatim
280280
* and then access R,G,B through iter_rgb[0], iter_rgb[1], iter_rgb[2]
281281
*/
282282
template<typename T>

0 commit comments

Comments
 (0)