Skip to content

Commit de02d3f

Browse files
committed
Update Doxygen for PDALGetAllPackedPoints
1 parent e4ef69a commit de02d3f

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

source/pdal/pdalc_pointview.h

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,25 +115,31 @@ namespace pdal
115115
* @param view The view that contains the point
116116
* @param dims List of dimensions to retrieve
117117
* @param idx Index of point to get
118-
* @param[out] buf Pointer to buffer to fill
118+
* @param[out] buffer Pointer to buffer to fill
119119
* @return The size of the retrieved point
120120
* or zero if view` is NULL, `dims` is NULL, `buf` is NULL, or `idx` is out of bounds
121121
*/
122-
PDALC_API size_t PDALGetPackedPoint(PDALPointViewPtr view, PDALDimTypeListPtr dims, PDALPointId idx, char *buf);
122+
PDALC_API size_t PDALGetPackedPoint(PDALPointViewPtr view, PDALDimTypeListPtr dims, PDALPointId idx, char *buffer);
123123

124124
/**
125125
* Retrieves data for all points based on the provided dimension list.
126126
*
127+
* @note Behavior will be undefined if `buffer` is not large enough
128+
* to contain all the packed point data
129+
*
130+
* @see Use the product of the values returned by PDALGetPointViewSize
131+
* and PDALGetPointSize to obtain the minimum byte size for `buffer`
132+
*
127133
* @see pdal::PointView::getPackedPoint
128134
*
129135
* @param view The view that contains the points
130136
* @param dims List of dimensions to retrieve
131137
* @param idx Index of point to get
132-
* @param[out] buf Pointer to buffer to fill
138+
* @param[out] buffer Pointer to buffer to fill
133139
* @return The size of the points stored in `buf`
134140
* or zero if `view` is NULL, `dims` is NULL, or `buf` is NULL
135141
*/
136-
PDALC_API uint64_t PDALGetAllPackedPoints(PDALPointViewPtr view, PDALDimTypeListPtr dims, char *buf);
142+
PDALC_API uint64_t PDALGetAllPackedPoints(PDALPointViewPtr view, PDALDimTypeListPtr dims, char *buffer);
137143

138144
#ifdef __cplusplus
139145
}

0 commit comments

Comments
 (0)