diff --git a/grasslib.dox b/grasslib.dox index 1dd0bce6a00..030044af744 100644 --- a/grasslib.dox +++ b/grasslib.dox @@ -136,8 +136,8 @@ href="https://grass.osgeo.org">https://grass.osgeo.org The following files must be added or updated when including a new external library. - add: lib/external/newlib - - add: lib/external/newlib/*.c - - add: lib/external/newlib/*.h + - add: lib/external/newlib/\*.c + - add: lib/external/newlib/\*.h - add: lib/external/newlib/LICENSE - add: lib/external/newlib/Makefile - update: lib/external/Makefile diff --git a/imagery/i.group/main.c b/imagery/i.group/main.c index d0d92e0c767..c7d79851c49 100644 --- a/imagery/i.group/main.c +++ b/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. diff --git a/include/Make/Doxyfile_arch_html.in b/include/Make/Doxyfile_arch_html.in index 0ca17d5ebc0..708ac630c67 100644 --- a/include/Make/Doxyfile_arch_html.in +++ b/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 \ diff --git a/include/Make/Doxyfile_arch_latex.in b/include/Make/Doxyfile_arch_latex.in index d5faa658ada..c707a1a10da 100644 --- a/include/Make/Doxyfile_arch_latex.in +++ b/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 \ diff --git a/include/grass/dbmi.h b/include/grass/dbmi.h index adac57a014e..e3f77adb86d 100644 --- a/include/grass/dbmi.h +++ b/include/grass/dbmi.h @@ -1,5 +1,5 @@ /*! - \file include/dbmi.h + \file include/grass/dbmi.h \brief Main header of \ref dbmilib diff --git a/include/grass/ogsf.h b/include/grass/ogsf.h index d02bf47f2cc..a13932554bf 100644 --- a/include/grass/ogsf.h +++ b/include/grass/ogsf.h @@ -1,5 +1,5 @@ /*! - \file include/ogsf.h + \file include/grass/ogsf.h \brief OGSF header file (structures) diff --git a/include/grass/vect/dig_defines.h b/include/grass/vect/dig_defines.h index aeb9c673edf..e00722fdb69 100644 --- a/include/grass/vect/dig_defines.h +++ b/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) */ diff --git a/include/grass/vect/dig_externs.h b/include/grass/vect/dig_externs.h index 9f7f2f74d5f..04895427c83 100644 --- a/include/grass/vect/dig_externs.h +++ b/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) */ diff --git a/include/grass/vect/dig_macros.h b/include/grass/vect/dig_macros.h index aebfcd600b3..e61dd695fc5 100644 --- a/include/grass/vect/dig_macros.h +++ b/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 */ diff --git a/include/grass/vect/dig_structs.h b/include/grass/vect/dig_structs.h index bfd69bc2701..966e36705c6 100644 --- a/include/grass/vect/dig_structs.h +++ b/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 diff --git a/lib/datetime/type.c b/lib/datetime/type.c index 4aad6fe8bed..2d55c2bfc6b 100644 --- a/lib/datetime/type.c +++ b/lib/datetime/type.c @@ -26,6 +26,7 @@
  • return the return value from datetime_check_type(dt)
    • * + * \param dt * \param mode * \param from * \param to diff --git a/lib/db/dbmi_base/table.c b/lib/db/dbmi_base/table.c index 31fef9811f8..8380425eeda 100644 --- a/lib/db/dbmi_base/table.c +++ b/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 */ diff --git a/lib/db/dbmi_client/c_list_idx.c b/lib/db/dbmi_client/c_list_idx.c index f1deacdc8ad..c14a28448c3 100644 --- a/lib/db/dbmi_client/c_list_idx.c +++ b/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 diff --git a/lib/db/dbmi_client/copy_tab.c b/lib/db/dbmi_client/copy_tab.c index 80842677c68..c41cef67eb6 100644 --- a/lib/db/dbmi_client/copy_tab.c +++ b/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 diff --git a/lib/display/r_raster.c b/lib/display/r_raster.c index 967b67323b3..46ca2e6fbff 100644 --- a/lib/display/r_raster.c +++ b/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) { diff --git a/lib/display/raster2.c b/lib/display/raster2.c index adf986adbbb..84d044d8352 100644 --- a/lib/display/raster2.c +++ b/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 D_color() except that the value is * type DCELL. This implies that the floating-point interfaces to the * colors 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 D_color() except that the value is type * FCELL. This implies that the floating-point interfaces to the * colors 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 data_type 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) { diff --git a/lib/display/setup.c b/lib/display/setup.c index cb51f5ab591..278a3a9f706 100644 --- a/lib/display/setup.c +++ b/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) { diff --git a/lib/display/tran_colr.c b/lib/display/tran_colr.c index 2c416abaecc..4074ce5ee5e 100644 --- a/lib/display/tran_colr.c +++ b/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) { diff --git a/lib/gis/asprintf.c b/lib/gis/asprintf.c index ea2e0c7f5d4..c571dbd94ac 100644 --- a/lib/gis/asprintf.c +++ 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 diff --git a/lib/gis/basename.c b/lib/gis/basename.c index cd9c37f6c22..3f83463f691 100644 --- a/lib/gis/basename.c +++ b/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 */ diff --git a/lib/gis/file_name.c b/lib/gis/file_name.c index 706b941be88..78f23567219 100644 --- a/lib/gis/file_name.c +++ b/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 /.tmp/$HOSTNAME/. + temporary directory is located at \/.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 path buffer */ diff --git a/lib/gis/find_file.c b/lib/gis/find_file.c index 9b6c6ba8528..2d57faa896d 100644 --- a/lib/gis/find_file.c +++ b/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. * diff --git a/lib/gis/lrand48.c b/lib/gis/lrand48.c index eea69a77fe0..082849e228d 100644 --- a/lib/gis/lrand48.c +++ b/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) diff --git a/lib/gis/lz4.h b/lib/gis/lz4.h index e2230ea4a54..ce25181307c 100644 --- a/lib/gis/lz4.h +++ b/lib/gis/lz4.h @@ -163,8 +163,8 @@ LZ4_versionString(void); /**< library version string; useful to check dll * Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> * 64KB; 20 -> 1MB) Increasing memory usage improves compression ratio, * generally at the cost of speed. Reduced memory usage may improve speed at the - * cost of ratio, thanks to better cache locality. Default value is 14, for - * 16KB, which nicely fits into most L1 caches. + * cost of ratio, thanks to better cache locality. + * Default value is 14, for 16KB, which nicely fits into most L1 caches. */ #ifndef LZ4_MEMORY_USAGE #define LZ4_MEMORY_USAGE LZ4_MEMORY_USAGE_DEFAULT @@ -187,41 +187,51 @@ LZ4_versionString(void); /**< library version string; useful to check dll * Simple Functions **************************************/ /*! LZ4_compress_default() : - * Compresses 'srcSize' bytes from buffer 'src' - * into already allocated 'dst' buffer of size 'dstCapacity'. - * Compression is guaranteed to succeed if 'dstCapacity' >= - * LZ4_compressBound(srcSize). It also runs faster, so it's a recommended - * setting. If the function cannot compress 'src' into a more limited 'dst' - * budget, compression stops *immediately*, and the function result is zero. In - * which case, 'dst' content is undefined (invalid). srcSize : max supported - * value is LZ4_MAX_INPUT_SIZE. dstCapacity : size of buffer 'dst' (which must - * be already allocated) - * @return : the number of bytes written into buffer 'dst' (necessarily <= - * dstCapacity) or 0 if compression fails Note : This function is protected - * against buffer overflow scenarios (never writes outside 'dst' buffer, nor - * read outside 'source' buffer). + * Compresses 'srcSize' bytes from buffer 'src' + * into already allocated 'dst' buffer of size 'dstCapacity'. + * Compression is guaranteed to succeed if 'dstCapacity' >= + * LZ4_compressBound(srcSize). + * It also runs faster, so it's a recommended setting. + * If the function cannot compress 'src' into a more limited 'dst' budget, + * compression stops *immediately*, and the function result is zero. + * In which case, 'dst' content is undefined (invalid). + * @param srcSize max supported value is LZ4_MAX_INPUT_SIZE. + * @param dstCapacity size of buffer 'dst' (which must be already allocated) + * @return the number of bytes written into buffer 'dst' (necessarily <= + * dstCapacity) or 0 if compression fails + * Note : This function is protected against buffer overflow scenarios (never + * writes outside 'dst' buffer, nor read outside 'source' buffer). */ LZ4LIB_API int LZ4_compress_default(const char *src, char *dst, int srcSize, int dstCapacity); /*! LZ4_decompress_safe() : - * @compressedSize : is the exact complete size of the compressed block. - * @dstCapacity : is the size of destination buffer (which must be already - * allocated), presumed an upper bound of decompressed size. - * @return : the number of bytes decompressed into destination buffer - * (necessarily <= dstCapacity) If destination buffer is not large enough, - * decoding will stop and output an error code (negative value). If the source - * stream is detected malformed, the function will stop decoding and return a - * negative result. Note 1 : This function is protected against malicious data - * packets : it will never writes outside 'dst' buffer, nor read outside - * 'source' buffer, even if the compressed block is maliciously modified to - * order the decoder to do these actions. In such case, the decoder stops - * immediately, and considers the compressed block malformed. Note 2 : - * compressedSize and dstCapacity must be provided to the function, the - * compressed block does not contain them. The implementation is free to send / - * store / derive this information in whichever way is most beneficial. If there - * is a need for a different format which bundles together both compressed data - * and its metadata, consider looking at lz4frame.h instead. + * @param src + * @param dst + * @param compressedSize is the exact complete size of the compressed block. + * @param dstCapacity is the size of destination buffer (which must be already + * allocated), presumed an upper bound of decompressed + * size. + * @return the number of bytes decompressed into destination buffer + * (necessarily <= dstCapacity) + * If destination buffer is not large enough, + * decoding will stop and output an error code (negative value). + * If the source stream is detected malformed, the function will stop + * decoding and return a negative result. + * + * Note 1 : This function is protected against malicious data packets : + * it will never write outside 'dst' buffer, nor read outside 'source' + * buffer, even if the compressed block is maliciously modified to + * order the decoder to do these actions. In such case, the decoder + * stops immediately, andconsiders the compressed block malformed. + * + * Note 2 : compressedSize and dstCapacity must be provided to the function, the + * compressed block does not contain them. + * The implementation is free to send / store / derive this information + * in whichever way is most beneficial. + * If there is a need for a different format which bundles together + * both compressed data and its metadata, consider looking at + * lz4frame.h instead. */ LZ4LIB_API int LZ4_decompress_safe(const char *src, char *dst, int compressedSize, int dstCapacity); @@ -236,27 +246,32 @@ LZ4LIB_API int LZ4_decompress_safe(const char *src, char *dst, : (isize) + ((isize) / 255) + 16) /*! LZ4_compressBound() : - Provides the maximum size that LZ4 compression may output in a "worst case" - scenario (input data not compressible) This function is primarily useful for - memory allocation purposes (destination buffer size). Macro - LZ4_COMPRESSBOUND() is also provided for compilation-time evaluation (stack - memory allocation for example). Note that LZ4_compress_default() compresses - faster when dstCapacity is >= LZ4_compressBound(srcSize) inputSize : max - supported value is LZ4_MAX_INPUT_SIZE return : maximum output size in a - "worst case" scenario or 0, if input size is incorrect (too large or - negative) + Provides the maximum size that LZ4 compression may output in a "worst case" + scenario (input data not compressible) + This function is primarily useful for memory allocation purposes (destination + buffer size). + Macro LZ4_COMPRESSBOUND() is also provided for compilation-time evaluation + (stack memory allocation for example). + Note that LZ4_compress_default() compresses faster when dstCapacity is >= + LZ4_compressBound(srcSize) + @param inputSize max supported value is LZ4_MAX_INPUT_SIZE + @return maximum output size in a "worst case" scenario or 0, if input size is + incorrect (too large or negative) */ LZ4LIB_API int LZ4_compressBound(int inputSize); /*! LZ4_compress_fast() : - Same as LZ4_compress_default(), but allows selection of "acceleration" - factor. The larger the acceleration value, the faster the algorithm, but also - the lesser the compression. It's a trade-off. It can be fine tuned, with each - successive value providing roughly +~3% to speed. An acceleration value of - "1" is the same as regular LZ4_compress_default() Values <= 0 will be - replaced by LZ4_ACCELERATION_DEFAULT (currently == 1, see lz4.c). Values > - LZ4_ACCELERATION_MAX will be replaced by LZ4_ACCELERATION_MAX (currently == - 65537, see lz4.c). + Same as LZ4_compress_default(), but allows selection of "acceleration" + factor. + The larger the acceleration value, the faster the algorithm, but also + the lesser the compression. + It's a trade-off. It can be fine tuned, with each successive value providing + roughly +~3% to speed. + An acceleration value of "1" is the same as regular LZ4_compress_default() + Values <= 0 will be replaced by LZ4_ACCELERATION_DEFAULT + (currently == 1, see lz4.c). + Values > LZ4_ACCELERATION_MAX will be replaced by LZ4_ACCELERATION_MAX + (currently == 65537, see lz4.c). */ LZ4LIB_API int LZ4_compress_fast(const char *src, char *dst, int srcSize, int dstCapacity, int acceleration); @@ -276,14 +291,15 @@ LZ4LIB_API int LZ4_compress_fast_extState(void *state, const char *src, * Reverse the logic : compresses as much data as possible from 'src' buffer * into already allocated buffer 'dst', of size >= 'dstCapacity'. * This function either compresses the entire 'src' content into 'dst' if it's - * large enough, or fill 'dst' buffer completely with as much data as possible - * from 'src'. note: acceleration parameter is fixed to "default". + * large enough, or fill 'dst' buffer completely with as much data as possible + * from 'src'. note: acceleration parameter is fixed to "default". * - * *srcSizePtr : in+out parameter. Initially contains size of input. - * Will be modified to indicate how many bytes where read from - * 'src' to fill 'dst'. New value is necessarily <= input value. - * @return : Nb bytes written into 'dst' (necessarily <= dstCapacity) - * or 0 if compression fails. + * @param[in,out] srcSizePtr Initially contains size of input. + * Will be modified to indicate how many bytes where + * read from 'src' to fill 'dst'. + * New value is necessarily <= input value. + * @return Nb bytes written into 'dst' (necessarily <= dstCapacity) + * or 0 if compression fails. * * Note : from v1.8.2 to v1.9.1, this function had a bug (fixed in v1.9.2+): * the produced compressed content could, in specific circumstances, @@ -300,39 +316,42 @@ LZ4LIB_API int LZ4_compress_destSize(const char *src, char *dst, int *srcSizePtr, int targetDstSize); /*! LZ4_decompress_safe_partial() : - * Decompress an LZ4 compressed block, of size 'srcSize' at position 'src', - * into destination buffer 'dst' of size 'dstCapacity'. - * Up to 'targetOutputSize' bytes will be decoded. - * The function stops decoding on reaching this objective. - * This can be useful to boost performance - * whenever only the beginning of a block is required. - * - * @return : the number of bytes decoded in `dst` (necessarily <= - * targetOutputSize) If source stream is detected malformed, function returns a - * negative result. + * Decompress an LZ4 compressed block, of size 'srcSize' at position 'src', + * into destination buffer 'dst' of size 'dstCapacity'. + * Up to 'targetOutputSize' bytes will be decoded. + * The function stops decoding on reaching this objective. + * This can be useful to boost performance + * whenever only the beginning of a block is required. + * + * @return the number of bytes decoded in `dst` (necessarily <= + * \p targetOutputSize) + * If source stream is detected malformed, function returns a negative + * result. * - * Note 1 : @return can be < targetOutputSize, if compressed block contains - * less data. + * Note 1 : @return can be < \p targetOutputSize, if compressed block contains + * less data. * - * Note 2 : targetOutputSize must be <= dstCapacity + * Note 2 : \p targetOutputSize must be <= \p dstCapacity * - * Note 3 : this function effectively stops decoding on reaching - * targetOutputSize, so dstCapacity is kind of redundant. This is because in - * older versions of this function, decoding operation would still write - * complete sequences. Therefore, there was no guarantee that it would stop - * writing at exactly targetOutputSize, it could write more bytes, though only - * up to dstCapacity. Some "margin" used to be required for this operation to - * work properly. Thankfully, this is no longer necessary. The function - * nonetheless keeps the same signature, in an effort to preserve API - * compatibility. + * Note 3 : this function effectively stops decoding on reaching + * \p targetOutputSize, so \p dstCapacity is kind of redundant. + * This is because in older versions of this function, decoding + * operation would still write complete sequences. + * Therefore, there was no guarantee that it would stop writing at + * exactly \p targetOutputSize, it could write more bytes, + * though only up to \p dstCapacity. Some "margin" used to be required + * for this operation to work properly. + * Thankfully, this is no longer necessary. + * The function nonetheless keeps the same signature, in an effort to + * preserve API compatibility. * - * Note 4 : If srcSize is the exact size of the block, - * then targetOutputSize can be any value, + * Note 4 : If \p srcSize is the exact size of the block, + * then \p targetOutputSize can be any value, * including larger than the block's decompressed size. * The function will, at most, generate block's decompressed size. * - * Note 5 : If srcSize is _larger_ than block's compressed size, - * then targetOutputSize **MUST** be <= block's decompressed size. + * Note 5 : If \p srcSize is _larger_ than block's compressed size, + * then \p targetOutputSize **MUST** be <= block's decompressed size. * Otherwise, *silent corruption will occur*. */ LZ4LIB_API int LZ4_decompress_safe_partial(const char *src, char *dst, @@ -393,28 +412,29 @@ LZ4LIB_API int LZ4_freeStream(LZ4_stream_t *streamPtr); LZ4LIB_API void LZ4_resetStream_fast(LZ4_stream_t *streamPtr); /*! LZ4_loadDict() : - * Use this function to reference a static dictionary into LZ4_stream_t. - * The dictionary must remain available during compression. - * LZ4_loadDict() triggers a reset, so any previous data will be forgotten. - * The same dictionary will have to be loaded on decompression side for + * Use this function to reference a static dictionary into LZ4_stream_t. + * The dictionary must remain available during compression. + * LZ4_loadDict() triggers a reset, so any previous data will be forgotten. + * The same dictionary will have to be loaded on decompression side for * successful decoding. Dictionary are useful for better compression of small * data (KB range). While LZ4 itself accepts any input as dictionary, dictionary * efficiency is also a topic. When in doubt, employ the Zstandard's Dictionary * Builder. Loading a size of 0 is allowed, and is the same as reset. - * @return : loaded dictionary size, in bytes (note: only the last 64 KB are - * loaded) + * + * @return loaded dictionary size, in bytes (note: only the last 64 KB are + * loaded) */ LZ4LIB_API int LZ4_loadDict(LZ4_stream_t *streamPtr, const char *dictionary, int dictSize); /*! LZ4_loadDictSlow() : v1.10.0+ - * Same as LZ4_loadDict(), - * but uses a bit more cpu to reference the dictionary content more thoroughly. - * This is expected to slightly improve compression ratio. - * The extra-cpu cost is likely worth it if the dictionary is re-used across + * Same as LZ4_loadDict(), + * but uses a bit more cpu to reference the dictionary content more thoroughly. + * This is expected to slightly improve compression ratio. + * The extra-cpu cost is likely worth it if the dictionary is re-used across * multiple sessions. - * @return : loaded dictionary size, in bytes (note: only the last 64 KB are - * loaded) + * @return loaded dictionary size, in bytes (note: only the last 64 KB are + * loaded) */ LZ4LIB_API int LZ4_loadDictSlow(LZ4_stream_t *streamPtr, const char *dictionary, int dictSize); @@ -426,13 +446,13 @@ LZ4LIB_API int LZ4_loadDictSlow(LZ4_stream_t *streamPtr, const char *dictionary, * Rather than re-loading the dictionary buffer into a working context before * each compression, or copying a pre-loaded dictionary's LZ4_stream_t into a * working LZ4_stream_t, this function introduces a no-copy setup mechanism, - * in which the working stream references @dictionaryStream in-place. + * in which the working stream references \p dictionaryStream in-place. * - * Several assumptions are made about the state of @dictionaryStream. + * Several assumptions are made about the state of \p dictionaryStream. * Currently, only states which have been prepared by LZ4_loadDict() or * LZ4_loadDictSlow() should be expected to work. * - * Alternatively, the provided @dictionaryStream may be NULL, + * Alternatively, the provided \p dictionaryStream may be NULL, * in which case any existing dictionary stream is unset. * * If a dictionary is provided, it replaces any pre-existing stream history. @@ -442,7 +462,7 @@ LZ4LIB_API int LZ4_loadDictSlow(LZ4_stream_t *streamPtr, const char *dictionary, * * The dictionary will only remain attached to the working stream through the * first compression call, at the end of which it is cleared. - * @dictionaryStream stream (and source buffer) must remain in-place / + * \p dictionaryStream stream (and source buffer) must remain in-place / * accessible / unchanged through the completion of the compression session. * * Note: there is no equivalent LZ4_attach_*() method on the decompression side @@ -455,33 +475,36 @@ LZ4LIB_API void LZ4_attach_dictionary(LZ4_stream_t *workingStream, const LZ4_stream_t *dictionaryStream); /*! LZ4_compress_fast_continue() : - * Compress 'src' content using data from previously compressed blocks, for + * Compress 'src' content using data from previously compressed blocks, for * better compression ratio. 'dst' buffer must be already allocated. If * dstCapacity >= LZ4_compressBound(srcSize), compression is guaranteed to * succeed, and runs faster. * - * @return : size of compressed block - * or 0 if there is an error (typically, cannot fit into 'dst'). + * @return size of compressed block + * or 0 if there is an error (typically, cannot fit into 'dst'). * - * Note 1 : Each invocation to LZ4_compress_fast_continue() generates a new - * block. Each block has precise boundaries. Each block must be decompressed - * separately, calling LZ4_decompress_*() with relevant metadata. It's not - * possible to append blocks together and expect a single invocation of - * LZ4_decompress_*() to decompress them together. + * Note 1 : Each invocation to LZ4_compress_fast_continue() generates a new + * block. + * Each block has precise boundaries. + * Each block must be decompressed separately, calling + * LZ4_decompress_*() with relevant metadata. + * It's not possible to append blocks together and expect a single + * invocation of LZ4_decompress_*() to decompress them together. * - * Note 2 : The previous 64KB of source data is __assumed__ to remain present, - * unmodified, at same address in memory ! + * Note 2 : The previous 64KB of source data is __assumed__ to remain present, + * unmodified, at same address in memory ! * - * Note 3 : When input is structured as a double-buffer, each buffer can have - * any size, including < 64 KB. Make sure that buffers are separated, by at - * least one byte. This construction ensures that each block only depends on - * previous block. + * Note 3 : When input is structured as a double-buffer, each buffer can have + * any size, including < 64 KB. + * Make sure that buffers are separated, by at least one byte. + * This construction ensures that each block only depends on previous + * block. * - * Note 4 : If input buffer is a ring-buffer, it can have any size, including < - * 64 KB. + * Note 4 : If input buffer is a ring-buffer, it can have any size, including < + * 64 KB. * - * Note 5 : After an error, the stream status is undefined (invalid), it can - * only be reset or freed. + * Note 5 : After an error, the stream status is undefined (invalid), it can + * only be reset or freed. */ LZ4LIB_API int LZ4_compress_fast_continue(LZ4_stream_t *streamPtr, const char *src, char *dst, @@ -489,12 +512,12 @@ LZ4LIB_API int LZ4_compress_fast_continue(LZ4_stream_t *streamPtr, int acceleration); /*! LZ4_saveDict() : - * If last 64KB data cannot be guaranteed to remain available at its current - * memory location, save it into a safer place (char* safeBuffer). This is - * schematically equivalent to a memcpy() followed by LZ4_loadDict(), but is - * much faster, because LZ4_saveDict() doesn't need to rebuild tables. - * @return : saved dictionary size in bytes (necessarily <= maxDictSize), or 0 - * if error. + * If last 64KB data cannot be guaranteed to remain available at its current + * memory location, save it into a safer place (char* safeBuffer). + * This is schematically equivalent to a memcpy() followed by LZ4_loadDict(), + * but is much faster, because LZ4_saveDict() doesn't need to rebuild tables. + * @return saved dictionary size in bytes (necessarily <= maxDictSize), or 0 + * if error. */ LZ4LIB_API int LZ4_saveDict(LZ4_stream_t *streamPtr, char *safeBuffer, int maxDictSize); @@ -519,24 +542,24 @@ LZ4LIB_API int LZ4_freeStreamDecode(LZ4_streamDecode_t *LZ4_stream); #endif /*! LZ4_setStreamDecode() : - * An LZ4_streamDecode_t context can be allocated once and re-used multiple - * times. Use this function to start decompression of a new stream of blocks. A - * dictionary can optionally be set. Use NULL or size 0 for a reset order. - * Dictionary is presumed stable : it must remain accessible and unmodified + * An LZ4_streamDecode_t context can be allocated once and re-used multiple + * times. Use this function to start decompression of a new stream of blocks. + * A dictionary can optionally be set. Use NULL or size 0 for a reset order. + * Dictionary is presumed stable : it must remain accessible and unmodified * during next decompression. - * @return : 1 if OK, 0 if error + * @return 1 if OK, 0 if error */ LZ4LIB_API int LZ4_setStreamDecode(LZ4_streamDecode_t *LZ4_streamDecode, const char *dictionary, int dictSize); /*! LZ4_decoderRingBufferSize() : v1.8.2+ - * Note : in a ring buffer scenario (optional), - * blocks are presumed decompressed next to each other - * up to the moment there is not enough remaining space for next block - * (remainingSize < maxBlockSize), at which stage it resumes from beginning of - * ring buffer. When setting such a ring buffer for streaming decompression, - * provides the minimum size of this ring buffer - * to be compatible with any source respecting maxBlockSize condition. + * Note : in a ring buffer scenario (optional), + * blocks are presumed decompressed next to each other + * up to the moment there is not enough remaining space for next block + * (remainingSize < maxBlockSize), at which stage it resumes from + * beginning of ring buffer. When setting such a ring buffer for + * streaming decompression, provides the minimum size of this ring buffer + * to be compatible with any source respecting maxBlockSize condition. * @return : minimum ring buffer size, * or 0 if there is an error (invalid maxBlockSize). */ @@ -553,15 +576,16 @@ LZ4LIB_API int LZ4_decoderRingBufferSize(int maxBlockSize); * decompression function. LZ4_decompress_safe_continue() only accepts one block * at a time. It's modeled after `LZ4_decompress_safe()` and behaves similarly. * - * @LZ4_streamDecode : decompression state, tracking the position in memory of - * past data - * @compressedSize : exact complete size of one compressed block. - * @dstCapacity : size of destination buffer (which must be already allocated), - * must be an upper bound of decompressed size. - * @return : number of bytes decompressed into destination buffer (necessarily - * <= dstCapacity) If destination buffer is not large enough, decoding will stop - * and output an error code (negative value). If the source stream is detected - * malformed, the function will stop decoding and return a negative result. + * @param LZ4_streamDecode decompression state, tracking the position in + * memory of past data + * @param compressedSize exact complete size of one compressed block. + * @param dstCapacity size of destination buffer (which must be already + * allocated), must be an upper bound of decompressed size. + * @return number of bytes decompressed into destination buffer (necessarily + * <= \p dstCapacity) If destination buffer is not large enough, + * decoding will stop and output an error code (negative value). If the source + * stream is detected malformed, the function will stop decoding and return a + * negative result. * * The last 64KB of previously decoded data *must* remain available and * unmodified at the memory position where they were previously decoded. If less @@ -599,11 +623,12 @@ LZ4_decompress_safe_continue(LZ4_streamDecode_t *LZ4_streamDecode, /*! LZ4_decompress_safe_usingDict() : * Works the same as * a combination of LZ4_setStreamDecode() followed by - * LZ4_decompress_safe_continue() However, it's stateless: it doesn't need any - * LZ4_streamDecode_t state. Dictionary is presumed stable : it must remain - * accessible and unmodified during decompression. Performance tip : - * Decompression speed can be substantially increased when dst == dictStart + - * dictSize. + * LZ4_decompress_safe_continue() + * However, it's stateless: it doesn't need any LZ4_streamDecode_t state. + * Dictionary is presumed stable : it must remain accessible and unmodified + * during decompression. + * Performance tip : Decompression speed can be substantially increased + * when dst == dictStart + dictSize. */ LZ4LIB_API int LZ4_decompress_safe_usingDict(const char *src, char *dst, int srcSize, int dstCapacity, @@ -828,9 +853,9 @@ union LZ4_stream_u { * and will @return a pointer of proper type upon initialization. * * Note : initialization fails if size and alignment conditions are not - *respected. In which case, the function will @return NULL. Note2: An - *LZ4_stream_t structure guarantees correct alignment and size. Note3: Before - *v1.9.0, use LZ4_resetStream() instead + * respected. In which case, the function will @return NULL. + * Note2: An LZ4_stream_t structure guarantees correct alignment and size. + * Note3: Before v1.9.0, use LZ4_resetStream() instead **/ LZ4LIB_API LZ4_stream_t *LZ4_initStream(void *stateBuffer, size_t size); @@ -951,31 +976,36 @@ LZ4LIB_API int LZ4_decompress_fast_withPrefix64k(const char *src, char *dst, * but this is no longer the case. They are now slower. * This is because LZ4_decompress_fast() doesn't know the input size, * and therefore must progress more cautiously into the input buffer to not - * read beyond the end of block. On top of that `LZ4_decompress_fast()` is not - * protected vs malformed or malicious inputs, making it a security liability. + * read beyond the end of block. On top of that `LZ4_decompress_fast()` is not + * protected vs malformed or malicious inputs, making it a security liability. * As a consequence, LZ4_decompress_fast() is strongly discouraged, and - * deprecated. + * deprecated. * * The last remaining LZ4_decompress_fast() specificity is that * it can decompress a block without knowing its compressed size. * Such functionality can be achieved in a more secure manner * by employing LZ4_decompress_safe_partial(). * - * Parameters: - * originalSize : is the uncompressed size to regenerate. - * `dst` must be already allocated, its size must be >= - * 'originalSize' bytes. - * @return : number of bytes read from source buffer (== compressed size). - * The function expects to finish at block's end exactly. - * If the source stream is detected malformed, the function stops - * decoding and returns a negative result. note : LZ4_decompress_fast*() - * requires originalSize. Thanks to this information, it never writes past the - * output buffer. However, since it doesn't know its 'src' size, it may read an - * unknown amount of input, past input buffer bounds. Also, since match offsets - * are not validated, match reads from 'src' may underflow too. These issues - * never happen if input (compressed) data is correct. But they may happen if - * input data is invalid (error or intentional tampering). As a consequence, use - * these functions in trusted environments with trusted data **only**. + * Parameters: + * @param originalSize is the uncompressed size to regenerate. + * `dst` must be already allocated, its size must be >= + * 'originalSize' bytes. + * @return number of bytes read from source buffer (== compressed size). + * The function expects to finish at block's end exactly. + * If the source stream is detected malformed, the function stops + * decoding and returns a negative result. + * + * note : LZ4_decompress_fast*() requires originalSize. + * Thanks to this information, it never writes past the output buffer. + * However, since it doesn't know its 'src' size, it may read an unknown + * amount of input, past input buffer bounds. + * Also, since match offsets are not validated, match reads from 'src' + * may underflow too. + * These issues never happen if input (compressed) data is correct. + * But they may happen if input data is invalid (error or intentional + * tampering). + * As a consequence, use these functions in trusted environments with + * trusted data **only**. */ LZ4_DEPRECATED("This function is deprecated and unsafe. Consider using " "LZ4_decompress_safe_partial() instead") diff --git a/lib/gis/nme_in_mps.c b/lib/gis/nme_in_mps.c index a05e815bf83..5770340a25f 100644 --- a/lib/gis/nme_in_mps.c +++ b/lib/gis/nme_in_mps.c @@ -19,7 +19,7 @@ Returns a fully qualified name for the file name in mapset. Currently this string is in the form - name@mapset, but the programmer should pretend not to know this + name\@mapset, but the programmer should pretend not to know this and always call this routine to get the fully qualified name. Note: @@ -69,7 +69,7 @@ int G_name_is_fully_qualified(const char *fullname, char *name, char *mapset) Returns a fully qualified name for GIS element name in mapset. Currently this string is in the form - name@mapset, but the programmer should pretend not to know + name\@mapset, but the programmer should pretend not to know this and always call this routine to get the fully qualified name. String is allocated by G_store(). @@ -96,7 +96,7 @@ int G_name_is_fully_qualified(const char *fullname, char *name, char *mapset) \param name element name \param mapset mapset name - \return pointer to full element name (map@mapset) + \return pointer to full element name (map\@mapset) */ char *G_fully_qualified_name(const char *name, const char *mapset) { diff --git a/lib/gis/open_misc.c b/lib/gis/open_misc.c index b6f1b74e746..45ba82ad167 100644 --- a/lib/gis/open_misc.c +++ b/lib/gis/open_misc.c @@ -103,6 +103,7 @@ static int G__open_misc(const char *dir, const char *element, const char *name, * exist, -1 is returned. Otherwise the file is positioned at the end of the * file and the file descriptor from the open( ) is returned. * + * \param dir * \param element * \param name * \return int @@ -123,6 +124,7 @@ int G_open_new_misc(const char *dir, const char *element, const char *name) * exist, -1 is returned. Otherwise the file descriptor from the open( ) is * returned. * + * \param dir * \param element * \param name * \param mapset @@ -144,6 +146,7 @@ int G_open_old_misc(const char *dir, const char *element, const char *name, * exist, -1 is returned. Otherwise the file is positioned at the end of the * file and the file descriptor from the open( ) is returned. * + * \param dir * \param element * \param name * \return int @@ -170,6 +173,7 @@ int G_open_update_misc(const char *dir, const char *element, const char *name) * positioned at the end of the file and the file descriptor from the fopen( ) * is returned. * + * \param dir * \param element * \param name * \return FILE * diff --git a/lib/gis/parser.c b/lib/gis/parser.c index 20fbc088290..cd41a9dd7d9 100644 --- a/lib/gis/parser.c +++ b/lib/gis/parser.c @@ -1957,7 +1957,7 @@ FILE *G_open_option_file(const struct Option *option) \brief Close an input/output file returned by G_open_option_file(). If the file pointer is stdin, stdout, or stderr, nothing happens. - \param file pointer + \param fp file pointer */ void G_close_option_file(FILE *fp) { diff --git a/lib/gis/paths.c b/lib/gis/paths.c index 047b8d960e9..c9727ec5db5 100644 --- a/lib/gis/paths.c +++ b/lib/gis/paths.c @@ -120,7 +120,7 @@ char *G_convert_dirseps_from_host(char *path) * Returns information about the specified file. * * \param file_name file name - * \param stat pointer to structure filled with file information + * \param buf pointer to structure filled with file information * * \return Return value from system lstat function **/ @@ -137,7 +137,7 @@ int G_stat(const char *file_name, struct stat *buf) * * \param file_name file name, in the case of a symbolic link, the * link itself is stat-ed, not the file that it refers to - * \param stat pointer to structure filled with file information + * \param buf pointer to structure filled with file information * * \return Return value from system lstat function **/ diff --git a/lib/gis/rd_cellhd.c b/lib/gis/rd_cellhd.c index 725547cd867..67546c84d79 100644 --- a/lib/gis/rd_cellhd.c +++ b/lib/gis/rd_cellhd.c @@ -50,7 +50,7 @@ static double scan_double(const char *, double *); /*! \brief Read cell header (for internal use only) - \param fp file descriptor + \param fd file descriptor \param[out] cellhd pointer to Cell_head structure */ void G__read_Cell_head(FILE *fd, struct Cell_head *cellhd) diff --git a/lib/gis/tempfile.c b/lib/gis/tempfile.c index 9c79423299b..808b1893a79 100644 --- a/lib/gis/tempfile.c +++ b/lib/gis/tempfile.c @@ -115,6 +115,7 @@ char *G_tempfile_pid(int pid) * See G_tempfile_basedir(). * * \param pid + * \param basedir * \return pointer to string path */ char *G_tempfile_pid_basedir(int pid, const char *basedir) @@ -154,7 +155,7 @@ void G_temp_element(char *element) * * \param[out] element element name * \param tmp TRUE to use G_make_mapset_element_tmp() instead of - * G_make_mapset_element() + * G_make_mapset_element() */ void G__temp_element(char *element, int tmp) { @@ -179,8 +180,7 @@ void G__temp_element(char *element, int tmp) * \brief Populates element with a path string (internal use only!) * * \param[out] element element name - * \param tmp TRUE to use G_make_mapset_element_tmp() instead of - * G_make_mapset_element() + * \param basedir */ void G__temp_element_basedir(char *element, const char *basedir) { diff --git a/lib/gis/wind_format.c b/lib/gis/wind_format.c index b81c8a6efaa..458fd291b61 100644 --- a/lib/gis/wind_format.c +++ b/lib/gis/wind_format.c @@ -62,7 +62,7 @@ void G_format_easting(double east, char *buf, int projection) * Converts the double representation of the resolution to its * ASCII representation (into buf). * - * \param resolution resolution value + * \param res resolution value * \param[out] buf buffer to hold formatted string * \param projection projection code, or -1 to force full precision FP */ diff --git a/lib/gis/wind_scan.c b/lib/gis/wind_scan.c index 75046647ace..2936cee6896 100644 --- a/lib/gis/wind_scan.c +++ b/lib/gis/wind_scan.c @@ -91,7 +91,7 @@ int G_scan_easting(const char *buf, double *easting, int projection) - PROJECTION_OTHER \param buf buffer containing string resolution - \param[out] resolution resolution value + \param[out] res resolution value \param projection projection code \return 0 on error diff --git a/lib/gmath/fft.c b/lib/gmath/fft.c index 3615fb602b2..d4d6c1fc0ed 100644 --- a/lib/gmath/fft.c +++ b/lib/gmath/fft.c @@ -49,13 +49,13 @@ * \brief Fast Fourier Transform for two-dimensional array. * * Fast Fourier Transform for two-dimensional array.
    - * If passing real data to fft() forward transform + * Note: If passing real data to fft() forward transform * (especially when using fft() in a loop), explicitly (re-)initialize * the imaginary part to zero (DATA[1][i] = 0.0). Returns 0. * * \param[in] i_sign Direction of transform -1 is normal, +1 is inverse * \param[in,out] data Pointer to complex linear array in row major order - * containing data and result + * containing data and result * \param[in] NN Value of DATA dimension (dimc * dimr) * \param[in] dimc Value of image column dimension (max power of 2) * \param[in] dimr Value of image row dimension (max power of 2) @@ -106,13 +106,13 @@ int fft2(int i_sign, double (*data)[2], int NN, int dimc, int dimr) * \brief Fast Fourier Transform for two-dimensional array. * * Fast Fourier Transform for two-dimensional array.
    - * If passing real data to fft() forward transform + * Note: If passing real data to fft() forward transform * (especially when using fft() in a loop), explicitly (re-)initialize * the imaginary part to zero (DATA[1][i] = 0.0). Returns 0. * * \param[in] i_sign Direction of transform -1 is normal, +1 is inverse * \param[in,out] DATA Pointer to complex linear array in row major order - * containing data and result + * containing data and result * \param[in] NN Value of DATA dimension (dimc * dimr) * \param[in] dimc Value of image column dimension (max power of 2) * \param[in] dimr Value of image row dimension (max power of 2) diff --git a/lib/gmath/la.c b/lib/gmath/la.c index f103e1c83dc..a2ff57760c2 100644 --- a/lib/gmath/la.c +++ b/lib/gmath/la.c @@ -1309,6 +1309,7 @@ double G_vector_norm1(vec_struct *vc) * * \param v1 * \param v2 + * \param out Output vector * \return vec_struct */ @@ -1568,7 +1569,7 @@ mat_struct *G_matrix_resize(mat_struct *in, int rows, int cols) } /*! - * \fn int G_matrix_read_stdin (mat_struct *out) + * \fn int G_matrix_stdin(mat_struct *out) * * \brief Read a matrix from standard input * diff --git a/lib/gmath/rand1.c b/lib/gmath/rand1.c index 93e34a7be4e..7e3782f9845 100644 --- a/lib/gmath/rand1.c +++ b/lib/gmath/rand1.c @@ -21,7 +21,7 @@ float G_math_rand(void) /*! * \brief Seed the pseudo-random number generator * - * \param seedval 32-bit integer used to seed the PRNG + * \param[in] seed 32-bit integer used to seed the PRNG */ void G_math_srand(int seed) diff --git a/lib/imagery/find.c b/lib/imagery/find.c index ce801c1b273..8c527a84b2e 100644 --- a/lib/imagery/find.c +++ b/lib/imagery/find.c @@ -63,6 +63,7 @@ int I_find_group_file(const char *group, const char *file) * \brief Searches for a group file in the specified mapset * * \param group + * \param mapset * \param file * \return int 1 if file was found, 0 otherwise */ diff --git a/lib/imagery/list_gp.c b/lib/imagery/list_gp.c index 60289a1925d..a915e0e8a11 100644 --- a/lib/imagery/list_gp.c +++ b/lib/imagery/list_gp.c @@ -64,7 +64,7 @@ int I_list_group(const char *group, const struct Ref *ref, FILE *fd) * \brief Prints maps in a group (simple version) * * Same as I_list_group(), but without all the fancy stuff. - * Prints one map per line in map@mapset form. + * Prints one map per line in map\@mapset form. * * \param ref group reference (set with I_get_group_ref()) * \param fd where to print (typically stdout) diff --git a/lib/imagery/manage_signatures.c b/lib/imagery/manage_signatures.c index 51f2b67a24f..79697381e85 100644 --- a/lib/imagery/manage_signatures.c +++ b/lib/imagery/manage_signatures.c @@ -1,5 +1,5 @@ /*! - \file lib/imagery/manage_sinatures.c + \file lib/imagery/manage_signatures.c \brief Imagery Library - Signature file management functions @@ -105,9 +105,9 @@ int I_signatures_remove(I_SIGFILE_TYPE type, const char *name) * It is safe to pass fully qualified names. * * \param type I_SIGFILE_TYPE signature type - * \param name of old signature - * \param mapset of old signature - * \param name of new signature + * \param old_name of old signature + * \param old_mapset of old signature + * \param new_name of new signature * \return 0 on success * \return 1 on failure */ diff --git a/lib/imagery/sig.c b/lib/imagery/sig.c index a37d50d2cb8..f2784377e9b 100644 --- a/lib/imagery/sig.c +++ b/lib/imagery/sig.c @@ -237,8 +237,8 @@ int I_read_signatures(FILE *fd, struct Signature *S) * I_fopen_signature_file_new() * It is up to caller to fclose the file stream afterwards. * - * \param pointer to FILE* - * \param pointer to struct Signature *S + * \param fd to FILE* + * \param S to struct Signature *S * * \return always 1 */ @@ -314,8 +314,8 @@ int I_write_signatures(FILE *fd, struct Signature *S) * \code if (ret && ret[1]) printf("List of imagery group bands without * signatures: %s\n, ret[1]); \endcode * - * \param *Signature existing signatures to check & sort - * \param *Ref group reference + * \param S existing signatures to check & sort + * \param R group reference * * \return NULL successfully sorted * \return err_array two comma separated lists of mismatches diff --git a/lib/imagery/sigset.c b/lib/imagery/sigset.c index 4a8a3c9b963..0ef306f3e1e 100644 --- a/lib/imagery/sigset.c +++ b/lib/imagery/sigset.c @@ -133,8 +133,8 @@ struct SubSig *I_NewSubSig(struct SigSet *S, struct ClassSig *C) * There is no need to initialise struct SigSet in advance, as this * function internally calls I_InitSigSet. * - * \param pointer to FILE* - * \param pointer to struct SigSet *S + * \param fd pointer to FILE* + * \param S pointer to struct SigSet *S * * \return 1 on success, -1 on failure */ diff --git a/lib/nviz/cplanes_obj.c b/lib/nviz/cplanes_obj.c index ffd6f68b6a9..a01fe3519a5 100644 --- a/lib/nviz/cplanes_obj.c +++ b/lib/nviz/cplanes_obj.c @@ -26,7 +26,7 @@ static geoview Gv; the user decide on the id for each. \param data nviz data - \param id + \param id cplane id */ int Nviz_new_cplane(nv_data *data, int id) { @@ -43,7 +43,7 @@ int Nviz_new_cplane(nv_data *data, int id) \brief Turn on (make current) the given clip plane. \param data nviz data - \param cplane id + \param id cplane id */ int Nviz_on_cplane(nv_data *data, int id) { @@ -58,7 +58,7 @@ int Nviz_on_cplane(nv_data *data, int id) \brief Turn off (make inactive) the given clip plane \param data nviz data - \param cplane id + \param id cplane id */ int Nviz_off_cplane(nv_data *data, int id) { diff --git a/lib/ogsf/gp.c b/lib/ogsf/gp.c index cae4c0e0dc4..53f05d1ef16 100644 --- a/lib/ogsf/gp.c +++ b/lib/ogsf/gp.c @@ -349,8 +349,8 @@ void gp_free_sitemem(geosite *fp) \brief Set drape surfaces \param gp pointer to geosite struct - \param hsurf list of surfaces (id) - \param nsurf number of surfaces + \param hsurfs list of surfaces (id) + \param nsurfs number of surfaces */ void gp_set_drapesurfs(geosite *gp, int hsurfs[], int nsurfs) { diff --git a/lib/ogsf/gs.c b/lib/ogsf/gs.c index f3ba0a44044..568773aa992 100644 --- a/lib/ogsf/gs.c +++ b/lib/ogsf/gs.c @@ -350,7 +350,7 @@ void print_frto(float (*ft)[4]) \todo G_debug ? - \param ft pointer to coordinates + \param rt pointer to coordinates */ void print_realto(float *rt) { @@ -364,7 +364,7 @@ void print_realto(float *rt) \todo G_debug ? - \param ft pointer to buffer + \param buff pointer to buffer */ void print_256lookup(int *buff) { diff --git a/lib/ogsf/gs2.c b/lib/ogsf/gs2.c index 71af2c9c2df..f1ed6e0b69f 100644 --- a/lib/ogsf/gs2.c +++ b/lib/ogsf/gs2.c @@ -494,7 +494,7 @@ int GS_transp_is_set(void) /*! \brief Retrieves coordinates for lighting model position, at center of view - \param pos[out] coordinates + \param[out] pos coordinates */ void GS_get_modelposition1(float pos[]) { @@ -522,8 +522,8 @@ void GS_get_modelposition1(float pos[]) know position to calculate size, have two dependent variables (nearclip * 2) from eye. - \param siz[out] size - \param pos[out] coordinates (X, Y, Z) + \param[out] siz size + \param[out] pos coordinates (X, Y, Z) */ void GS_get_modelposition(float *siz, float *pos) { @@ -707,6 +707,8 @@ void GS_draw_line_onsurf(int id, float x1, float y1, float x2, float y2) \param id surface id \param x1,y1,x2,y2 line nodes + \param lasp + \param n \return number of points used */ @@ -1522,7 +1524,7 @@ int GS_num_surfs(void) Must be freed when not needed! - \param[out] numsurf number of available surfaces + \param[out] numsurfs number of available surfaces \return pointer to surface array \return NULL on error diff --git a/lib/ogsf/gsd_objs.c b/lib/ogsf/gsd_objs.c index f0373f4adc2..235eda957ef 100644 --- a/lib/ogsf/gsd_objs.c +++ b/lib/ogsf/gsd_objs.c @@ -300,7 +300,7 @@ void gsd_x(geosurf *gs, float *center, int colr, float siz) \param center center point \param colr color value - \param size size value + \param siz size value */ void gsd_diamond(float *center, unsigned long colr, float siz) { @@ -1127,6 +1127,7 @@ void gsd_3darrow(float *center, unsigned long colr, float siz1, float siz2, Adapted from gsd_north_arrow Hamish Bowman Dec 2006 \param pos2 + \param len \param fontbase font-base \param bar_clr barscale color \param text_clr text color @@ -1212,7 +1213,8 @@ int gsd_scalebar(float *pos2, float len, GLuint fontbase, unsigned long bar_clr, Adapted from gsd_scalebar A.Kratochvilova 2011 - \param pos2 scalebar position + \param pos scalebar position + \param len \param fontbase font-base (unused) \param bar_clr barscale color \param text_clr text color (unused) diff --git a/lib/ogsf/gsd_views.c b/lib/ogsf/gsd_views.c index a30c1835b69..f3913133cab 100644 --- a/lib/ogsf/gsd_views.c +++ b/lib/ogsf/gsd_views.c @@ -141,7 +141,7 @@ void gsd_set_view(geoview * gv, geodisplay * gd) Establishes viewing & projection matrices \param gv view (geoview) - \param dp display (geodisplay) + \param gd display (geodisplay) */ void gsd_set_view(geoview *gv, geodisplay *gd) { @@ -368,7 +368,7 @@ void gsd_do_scale(int doexag) /*! \brief Convert real to model coordinates - \param point[in,out] 3d point (Point3) + \param[in,out] point 3d point (Point3) */ void gsd_real2model(Point3 point) { @@ -388,7 +388,7 @@ void gsd_real2model(Point3 point) /*! \brief Convert model to real coordinates - \param point[in,out] 3d point (x,y,z) + \param[in,out] point 3d point (x,y,z) */ void gsd_model2real(Point3 point) { diff --git a/lib/ogsf/gsdrape.c b/lib/ogsf/gsdrape.c index 7cae5abd34b..ccb6e985c06 100644 --- a/lib/ogsf/gsdrape.c +++ b/lib/ogsf/gsdrape.c @@ -684,6 +684,7 @@ int viewcell_tri_interp(geosurf *gs, typbuff *buf, Point3 pt, int check_mask) \brief ADD \param gs surface (geosurf) + \param pt \return 1 \return 0 diff --git a/lib/proj/convert.c b/lib/proj/convert.c index 43edf512c10..b293706a745 100644 --- a/lib/proj/convert.c +++ b/lib/proj/convert.c @@ -405,13 +405,17 @@ OGRSpatialReferenceH GPJ_grass_to_osr2(const struct Key_Value *proj_info, * * \param cellhd Pointer to a GRASS Cell_head structure that will have its * projection-related members populated with appropriate - * values \param projinfo Pointer to a pointer which will have a GRASS - * Key_Value structure allocated containing a set of GRASS PROJ_INFO values - * \param projunits Pointer to a pointer which will have a GRASS Key_Value + * values + * \param projinfo Pointer to a pointer which will have a GRASS + * Key_Value structure allocated containing a set of GRASS + * PROJ_INFO values + * \param projunits Pointer to a pointer which will have a GRASS Key_Value * structure allocated containing a set of GRASS PROJ_UNITS - * values \param hSRS OGRSpatialReferenceH object containing the - * co-ordinate system to be converted \param datumtrans Index number of datum - * parameter set to use, 0 to leave unspecified + * values. + * \param hSRS1 OGRSpatialReferenceH object containing the + * co-ordinate system to be converted + * \param datumtrans Index number of datum parameter set to use, 0 to leave + * unspecified * * \return 2 if a projected or lat/long co-ordinate system has been * defined diff --git a/lib/raster/mask_info.c b/lib/raster/mask_info.c index 55559a52f10..2feb920942e 100644 --- a/lib/raster/mask_info.c +++ b/lib/raster/mask_info.c @@ -66,7 +66,7 @@ char *Rast_mask_info(void) * This function checks if an environment variable "GRASS_MASK" is set. * If it is set, the value of the environment variable is returned * as the mask name. If it is not set, the function will default to the - * mask name "MASK@", where is the current mapset. + * mask name "MASK@", where \ is the current mapset. * * The memory for the returned mask name is dynamically allocated using * G_store(). It is the caller's responsibility to free the memory with diff --git a/lib/raster3d/headerinfo.c b/lib/raster3d/headerinfo.c index 4154b6a3ecc..60580dcc012 100644 --- a/lib/raster3d/headerinfo.c +++ b/lib/raster3d/headerinfo.c @@ -183,7 +183,7 @@ void Rast3d_set_unit(RASTER3D_Map *map, const char *unit) * set Vertical unit from integer value defined in gis.h (U_METERS, ...) * * \param map - * \param unit + * \param vertical_unit * \return void */ @@ -200,7 +200,7 @@ void Rast3d_set_vertical_unit2(RASTER3D_Map *map, int vertical_unit) * set Vertical unit from string * * \param map - * \param unit + * \param vertical_unit * \return void */ diff --git a/lib/raster3d/mask.c b/lib/raster3d/mask.c index 69e7a498774..ce8a1fa6212 100644 --- a/lib/raster3d/mask.c +++ b/lib/raster3d/mask.c @@ -213,6 +213,7 @@ void Rast3d_mask_num(RASTER3D_Map *map, int x, int y, int z, void *value, * * Same as Rast3d_mask_num (x, y, z, value, FCELL_TYPE). * + * \param map * \param x * \param y * \param z diff --git a/lib/raster3d/open.c b/lib/raster3d/open.c index 96552236f81..b62ae6b4694 100644 --- a/lib/raster3d/open.c +++ b/lib/raster3d/open.c @@ -72,7 +72,7 @@ void *Rast3d_open_cell_old_no_header(const char *name, const char *mapset) * \param name * \param mapset * \param window - * \param type + * \param typeIntern * \param cache * \return void * */ @@ -200,7 +200,7 @@ void *Rast3d_open_cell_old(const char *name, const char *mapset, * structure ... if successful, NULL ... otherwise. * * \param name - * \param type + * \param typeIntern * \param cache * \param region * \return void * diff --git a/lib/raster3d/open2.c b/lib/raster3d/open2.c index 840c8017c28..7c7f1b77a87 100644 --- a/lib/raster3d/open2.c +++ b/lib/raster3d/open2.c @@ -31,9 +31,11 @@ * \param doLzw Use the LZW compression algorithm * \param doRle Use the Run-Length-Encoding algroithm for compression * \param precision The precision used for the mantissa (0 - 52) or - * RASTER3D_MAX_PRECISION \param tileX The number of cells in X direction of a - * tile \param tileY The number of cells in Y direction of a tile \param tileZ - * The number of cells in Z direction of a tile \return void * + * RASTER3D_MAX_PRECISION + * \param tileX The number of cells in X direction of a tile + * \param tileY The number of cells in Y direction of a tile + * \param tileZ The number of cells in Z direction of a tile + * \return void * */ void *Rast3d_open_new_param(const char *name, int typeIntern, int cache, diff --git a/lib/raster3d/resample.c b/lib/raster3d/resample.c index 3d804f40e9b..8ce6de6a920 100644 --- a/lib/raster3d/resample.c +++ b/lib/raster3d/resample.c @@ -12,9 +12,9 @@ * x, y, and z into region coordinates and returned the nearest neighbor. * * \param map - * \param col - * \param row - * \param depth + * \param x + * \param y + * \param z * \param value * \param type * \return void @@ -46,10 +46,10 @@ void Rast3d_nearest_neighbor(RASTER3D_Map *map, int x, int y, int z, * Sets the resampling function to be used by * Rast3d_get_value () (cf.{g3d:G3d.getValue}). This function is defined * as follows: - * - * \return void + * \param map + * \param resampleFun + * \return void */ - void Rast3d_set_resampling_fun(RASTER3D_Map *map, void (*resampleFun)(RASTER3D_Map *, int, int, int, void *, int)) @@ -68,7 +68,6 @@ void Rast3d_set_resampling_fun(RASTER3D_Map *map, * * \return void */ - void Rast3d_get_resampling_fun(RASTER3D_Map *map, void (**resampleFun)(RASTER3D_Map *, int, int, int, void *, int)) diff --git a/lib/raster3d/windowio.c b/lib/raster3d/windowio.c index b7094ac4695..9a883e290f4 100644 --- a/lib/raster3d/windowio.c +++ b/lib/raster3d/windowio.c @@ -261,7 +261,6 @@ int Rast3d_read_window(RASTER3D_Region *window, const char *windowName) * * \return void */ - void Rast3d_use_window_params(void) { Rast3d_set_window_params(); diff --git a/lib/vector/Vlib/area.c b/lib/vector/Vlib/area.c index d8fb08c6b64..bf7c714eb02 100644 --- a/lib/vector/Vlib/area.c +++ b/lib/vector/Vlib/area.c @@ -479,7 +479,7 @@ int Vect_get_area_cat(struct Map_info *Map, int area, int field) \param Map pointer to Map_info struct \param lines array of boundary lines \param n_lines number of lines in array - \param[out] APoints pointer to output line_pnts struct + \param[out] BPoints pointer to output line_pnts struct \return number of points \return -1 on error @@ -508,7 +508,7 @@ int Vect__get_area_points(struct Map_info *Map, const plus_t *lines, \param Map pointer to Map_info struct \param lines array of boundary lines \param n_lines number of lines in array - \param[out] APoints pointer to output line_pnts struct + \param[out] BPoints pointer to output line_pnts struct \return number of points \return -1 on error diff --git a/lib/vector/Vlib/cats.c b/lib/vector/Vlib/cats.c index 51e9accd240..f470f23b35a 100644 --- a/lib/vector/Vlib/cats.c +++ b/lib/vector/Vlib/cats.c @@ -479,7 +479,7 @@ int Vect_array_to_cat_list(const int *vals, int nvals, struct cat_list *list) Allocated array should be freed by G_free(). - \param cat_list pointer to cat_list struct + \param list pointer to cat_list struct \param[out] vals array of integers \param[out] nvals number of values diff --git a/lib/vector/Vlib/close.c b/lib/vector/Vlib/close.c index e8f034636d0..1385094e97c 100644 --- a/lib/vector/Vlib/close.c +++ b/lib/vector/Vlib/close.c @@ -310,7 +310,7 @@ void Vect__free_cache(struct Format_info_cache *cache) /*! Free memory of offset array - \param cache pointer to offset array to be freed + \param offset pointer to offset array to be freed */ void Vect__free_offset(struct Format_info_offset *offset) { diff --git a/lib/vector/Vlib/intersect.c b/lib/vector/Vlib/intersect.c index 66baaa2444b..cd7253dd74e 100644 --- a/lib/vector/Vlib/intersect.c +++ b/lib/vector/Vlib/intersect.c @@ -648,6 +648,8 @@ static int cross_seg(int id, const struct RTree_Rect *rect UNUSED, void *arg) * * \param APoints first input line * \param BPoints second input line + * \param ABox + * \param BBox * \param[out] ALines array of new lines created from original A line * \param[out] BLines array of new lines created from original B line * \param[out] nalines number of new lines (ALines) diff --git a/lib/vector/Vlib/intersect2.c b/lib/vector/Vlib/intersect2.c index 28b27a99b26..2cb880a44fb 100644 --- a/lib/vector/Vlib/intersect2.c +++ b/lib/vector/Vlib/intersect2.c @@ -665,6 +665,8 @@ static int boq_load(struct boq *q, struct line_pnts *Pnts, * \param BPoints second input line or NULL * \param[out] ALines array of new lines created from original A line * \param[out] BLines array of new lines created from original B line + * \param pABox + * \param pBBox * \param[out] nalines number of new lines (ALines) * \param[out] nblines number of new lines (BLines) * \param with_z 3D, not supported! diff --git a/lib/vector/Vlib/level_two.c b/lib/vector/Vlib/level_two.c index a33ff3e5a2d..aefd2851ba4 100644 --- a/lib/vector/Vlib/level_two.c +++ b/lib/vector/Vlib/level_two.c @@ -296,7 +296,8 @@ int Vect_get_node_coor(struct Map_info *Map, int num, double *x, double *y, \param Map pointer to Map_info struct \param line line id - \param n1 (start node), n2 (end node) ids of line nodes (or NULL) + \param n1 (start node), ids of line nodes (or NULL) + \param n2 (end node) ids of line nodes (or NULL) \return 1 */ diff --git a/lib/vector/Vlib/net_analyze.c b/lib/vector/Vlib/net_analyze.c index c279668c670..2b940637991 100644 --- a/lib/vector/Vlib/net_analyze.c +++ b/lib/vector/Vlib/net_analyze.c @@ -480,19 +480,24 @@ int Vect_net_get_node_cost(struct Map_info *Map, int node, double *cost) \brief Find nearest node(s) on network. \param Map vector map with build graph (see Vect_net_ttb_build_graph and - Vect_net_build_graph) \param x,y,z point coordinates (z coordinate NOT USED - !) \param direction (GV_FORWARD - from point to net, GV_BACKWARD - from net - to point) \param maxdist maximum distance to the network \param[out] node1 - pointer where to store the node number (or NULL) \param[out] node2 pointer - where to store the node number (or NULL) \param[out] ln pointer where to - store the nearest line number (or NULL) \param[out] costs1 pointer where to - store costs on nearest line to node1 (not costs from x,y,z to the line) (or - NULL) \param[out] costs2 pointer where to store costs on nearest line to - node2 (not costs from x,y,z to the line) (or NULL) \param[out] Points1 - pointer to structure where to store vertices on nearest line to node1 (or - NULL) \param[out] Points2 pointer to structure where to store vertices on - nearest line to node2 (or NULL) \param[out] pointer where to distance to the - line (or NULL) \param[out] distance + Vect_net_build_graph) + \param x,y,z point coordinates (z coordinate NOT USED!) + \param direction (GV_FORWARD - from point to net, GV_BACKWARD - from net + to point) + \param maxdist maximum distance to the network + \param[out] node1 pointer where to store the node number (or NULL) + \param[out] node2 pointer where to store the node number (or NULL) + \param[out] ln pointer where to store the nearest line number (or NULL) + \param[out] costs1 pointer where to store costs on nearest line to node1 (not + costs from x,y,z to the line) (or NULL) + \param[out] costs2 pointer where to store costs on nearest line to node2 + (not costs from x,y,z to the line) (or NULL) + \param[out] Points1 pointer to structure where to store vertices on nearest + line to node1 (or NULL) + \param[out] Points2 pointer to structure where to store vertices on nearest + line to node2 (or NULL) + \param[out] pointer where to distance to the line (or NULL) + \param[out] distance \return number of nodes found (0,1,2) */ diff --git a/lib/vector/Vlib/open.c b/lib/vector/Vlib/open.c index 4c0385f15e1..af6b4e3c7ec 100644 --- a/lib/vector/Vlib/open.c +++ b/lib/vector/Vlib/open.c @@ -603,7 +603,7 @@ int Vect_open_old(struct Map_info *Map, const char *name, const char *mapset) \brief Open existing temporary vector map for reading Temporary vector maps are stored in the current mapset (directory - .tmp//vector). + .tmp/\/vector). Calls G_fatal_error() on failure. @@ -671,7 +671,7 @@ int Vect_open_update(struct Map_info *Map, const char *name, const char *mapset) \brief Open existing temporary vector map for reading/writing Temporary vector maps are stored in the current mapset (directory - .tmp//vector). + .tmp/\/vector). By default list of updated features is not maintained, see Vect_set_updated() for details. @@ -967,7 +967,7 @@ int Vect_open_new(struct Map_info *Map, const char *name, int with_z) \brief Create new temporary vector map Temporary vector maps are stored in the current mapset (directory - .tmp//vector). If the map already exists, it is + .tmp/\/vector). If the map already exists, it is overwritten. Temporary vector maps are automatically deleted when closing the map diff --git a/lib/vector/Vlib/read_nat.c b/lib/vector/Vlib/read_nat.c index 69f219b7450..7327474b48c 100644 --- a/lib/vector/Vlib/read_nat.c +++ b/lib/vector/Vlib/read_nat.c @@ -125,9 +125,10 @@ int V1_read_next_line_nat(struct Map_info *Map, struct line_pnts *line_p, \param Map pointer to Map_info struct \param[out] Points container used to store line points within (pointer to - line_pnts struct) \param[out] Cats container used to store line categories - within (pointer to line_cats struct) \param line feature id to read (starts - at 1) + line_pnts struct) + \param[out] Cats container used to store line categories + within (pointer to line_cats struct) + \param line feature id to read (starts at 1) \return feature type (GV_POINT, GV_LINE, ...) \return -2 nothing to read diff --git a/lib/vector/Vlib/simple_features.c b/lib/vector/Vlib/simple_features.c index d3e3207bb5c..c618d4006fa 100644 --- a/lib/vector/Vlib/simple_features.c +++ b/lib/vector/Vlib/simple_features.c @@ -263,6 +263,7 @@ int Vect_sfa_is_line_simple(const struct line_pnts *Points UNUSED, \param Points pointer to line_pnts structure \param type feature type (GV_LINE or GV_BOUNDARY) + \param with_z \return 1 feature closed \return 0 feature not closed diff --git a/lib/vector/neta/timetables.c b/lib/vector/neta/timetables.c index ea806e10cd4..aabc8c8afaf 100644 --- a/lib/vector/neta/timetables.c +++ b/lib/vector/neta/timetables.c @@ -338,7 +338,7 @@ static neta_heap_data *new_heap_data(int conns, int v) /*! \brief Update Dijkstra structures - \param olc_conns old connection + \param old_conns old connection \param new_conns new connection \param to old 'to' node \param new_dst new 'to' node diff --git a/lib/vector/vedit/zbulk.c b/lib/vector/vedit/zbulk.c index cfa0d4becdc..3a3437e433f 100644 --- a/lib/vector/vedit/zbulk.c +++ b/lib/vector/vedit/zbulk.c @@ -22,7 +22,7 @@ \param Map pointer to Map_info \param List list of selected lines - \param point_start_end staring and ending point + \param x1,y1,x2,y2 staring and ending point \param start starting value \param step step value