From e8d0eaa3cd082f030c75c2c9dc9def9f59f3b944 Mon Sep 17 00:00:00 2001 From: Shahram Najm Date: Mon, 21 Aug 2023 13:52:22 +0100 Subject: [PATCH] Comments --- src/eccodes.h | 16 ++++++++-------- src/grib_api.h | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/eccodes.h b/src/eccodes.h index b5d42c955..e2ddb6588 100644 --- a/src/eccodes.h +++ b/src/eccodes.h @@ -606,9 +606,9 @@ int codes_grib_get_data(const codes_handle* h, double* lats, double* lons, doubl * Get the next value from a geoiterator. * * @param i : the geoiterator - * @param lat : on output latitude in degree - * @param lon : on output longitude in degree - * @param value : on output value of the point + * @param lat : output latitude in degrees + * @param lon : output longitude in degrees + * @param value : output value of the point * @return positive value if successful, 0 if no more data are available */ int codes_grib_iterator_next(codes_iterator* i, double* lat, double* lon, double* value); @@ -617,9 +617,9 @@ int codes_grib_iterator_next(codes_iterator* i, double* lat, double* lon, double * Get the previous value from a geoiterator. * * @param i : the geoiterator - * @param lat : on output latitude in degree - * @param lon : on output longitude in degree - * @param value : on output value of the point* + * @param lat : output latitude in degrees + * @param lon : output longitude in degrees + * @param value : output value of the point* * @return positive value if successful, 0 if no more data are available */ int codes_grib_iterator_previous(codes_iterator* i, double* lat, double* lon, double* value); @@ -628,7 +628,7 @@ int codes_grib_iterator_previous(codes_iterator* i, double* lat, double* lon, do * Test procedure for values in a geoiterator. * * @param i : the geoiterator - * @return boolean, 1 if the iterator still nave next values, 0 otherwise + * @return boolean, 1 if the iterator still has next values, 0 otherwise */ int codes_grib_iterator_has_next(codes_iterator* i); @@ -685,7 +685,7 @@ int codes_grib_nearest_find(codes_nearest* nearest, const codes_handle* h, doubl /** * Frees a nearest object from memory * - * @param nearest : the nearest + * @param nearest : the nearest neighbour object * @return 0 if OK, integer value on error */ int codes_grib_nearest_delete(codes_nearest* nearest); diff --git a/src/grib_api.h b/src/grib_api.h index 0dc7be127..6b0f82b4e 100644 --- a/src/grib_api.h +++ b/src/grib_api.h @@ -599,7 +599,7 @@ grib_iterator* grib_iterator_new(const grib_handle* h, unsigned long flags, int* /** * Get latitude/longitude and data values. - * The Latitudes, longitudes and values arrays must be properly allocated by the caller. + * The latitudes, longitudes and values arrays must be properly allocated by the caller. * Their required dimension can be obtained by getting the value of the integer key "numberOfPoints". * * @param h : handle from which geography and data values are taken @@ -636,7 +636,7 @@ int grib_iterator_previous(grib_iterator* i, double* lat, double* lon, double* v * Test procedure for values in a geoiterator. * * @param i : the geoiterator - * @return boolean, 1 if the geoiterator still nave next values, 0 otherwise + * @return boolean, 1 if the geoiterator still has next values, 0 otherwise */ int grib_iterator_has_next(grib_iterator* i);