man: Doxygen docs fix 02

grasslib.dox

@@ -136,8 +136,8 @@ href="https://grass.osgeo.org">https://grass.osgeo.org</a>
  The following files must be added or updated when including a new external library.
 
  - <b>add:</b> lib/external/<b>newlib</b>
- - <b>add:</b> lib/external/<b>newlib</b>/*.c
- - <b>add:</b> lib/external/<b>newlib</b>/*.h
+ - <b>add:</b> lib/external/<b>newlib</b>/\*.c
+ - <b>add:</b> lib/external/<b>newlib</b>/\*.h
  - <b>add:</b> lib/external/<b>newlib</b>/LICENSE
  - <b>add:</b> lib/external/<b>newlib</b>/Makefile
  - <b>update:</b> lib/external/Makefile

imagery/i.group/main.c

@@ -560,7 +560,7 @@ static void print_subgroups(const char *group, const char *mapset,
 /*!
  * \brief List files in a (sub)group (JSON)
  *
- * List map in map@mapset form.
+ * List map in map\@mapset form.
  *
  * \param ref group reference (set with I_get_group_ref())
  * \param root_array JSON array to which data will be appended.

include/Make/Doxyfile_arch_html.in

@@ -902,6 +902,7 @@ RECURSIVE              = YES
 # run.
 
 EXCLUDE                = bin.@ARCH@ \
+                         build \
                          db \
                          debian \
                          demolocation \
@@ -927,6 +928,7 @@ EXCLUDE                = bin.@ARCH@ \
                          man \
                          misc \
                          mswindows \
+                         out \
                          ps \
                          raster \
                          raster3d \

include/Make/Doxyfile_arch_latex.in

@@ -902,6 +902,7 @@ RECURSIVE              = YES
 # run.
 
 EXCLUDE                = bin.@ARCH@ \
+                         build \
                          db \
                          debian \
                          demolocation \
@@ -927,6 +928,7 @@ EXCLUDE                = bin.@ARCH@ \
                          man \
                          misc \
                          mswindows \
+                         out \
                          ps \
                          raster \
                          raster3d \

include/grass/dbmi.h

@@ -1,5 +1,5 @@
 /*!
-   \file include/dbmi.h
+   \file include/grass/dbmi.h
 
    \brief Main header of \ref dbmilib
 

include/grass/ogsf.h

@@ -1,5 +1,5 @@
 /*!
-   \file include/ogsf.h
+   \file include/grass/ogsf.h
 
    \brief OGSF header file (structures)
 

include/grass/vect/dig_defines.h

@@ -1,5 +1,5 @@
 /*!
-   \file include/vect/dig_defines.h
+   \file include/grass/vect/dig_defines.h
 
    Defines for diglib (part of vector library)
  */

include/grass/vect/dig_externs.h

@@ -4,7 +4,7 @@
 #define DIG___EXTERNS___
 
 /*!
-   \file include/vect/dig_externs.h
+   \file include/grass/vect/dig_externs.h
 
    \brief Function prototypes for diglib (part of vector library)
  */

include/grass/vect/dig_macros.h

@@ -1,5 +1,5 @@
 /*!
-   \file include/vect/dig_macros.h
+   \file include/grass/vect/dig_macros.h
 
    \brief Macros for diglib (part of vector library
  */

include/grass/vect/dig_structs.h

@@ -1,5 +1,5 @@
 /*!
-   \file include/vect/dig_structs.h
+   \file include/grass/vect/dig_structs.h
 
    \brief Data structures for \ref vectorlib
 

lib/datetime/type.c

@@ -26,6 +26,7 @@
  <li> return the return value from <tt>datetime_check_type</tt>(dt)
  </li></ul>
  *
+ *  \param dt
  *  \param mode
  *  \param from
  *  \param to

lib/db/dbmi_base/table.c

@@ -107,7 +107,7 @@ const char *db_get_table_name(dbTable *table)
    \brief Set the description of the table
 
    \param table pointer to dbTable
-   \param name description of the table
+   \param description description of the table
 
    \return DB_OK
  */

lib/db/dbmi_client/c_list_idx.c

@@ -21,7 +21,7 @@
    \param driver db driver
    \param table_name table name
    \param[out] list list of db indexes
-   \param[out] dbDriver number of items in the list
+   \param[out] count number of items in the list
 
    \return DB_OK on success
    \return DB_FAILED on failure

