Skip to content

Commit c6f81ec

Browse files
committed
Address Doxygen warnings
1 parent 79032b1 commit c6f81ec

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

source/pdal/pdalc_config.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ namespace pdal
4444
/**
4545
* Sets the path to the GDAL data directory.
4646
*
47-
* @oaram path The path to set
47+
* @param path The path to set
4848
*/
4949
PDALC_API void PDALSetGdalDataPath(const char *path);
5050

5151
/**
5252
* Sets the path to the proj4 data directory.
5353
*
54-
* @oaram path The path to set
54+
* @param path The path to set
5555
*/
5656
PDALC_API void PDALSetProj4DataPath(const char *path);
5757

@@ -98,7 +98,7 @@ namespace pdal
9898
*
9999
* @see pdal::config::sha1
100100
*
101-
* @param[out] version The buffer used to retrieve the SHA1 string
101+
* @param[out] sha1 The buffer used to retrieve the SHA1 string
102102
* @param size The size of the provided buffer
103103
* @return The size of the retrieved SHA1 string
104104
*/
@@ -136,7 +136,7 @@ namespace pdal
136136
*
137137
* @see pdal::config::debugInformation
138138
*
139-
* @param[out] version The buffer used to retrieve the debugging information
139+
* @param[out] info The buffer used to retrieve the debugging information
140140
* @param size The size of the provided buffer
141141
* @return The size of the retrieved debugging information
142142
*/
@@ -147,7 +147,7 @@ namespace pdal
147147
*
148148
* @see pdal::config::pluginInstallPath
149149
*
150-
* @param[out] version The buffer used to retrieve the installation path
150+
* @param[out] path The buffer used to retrieve the installation path
151151
* @param size The size of the provided buffer
152152
* @return The size of the retrieved installation path
153153
*/

source/pdal/pdalc_pipeline.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ namespace pdal
3737
/**
3838
* Disposes a PDAL pipeline.
3939
*
40-
* @param The pipeline to dispose
40+
* @param pipeline The pipeline to dispose
4141
*/
4242
PDALC_API void PDALDisposePipeline(PDALPipelinePtr pipeline);
4343

@@ -55,7 +55,7 @@ namespace pdal
5555
* Retrieves a pipeline's computed metadata.
5656
*
5757
* @param pipeline The pipeline
58-
* @param[out] schema The buffer used to store the computed metadata for the pipeline and all stages
58+
* @param[out] metadata The buffer used to store the computed metadata for the pipeline and all stages
5959
* @param size The size of the provided buffer
6060
* @return The size of the retrieved metadata string or 0 if it could not be retrieved
6161
*/
@@ -65,7 +65,7 @@ namespace pdal
6565
* Retrieves a pipeline's computed schema.
6666
*
6767
* @param pipeline The pipeline
68-
* @param[out] The buffer used to store the computed schema for the pipeline
68+
* @param[out] schema The buffer used to store the computed schema for the pipeline
6969
* @param size The size of the provided buffer
7070
* @return The size of the retrieved schema or 0 if it could not be retrieved
7171
*/
@@ -77,7 +77,7 @@ namespace pdal
7777
* @see PDALSetPipelineLogLevel to adjust logging verbosity
7878
*
7979
* @param pipeline The pipeline
80-
* @param[out] The buffer used to store the log output for the executed pipeline
80+
* @param[out] log The buffer used to store the log output for the executed pipeline
8181
* @param size The size of the provided buffer
8282
* @return The size of the retrieved log or 0 if it could not be retrieved
8383
*/

source/pdal/pdalc_pointview.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ namespace pdal
134134
*
135135
* @param view The view that contains the points
136136
* @param dims List of dimensions to retrieve
137-
* @param idx Index of point to get
138137
* @param[out] buffer Pointer to buffer to fill
139138
* @return The size of the points stored in `buf`
140139
* or zero if `view` is NULL, `dims` is NULL, or `buf` is NULL

0 commit comments

Comments
 (0)