Skip to content

Commit 5fde86d

Browse files
committed
docs: Add missing param tags in doxygen docstrings
1 parent f695adc commit 5fde86d

File tree

11 files changed

+18
-5
lines changed

11 files changed

+18
-5
lines changed

lib/gis/lz4.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,8 @@ LZ4LIB_API int LZ4_compress_default(const char *src, char *dst, int srcSize,
206206
int dstCapacity);
207207

208208
/*! LZ4_decompress_safe() :
209+
* @param src
210+
* @param dst
209211
* @param compressedSize is the exact complete size of the compressed block.
210212
* @param dstCapacity is the size of destination buffer (which must be already
211213
* allocated), presumed an upper bound of decompressed

lib/gis/open_misc.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ static int G__open_misc(const char *dir, const char *element, const char *name,
103103
* exist, -1 is returned. Otherwise the file is positioned at the end of the
104104
* file and the file descriptor from the open( ) is returned.
105105
*
106+
* \param dir
106107
* \param element
107108
* \param name
108109
* \return int
@@ -123,6 +124,7 @@ int G_open_new_misc(const char *dir, const char *element, const char *name)
123124
* exist, -1 is returned. Otherwise the file descriptor from the open( ) is
124125
* returned.
125126
*
127+
* \param dir
126128
* \param element
127129
* \param name
128130
* \param mapset
@@ -144,6 +146,7 @@ int G_open_old_misc(const char *dir, const char *element, const char *name,
144146
* exist, -1 is returned. Otherwise the file is positioned at the end of the
145147
* file and the file descriptor from the open( ) is returned.
146148
*
149+
* \param dir
147150
* \param element
148151
* \param name
149152
* \return int
@@ -170,6 +173,7 @@ int G_open_update_misc(const char *dir, const char *element, const char *name)
170173
* positioned at the end of the file and the file descriptor from the fopen( )
171174
* is returned.
172175
*
176+
* \param dir
173177
* \param element
174178
* \param name
175179
* \return FILE *

lib/gmath/la.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1309,6 +1309,7 @@ double G_vector_norm1(vec_struct *vc)
13091309
*
13101310
* \param v1
13111311
* \param v2
1312+
* \param out Output vector
13121313
* \return vec_struct
13131314
*/
13141315

lib/ogsf/gs2.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,8 @@ void GS_draw_line_onsurf(int id, float x1, float y1, float x2, float y2)
707707
708708
\param id surface id
709709
\param x1,y1,x2,y2 line nodes
710+
\param lasp
711+
\param n
710712
711713
\return number of points used
712714
*/

lib/ogsf/gsd_objs.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1127,6 +1127,7 @@ void gsd_3darrow(float *center, unsigned long colr, float siz1, float siz2,
11271127
Adapted from gsd_north_arrow Hamish Bowman Dec 2006
11281128
11291129
\param pos2
1130+
\param len
11301131
\param fontbase font-base
11311132
\param bar_clr barscale color
11321133
\param text_clr text color

lib/ogsf/gsdrape.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -684,6 +684,7 @@ int viewcell_tri_interp(geosurf *gs, typbuff *buf, Point3 pt, int check_mask)
684684
\brief ADD
685685
686686
\param gs surface (geosurf)
687+
\param pt
687688
688689
\return 1
689690
\return 0

lib/raster3d/mask.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ void Rast3d_mask_num(RASTER3D_Map *map, int x, int y, int z, void *value,
213213
*
214214
* Same as <em>Rast3d_mask_num (x, y, z, value, FCELL_TYPE)</em>.
215215
*
216+
* \param map
216217
* \param x
217218
* \param y
218219
* \param z

lib/raster3d/resample.c

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ void Rast3d_nearest_neighbor(RASTER3D_Map *map, int x, int y, int z,
4646
* Sets the resampling function to be used by
4747
* Rast3d_get_value () (cf.{g3d:G3d.getValue}). This function is defined
4848
* as follows:
49-
*
50-
* \return void
49+
* \param map
50+
* \param resampleFun
51+
* \return void
5152
*/
52-
5353
void Rast3d_set_resampling_fun(RASTER3D_Map *map,
5454
void (*resampleFun)(RASTER3D_Map *, int, int,
5555
int, void *, int))
@@ -68,7 +68,6 @@ void Rast3d_set_resampling_fun(RASTER3D_Map *map,
6868
*
6969
* \return void
7070
*/
71-
7271
void Rast3d_get_resampling_fun(RASTER3D_Map *map,
7372
void (**resampleFun)(RASTER3D_Map *, int, int,
7473
int, void *, int))

lib/raster3d/windowio.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,6 @@ int Rast3d_read_window(RASTER3D_Region *window, const char *windowName)
261261
*
262262
* \return void
263263
*/
264-
265264
void Rast3d_use_window_params(void)
266265
{
267266
Rast3d_set_window_params();

lib/vector/Vlib/intersect.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,8 @@ static int cross_seg(int id, const struct RTree_Rect *rect UNUSED, void *arg)
648648
*
649649
* \param APoints first input line
650650
* \param BPoints second input line
651+
* \param ABox
652+
* \param BBox
651653
* \param[out] ALines array of new lines created from original A line
652654
* \param[out] BLines array of new lines created from original B line
653655
* \param[out] nalines number of new lines (ALines)

0 commit comments

Comments
 (0)