lib/db/dbmi_client/copy_tab.c

@@ -476,7 +476,7 @@ int db_copy_table_where(const char *from_drvname, const char *from_dbname,
 
    \param from_drvname name of driver from table is copied
    \param from_dbname name of database from table is copied
-   \param from_dbname name of table to be copied
+   \param from_tblname name of table to be copied
    \param to_drvname name of driver to - where table is copied to
    \param to_dbname name of database to - where table is copied to
    \param to_tblname name of copied table
@@ -503,9 +503,10 @@ int db_copy_table_select(const char *from_drvname, const char *from_dbname,
    \param to_drvname name of driver to - where table is copied to
    \param to_dbname name of database to - where table is copied to
    \param to_tblname name of copied table
-   \param selcol name of column used to select records by values in ivals or
-   NULL \param ivals pointer to array of integer values or NULL \param nvals
-   number of values in ivals
+   \param selcol name of column used to select records by values
+                 in ivals or NULL
+   \param ivals pointer to array of integer values or NULL
+   \param nvals number of values in ivals
 
    \return DB_OK on success
    \return DB_FAILED on failure

lib/display/r_raster.c

@@ -248,7 +248,7 @@ void D_encoding(const char *name)
   \brief Get font list
 
   \param[out] list list of font names
-  \param[out] number of items in the list
+  \param[out] count of items in the list
 */
 void D_font_list(char ***list, int *count)
 {
@@ -259,7 +259,7 @@ void D_font_list(char ***list, int *count)
   \brief Get font info
 
   \param[out] list list of font info
-  \param[out] number of items in the list
+  \param[out] count of items in the list
 */
 void D_font_info(char ***list, int *count)
 {

lib/display/raster2.c

@@ -52,16 +52,16 @@ int D_set_overlay_mode(int n)
     return 0;
 }
 
-/* this routine modifies the hardware colormap
- * provided that we are not using fixed mode colors.
- * For use by programs such as d.colors
- *
- * returns:
- *    0 error - in fixed mode,
- *              or cat not in min:max color range
- *    1 ok
+/*!
+ * \brief this routine modifies the hardware colormap provided that we are not
+ * using fixed mode colors.
+ *
+ * For use by programs such as d.colors.
+ *
+ * \param cat
+ * \param colors
+ * \return
  */
-
 int D_color(CELL cat, struct Colors *colors)
 {
     return D_c_color(cat, colors);
@@ -73,16 +73,14 @@ int D_c_color(CELL cat, struct Colors *colors)
     return D_color_of_type(&cat, colors, CELL_TYPE);
 }
 
-/* select color for line drawing */
-
 /*!
- * \brief
+ * \brief select color for line drawing
  *
  * Same functionality as <tt>D_color()</tt> except that the <em>value</em> is
  * type <tt>DCELL</tt>.  This implies that the floating-point interfaces to the
  * <em>colors</em> are used by this routine.
  *
- *  \param value
+ *  \param val Value
  *  \param colors
  *  \return int
  */
@@ -92,21 +90,18 @@ int D_d_color(DCELL val, struct Colors *colors)
     return D_color_of_type(&val, colors, DCELL_TYPE);
 }
 
-/* select color for line drawing */
-
 /*!
- * \brief
+ * \brief select color for line drawing
  *
  * Same
  * functionality as <tt>D_color()</tt> except that the <em>value</em> is type
  * <tt>FCELL</tt>. This implies that the floating-point interfaces to the
  * <em>colors</em> are used by this routine.
  *
- *  \param value
+ *  \param val
  *  \param colors
  *  \return int
  */
-
 int D_f_color(FCELL val, struct Colors *colors)
 {
     return D_color_of_type(&val, colors, FCELL_TYPE);
@@ -122,12 +117,11 @@ int D_f_color(FCELL val, struct Colors *colors)
  * If the <em>data_type</em> is DCELL_TYPE, calls D_d_color((DCELL *value,
  * colors);
  *
- *  \param value
+ *  \param raster
  *  \param colors
  *  \param data_type
  *  \return int
  */
-
 int D_color_of_type(const void *raster, struct Colors *colors,
                     RASTER_MAP_TYPE data_type)
 {

lib/display/setup.c

@@ -106,10 +106,10 @@ void D_setup_unity(int clear)
 
   \param clear non-zero code to clear the frame
   \param fit non-zero code to adjust destination coordinate system
-  \param s_top
-  \param s_bottom
-  \param s_left
-  \param s_right
+  \param st top
+  \param sb bottom
+  \param sl left
+  \param sr right
 */
 void D_setup2(int clear, int fit, double st, double sb, double sl, double sr)
 {

lib/display/tran_colr.c

@@ -97,9 +97,9 @@ static int translate_or_add_color(const char *str)
  * If the color is none and none_acceptable is not true exits with
  * a fatal error and message.
  *
- *  \param name_or_code
+ *  \param str Color name or color code, as a string
  *  \param none_acceptable
- *  \return int
+ *  \return int Returns a color number usable by D_use_color.
  */
 
 int D_parse_color(const char *str, int none_acceptable)
@@ -122,7 +122,7 @@ int D_parse_color(const char *str, int none_acceptable)
  * Returns 0 if color is not known. The color number returned is for lines and
  * text, not raster graphics.
  *
- *  \param name
+ *  \param str Color name as an ASCII string
  *  \return int
  */
 
@@ -171,12 +171,14 @@ int D_use_color(int color)
  * Returns 1 if color can be used to draw (is good and
  * isn't 'none'), 0 otherwise.
  *
- *  \param color_number
- *  \param red
- *  \param green
- *  \param blue
+ * \param color The color number provided by D_parse_color to convert
+ *              into 0-255 RGB values.
+ * \param r Pointer to an integer where the red component will be stored.
+ * \param g Pointer to an integer where the green component will be stored.
+ * \param b Pointer to an integer where the blue component will be stored.
  *
- *  \return int
+ * \return Returns 1 if color can be used to draw (is good and
+ *         isn't 'none'), 0 otherwise.
  */
 int D_color_number_to_RGB(int color, int *r, int *g, int *b)
 {

lib/gis/asprintf.c

@@ -91,7 +91,7 @@ int G_asprintf(char **out, const char *fmt, ...)
  * times in a loop.
  *
  * \param[out] out
- * \param[out] osize
+ * \param[out] size
  * \param[in] fmt
  * \param ap
  * \return number of bytes written

lib/gis/basename.c

@@ -67,7 +67,7 @@ size_t G_get_num_decimals(const char *str)
  * \brief Convert a double to a string substituting the dot with underscore
  *        12.3456 => '12_3456'
  *
- * \param number the double number that will be convert to string
+ * \param number the double number that will be converted to string
  * \param ndigits the number of integer digits in the output string
  * \param ndecimals the number of decimals in the output string
  *
@@ -154,9 +154,9 @@ char *G_join_basename_strings(const char **strings, size_t len)
  * \brief Generate the format string
  *
  * \param basename String with the basename
- * \param digits Number of digits number
- * \param decimals Number of decimal number
- * \param filler String used to fill, default is 0
+ * \param number The double number that will be converted to string
+ * \param ndigits The number of integer digits in the output string
+ * \param ndecimals The number of decimals in the output string
  *
  * \return Format string
  */

lib/gis/file_name.c

@@ -142,12 +142,13 @@ char *G_file_name_tmp(char *path, const char *element, const char *name,
 
    By default the GRASS temporary directory is located at
    $LOCATION/$MAPSET/.tmp/$HOSTNAME/. If basedir is provided, the
-   temporary directory is located at <basedir>/.tmp/$HOSTNAME/.
+   temporary directory is located at \<basedir\>/.tmp/$HOSTNAME/.
 
    \param[out] path buffer to hold resultant full path to file
    \param element database element (eg, "cell", "cellhd", "vector", etc)
    \param name name of file to build path to (fully qualified names allowed)
    \param mapset mapset name
+   \param basedir
 
    \return pointer to <i>path</i> buffer
  */

lib/gis/find_file.c

@@ -166,7 +166,7 @@ static const char *find_file1(int misc, const char *dir, const char *element,
  *
  * Returns the mapset name where the file was found.
  *
- * If the user specifies a fully qualified element (name@mapset)
+ * If the user specifies a fully qualified element (name\@mapset)
  * which exists, then G_find_file() modifies "name"
  * by removing the "@mapset" part.
  *

lib/gis/lrand48.c

@@ -47,7 +47,7 @@ static int seeded;
 /*!
  * \brief Seed the pseudo-random number generator
  *
- * \param seedval 32-bit integer used to seed the PRNG
+ * \param[in] seedval 32-bit integer used to seed the PRNG
  */
 
 void G_srand48(long seedval)