Skip to content

Commit b1d5c51

Browse files
committed
docs: Rename param tags to match signature in doxygen docstrings
1 parent 5fde86d commit b1d5c51

File tree

17 files changed

+31
-30
lines changed

17 files changed

+31
-30
lines changed

lib/gis/paths.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ char *G_convert_dirseps_from_host(char *path)
120120
* Returns information about the specified file.
121121
*
122122
* \param file_name file name
123-
* \param stat pointer to structure filled with file information
123+
* \param buf pointer to structure filled with file information
124124
*
125125
* \return Return value from system lstat function
126126
**/
@@ -137,7 +137,7 @@ int G_stat(const char *file_name, struct stat *buf)
137137
*
138138
* \param file_name file name, in the case of a symbolic link, the
139139
* link itself is stat-ed, not the file that it refers to
140-
* \param stat pointer to structure filled with file information
140+
* \param buf pointer to structure filled with file information
141141
*
142142
* \return Return value from system lstat function
143143
**/

lib/gis/tempfile.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ void G__temp_element(char *element, int tmp)
180180
* \brief Populates element with a path string (internal use only!)
181181
*
182182
* \param[out] element element name
183-
* \param tmp
183+
* \param basedir
184184
*/
185185
void G__temp_element_basedir(char *element, const char *basedir)
186186
{

lib/gis/wind_format.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ void G_format_easting(double east, char *buf, int projection)
6262
* Converts the double representation of the <i>resolution</i> to its
6363
* ASCII representation (into <i>buf</i>).
6464
*
65-
* \param resolution resolution value
65+
* \param res resolution value
6666
* \param[out] buf buffer to hold formatted string
6767
* \param projection projection code, or -1 to force full precision FP
6868
*/

lib/gis/wind_scan.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ int G_scan_easting(const char *buf, double *easting, int projection)
9191
- PROJECTION_OTHER
9292
9393
\param buf buffer containing string resolution
94-
\param[out] resolution resolution value
94+
\param[out] res resolution value
9595
\param projection projection code
9696
9797
\return 0 on error

lib/imagery/manage_signatures.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ int I_signatures_remove(I_SIGFILE_TYPE type, const char *name)
105105
* It is safe to pass fully qualified names.
106106
*
107107
* \param type I_SIGFILE_TYPE signature type
108-
* \param name of old signature
109-
* \param mapset of old signature
110-
* \param name of new signature
108+
* \param old_name of old signature
109+
* \param old_mapset of old signature
110+
* \param new_name of new signature
111111
* \return 0 on success
112112
* \return 1 on failure
113113
*/

lib/imagery/sig.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,8 @@ int I_read_signatures(FILE *fd, struct Signature *S)
237237
* I_fopen_signature_file_new()
238238
* It is up to caller to fclose the file stream afterwards.
239239
*
240-
* \param pointer to FILE*
241-
* \param pointer to struct Signature *S
240+
* \param fd to FILE*
241+
* \param Sr to struct Signature *S
242242
*
243243
* \return always 1
244244
*/
@@ -314,8 +314,8 @@ int I_write_signatures(FILE *fd, struct Signature *S)
314314
* \code if (ret && ret[1]) printf("List of imagery group bands without
315315
* signatures: %s\n, ret[1]); \endcode
316316
*
317-
* \param *Signature existing signatures to check & sort
318-
* \param *Ref group reference
317+
* \param Signature existing signatures to check & sort
318+
* \param Ref group reference
319319
*
320320
* \return NULL successfully sorted
321321
* \return err_array two comma separated lists of mismatches

lib/imagery/sigset.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ struct SubSig *I_NewSubSig(struct SigSet *S, struct ClassSig *C)
133133
* There is no need to initialise struct SigSet in advance, as this
134134
* function internally calls I_InitSigSet.
135135
*
136-
* \param pointer to FILE*
137-
* \param pointer to struct SigSet *S
136+
* \param fd pointer to FILE*
137+
* \param S pointer to struct SigSet *S
138138
*
139139
* \return 1 on success, -1 on failure
140140
*/

lib/ogsf/gs.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ void print_frto(float (*ft)[4])
350350
351351
\todo G_debug ?
352352
353-
\param ft pointer to coordinates
353+
\param rt pointer to coordinates
354354
*/
355355
void print_realto(float *rt)
356356
{
@@ -364,7 +364,7 @@ void print_realto(float *rt)
364364
365365
\todo G_debug ?
366366
367-
\param ft pointer to buffer
367+
\param buff pointer to buffer
368368
*/
369369
void print_256lookup(int *buff)
370370
{

lib/ogsf/gs2.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1524,7 +1524,7 @@ int GS_num_surfs(void)
15241524
15251525
Must be freed when not needed!
15261526
1527-
\param[out] numsurf number of available surfaces
1527+
\param[out] numsurfs number of available surfaces
15281528
15291529
\return pointer to surface array
15301530
\return NULL on error

lib/ogsf/gsd_objs.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ void gsd_x(geosurf *gs, float *center, int colr, float siz)
300300
301301
\param center center point
302302
\param colr color value
303-
\param size size value
303+
\param siz size value
304304
*/
305305
void gsd_diamond(float *center, unsigned long colr, float siz)
306306
{

0 commit comments

Comments
 (0)