Skip to content

Commit 7ffa255

Browse files
committed
docs(lib): Fix formatting of parameter descriptions to solve doxygen warnings
1 parent 9bef6a8 commit 7ffa255

File tree

9 files changed

+37
-26
lines changed

9 files changed

+37
-26
lines changed

lib/gis/tempfile.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ void G_temp_element(char *element)
155155
*
156156
* \param[out] element element name
157157
* \param tmp TRUE to use G_make_mapset_element_tmp() instead of
158-
* G_make_mapset_element()
158+
* G_make_mapset_element()
159159
*/
160160
void G__temp_element(char *element, int tmp)
161161
{

lib/gmath/la.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1569,7 +1569,7 @@ mat_struct *G_matrix_resize(mat_struct *in, int rows, int cols)
15691569
}
15701570

15711571
/*!
1572-
* \fn int G_matrix_read_stdin (mat_struct *out)
1572+
* \fn int G_matrix_stdin(mat_struct *out)
15731573
*
15741574
* \brief Read a matrix from standard input
15751575
*

lib/ogsf/gs2.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ int GS_transp_is_set(void)
494494
/*!
495495
\brief Retrieves coordinates for lighting model position, at center of view
496496
497-
\param pos[out] coordinates
497+
\param[out] pos coordinates
498498
*/
499499
void GS_get_modelposition1(float pos[])
500500
{
@@ -522,8 +522,8 @@ void GS_get_modelposition1(float pos[])
522522
know position to calculate size, have two dependent variables
523523
(nearclip * 2) from eye.
524524
525-
\param siz[out] size
526-
\param pos[out] coordinates (X, Y, Z)
525+
\param[out] siz size
526+
\param[out] pos coordinates (X, Y, Z)
527527
*/
528528
void GS_get_modelposition(float *siz, float *pos)
529529
{

lib/ogsf/gsd_objs.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1213,7 +1213,8 @@ int gsd_scalebar(float *pos2, float len, GLuint fontbase, unsigned long bar_clr,
12131213
12141214
Adapted from gsd_scalebar A.Kratochvilova 2011
12151215
1216-
\param pos2 scalebar position
1216+
\param pos scalebar position
1217+
\param len
12171218
\param fontbase font-base (unused)
12181219
\param bar_clr barscale color
12191220
\param text_clr text color (unused)

lib/raster3d/open.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ void *Rast3d_open_cell_old_no_header(const char *name, const char *mapset)
7272
* \param name
7373
* \param mapset
7474
* \param window
75-
* \param type
75+
* \param typeIntern
7676
* \param cache
7777
* \return void *
7878
*/

lib/raster3d/open2.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@
3131
* \param doLzw Use the LZW compression algorithm
3232
* \param doRle Use the Run-Length-Encoding algroithm for compression
3333
* \param precision The precision used for the mantissa (0 - 52) or
34-
* RASTER3D_MAX_PRECISION \param tileX The number of cells in X direction of a
35-
* tile \param tileY The number of cells in Y direction of a tile \param tileZ
36-
* The number of cells in Z direction of a tile \return void *
34+
* RASTER3D_MAX_PRECISION
35+
* \param tileX The number of cells in X direction of a tile
36+
* \param tileY The number of cells in Y direction of a tile
37+
* \param tileZ The number of cells in Z direction of a tile
38+
* \return void *
3739
*/
3840

3941
void *Rast3d_open_new_param(const char *name, int typeIntern, int cache,

lib/vector/Vlib/intersect2.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -665,6 +665,8 @@ static int boq_load(struct boq *q, struct line_pnts *Pnts,
665665
* \param BPoints second input line or NULL
666666
* \param[out] ALines array of new lines created from original A line
667667
* \param[out] BLines array of new lines created from original B line
668+
* \param pABox
669+
* \param pBBox
668670
* \param[out] nalines number of new lines (ALines)
669671
* \param[out] nblines number of new lines (BLines)
670672
* \param with_z 3D, not supported!

lib/vector/Vlib/net_analyze.c

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -480,19 +480,24 @@ int Vect_net_get_node_cost(struct Map_info *Map, int node, double *cost)
480480
\brief Find nearest node(s) on network.
481481
482482
\param Map vector map with build graph (see Vect_net_ttb_build_graph and
483-
Vect_net_build_graph) \param x,y,z point coordinates (z coordinate NOT USED
484-
!) \param direction (GV_FORWARD - from point to net, GV_BACKWARD - from net
485-
to point) \param maxdist maximum distance to the network \param[out] node1
486-
pointer where to store the node number (or NULL) \param[out] node2 pointer
487-
where to store the node number (or NULL) \param[out] ln pointer where to
488-
store the nearest line number (or NULL) \param[out] costs1 pointer where to
489-
store costs on nearest line to node1 (not costs from x,y,z to the line) (or
490-
NULL) \param[out] costs2 pointer where to store costs on nearest line to
491-
node2 (not costs from x,y,z to the line) (or NULL) \param[out] Points1
492-
pointer to structure where to store vertices on nearest line to node1 (or
493-
NULL) \param[out] Points2 pointer to structure where to store vertices on
494-
nearest line to node2 (or NULL) \param[out] pointer where to distance to the
495-
line (or NULL) \param[out] distance
483+
Vect_net_build_graph)
484+
\param x,y,z point coordinates (z coordinate NOT USED!)
485+
\param direction (GV_FORWARD - from point to net, GV_BACKWARD - from net
486+
to point)
487+
\param maxdist maximum distance to the network
488+
\param[out] node1 pointer where to store the node number (or NULL)
489+
\param[out] node2 pointer where to store the node number (or NULL)
490+
\param[out] ln pointer where to store the nearest line number (or NULL)
491+
\param[out] costs1 pointer where to store costs on nearest line to node1 (not
492+
costs from x,y,z to the line) (or NULL)
493+
\param[out] costs2 pointer where to store costs on nearest line to node2
494+
(not costs from x,y,z to the line) (or NULL)
495+
\param[out] Points1 pointer to structure where to store vertices on nearest
496+
line to node1 (or NULL)
497+
\param[out] Points2 pointer to structure where to store vertices on nearest
498+
line to node2 (or NULL)
499+
\param[out] pointer where to distance to the line (or NULL)
500+
\param[out] distance
496501
497502
\return number of nodes found (0,1,2)
498503
*/

lib/vector/Vlib/read_nat.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,10 @@ int V1_read_next_line_nat(struct Map_info *Map, struct line_pnts *line_p,
125125
126126
\param Map pointer to Map_info struct
127127
\param[out] Points container used to store line points within (pointer to
128-
line_pnts struct) \param[out] Cats container used to store line categories
129-
within (pointer to line_cats struct) \param line feature id to read (starts
130-
at 1)
128+
line_pnts struct)
129+
\param[out] Cats container used to store line categories
130+
within (pointer to line_cats struct)
131+
\param line feature id to read (starts at 1)
131132
132133
\return feature type (GV_POINT, GV_LINE, ...)
133134
\return -2 nothing to read

0 commit comments

Comments
 (0)