Skip to content

Commit f04c4b9

Browse files
authored
Merge pull request #5955 from mvieth/io_improve_doc
Improve documentation in vtk_lib_io
2 parents 9481fd9 + 440cdbc commit f04c4b9

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

io/include/pcl/io/vtk_lib_io.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ namespace pcl
9292
/** \brief Load a \ref PolygonMesh object given an input file name, based on the file extension
9393
* \param[in] file_name the name of the file containing the polygon data
9494
* \param[out] mesh the object that we want to load the data in
95+
* \return Number of points in the point cloud of the mesh.
9596
* \ingroup io
9697
*/
9798
PCL_EXPORTS int
@@ -113,6 +114,7 @@ namespace pcl
113114
/** \brief Load a VTK file into a \ref PolygonMesh object
114115
* \param[in] file_name the name of the file that contains the data
115116
* \param[out] mesh the object that we want to load the data in
117+
* \return Number of points in the point cloud of the mesh.
116118
* \ingroup io
117119
*/
118120
PCL_EXPORTS int
@@ -122,6 +124,7 @@ namespace pcl
122124
/** \brief Load a PLY file into a \ref PolygonMesh object
123125
* \param[in] file_name the name of the file that contains the data
124126
* \param[out] mesh the object that we want to load the data in
127+
* \return Number of points in the point cloud of the mesh.
125128
* \ingroup io
126129
*/
127130
PCL_EXPORTS int
@@ -131,6 +134,7 @@ namespace pcl
131134
/** \brief Load an OBJ file into a \ref PolygonMesh object
132135
* \param[in] file_name the name of the file that contains the data
133136
* \param[out] mesh the object that we want to load the data in
137+
* \return Number of points in the point cloud of the mesh.
134138
* \ingroup io
135139
*/
136140
PCL_EXPORTS int
@@ -143,6 +147,7 @@ namespace pcl
143147
* load the material information.
144148
* \param[in] file_name the name of the file that contains the data
145149
* \param[out] mesh the object that we want to load the data in
150+
* \return Number of points in the point cloud of the mesh.
146151
* \ingroup io
147152
*/
148153
PCL_EXPORTS int
@@ -153,6 +158,7 @@ namespace pcl
153158
/** \brief Load an STL file into a \ref PolygonMesh object
154159
* \param[in] file_name the name of the file that contains the data
155160
* \param[out] mesh the object that we want to load the data in
161+
* \return Number of points in the point cloud of the mesh.
156162
* \ingroup io
157163
*/
158164
PCL_EXPORTS int

0 commit comments

Comments
 (0)