core
/
eccodes
mirror of https://github.com/ecmwf/eccodes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Comments cleanup

This commit is contained in:
Shahram Najm 2021-03-24 13:01:07 +00:00
parent 310ad0bd0d
commit c9ec3eb6ed
2 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/eccodes.h
View File

@ -133,7 +133,7 @@ typedef struct grib_key_value_list codes_key_value_list;
*/ */
typedef struct grib_handle codes_handle; typedef struct grib_handle codes_handle;
/*! GRIB multi field handle, structure used to build multi fields messages. /*! GRIB multi-field handle, structure used to build multi-field messages.
\ingroup codes_handle \ingroup codes_handle
\struct codes_multi_handle \struct codes_multi_handle
*/ */
@ -312,7 +312,7 @@ int codes_index_select_long(codes_index* index, const char* key, long value);
int codes_index_select_double(codes_index* index, const char* key, double value); int codes_index_select_double(codes_index* index, const char* key, double value);
/** /**
* Select the message subset with key==value. The value is a string. The key must have been created with string type or have string as native type if the type was not explicitly defined in the index creation. * Select the message subset with key==value. The value is a string. The key must have been created with string type or have string as native type if the type was not explicitly defined in the index creation.
* *
* @param index : an index created from a file. * @param index : an index created from a file.
* The index must have been created with the key in argument. * The index must have been created with the key in argument.
@ -323,13 +323,13 @@ int codes_index_select_double(codes_index* index, const char* key, double value)
int codes_index_select_string(codes_index* index, const char* key, const char* value); int codes_index_select_string(codes_index* index, const char* key, const char* value);
/** /**
* Create a new handle from an index after having selected the key values. * Create a new handle from an index after having selected the key values.
* All the keys belonging to the index must be selected before calling this function. Successive calls to this function will return all the handles compatible with the constraints defined selecting the values of the index keys. * All the keys belonging to the index must be selected before calling this function. Successive calls to this function will return all the handles compatible with the constraints defined selecting the values of the index keys.
* When no more handles are available from the index a NULL pointer is returned and the err variable is set to CODES_END_OF_INDEX. * When no more handles are available from the index a NULL pointer is returned and the err variable is set to CODES_END_OF_INDEX.
* *
* @param index : an index created from a file. * @param index : an index created from a file.
* @param err : 0 if OK, integer value on error. CODES_END_OF_INDEX when no more handles are contained in the index. * @param err : 0 if OK, integer value on error. CODES_END_OF_INDEX when no more handles are contained in the index.
* @return grib handle. * @return GRIB handle.
*/ */
codes_handle* codes_handle_new_from_index(codes_index* index, int* err); codes_handle* codes_handle_new_from_index(codes_index* index, int* err);
@ -435,7 +435,7 @@ codes_handle* codes_handle_new_from_message(codes_context* c, const void* data,
/** /**
* Create a handle from a user message in memory. The message will not be freed at the end. * Create a handle from a user message in memory. The message will not be freed at the end.
* The message will be copied as soon as a modification is needed. * The message will be copied as soon as a modification is needed.
* This function works also with multi field messages. * This function works also with multi-field messages.
* *
* @param c : the context from which the handle will be created (NULL for default context) * @param c : the context from which the handle will be created (NULL for default context)
* @param data : the actual message * @param data : the actual message
@ -685,7 +685,7 @@ int codes_grib_nearest_delete(codes_nearest* nearest);
* Find the nearest point of a set of points whose latitudes and longitudes * Find the nearest point of a set of points whose latitudes and longitudes
* are given in the inlats, inlons arrays respectively. * are given in the inlats, inlons arrays respectively.
* If the flag is_lsm is 1 the nearest land point is returned and the * If the flag is_lsm is 1 the nearest land point is returned and the
* grib passed as handle (h) is considered a land sea mask. * GRIB passed as handle (h) is considered a land sea mask.
* The land nearest point is the nearest point with land sea mask value>=0.5. * The land nearest point is the nearest point with land sea mask value>=0.5.
* If no nearest land points are found the nearest value is returned. * If no nearest land points are found the nearest value is returned.
* If the flag is_lsm is 0 the nearest point is returned. * If the flag is_lsm is 0 the nearest point is returned.
@ -1067,14 +1067,14 @@ void codes_context_set_definitions_path(codes_context* c, const char* path);
void codes_context_set_samples_path(codes_context* c, const char* path); void codes_context_set_samples_path(codes_context* c, const char* path);
/** /**
* Turn on support for multiple fields in single GRIB messages * Turn on support for multi-fields in single GRIB messages
* *
* @param c : the context to be modified * @param c : the context to be modified
*/ */
void codes_grib_multi_support_on(codes_context* c); void codes_grib_multi_support_on(codes_context* c);
/** /**
* Turn off support for multiple fields in single GRIB messages * Turn off support for multi-fields in single GRIB messages
* *
* @param c : the context to be modified * @param c : the context to be modified
*/ */

28
src/grib_api.h
View File

@ -187,7 +187,7 @@ struct grib_values
*/ */
typedef struct grib_handle grib_handle; typedef struct grib_handle grib_handle;
/*! Grib multi field handle, structure used to build multi field GRIB messages. /*! Grib multi field handle, structure used to build multi-field GRIB messages.
\ingroup grib_handle \ingroup grib_handle
*/ */
typedef struct grib_multi_handle grib_multi_handle; typedef struct grib_multi_handle grib_multi_handle;
@ -387,7 +387,7 @@ int grib_index_select_string(grib_index* index, const char* key, const char* val
* *
* @param index : an index created from a file. * @param index : an index created from a file.
* @param err : 0 if OK, integer value on error. GRIB_END_OF_INDEX when no more handles are contained in the index. * @param err : 0 if OK, integer value on error. GRIB_END_OF_INDEX when no more handles are contained in the index.
* @return grib handle. * @return GRIB handle.
*/ */
grib_handle* grib_handle_new_from_index(grib_index* index, int* err); grib_handle* grib_handle_new_from_index(grib_index* index, int* err);
@ -474,7 +474,7 @@ grib_handle* grib_handle_new_from_message(grib_context* c, const void* data, siz
/** /**
* Create a handle from a user message in memory. The message will not be freed at the end. * Create a handle from a user message in memory. The message will not be freed at the end.
* The message will be copied as soon as a modification is needed. * The message will be copied as soon as a modification is needed.
* This function works also with multi field messages. * This function works also with multi-field messages.
* Note: The data pointer argument may be modified * Note: The data pointer argument may be modified
* *
* @param c : the context from which the handle will be created (NULL for default context) * @param c : the context from which the handle will be created (NULL for default context)
@ -526,7 +526,7 @@ grib_handle* grib_handle_clone(const grib_handle* h);
int grib_handle_delete(grib_handle* h); int grib_handle_delete(grib_handle* h);
/** /**
* Create an empty multi field handle. * Create an empty multi-field handle.
* Remember always to delete the multi handle when it is not needed anymore to avoid * Remember always to delete the multi handle when it is not needed anymore to avoid
* memory leaks. * memory leaks.
* *
@ -536,7 +536,7 @@ grib_multi_handle* grib_multi_handle_new(grib_context* c);
/** /**
* Append the sections starting with start_section of the message pointed by h at * Append the sections starting with start_section of the message pointed by h at
* the end of the multi field handle mh. * the end of the multi-field handle mh.
* Remember always to delete the multi handle when it is not needed anymore to avoid * Remember always to delete the multi handle when it is not needed anymore to avoid
* memory leaks. * memory leaks.
* *
@ -548,20 +548,20 @@ grib_multi_handle* grib_multi_handle_new(grib_context* c);
int grib_multi_handle_append(grib_handle* h, int start_section, grib_multi_handle* mh); int grib_multi_handle_append(grib_handle* h, int start_section, grib_multi_handle* mh);
/** /**
* Delete multi field handle. * Delete multi-field handle.
* *
* @param mh : The multi field handle to be deleted. * @param mh : The multi-field handle to be deleted.
* @return 0 if OK, integer value on error * @return 0 if OK, integer value on error
*/ */
int grib_multi_handle_delete(grib_multi_handle* mh); int grib_multi_handle_delete(grib_multi_handle* mh);
/** /**
* Write a multi field handle in a file. * Write a multi-field handle in a file.
* Remember always to delete the multi handle when it is not needed anymore to avoid * Remember to delete the multi handle when it is not needed anymore to avoid
* memory leaks. * memory leaks.
* *
* @param mh : The multi field handle to be written. * @param mh : The multi field handle to be written.
* @param f : File on which the file handle is written. * @param f : File on which the file handle is written.
* @return 0 if OK, integer value on error * @return 0 if OK, integer value on error
*/ */
int grib_multi_handle_write(grib_multi_handle* mh, FILE* f); int grib_multi_handle_write(grib_multi_handle* mh, FILE* f);
@ -1221,21 +1221,21 @@ void grib_context_set_print_proc(grib_context* c, grib_print_proc printp);
void grib_context_set_logging_proc(grib_context* c, grib_log_proc logp); void grib_context_set_logging_proc(grib_context* c, grib_log_proc logp);
/** /**
* Turn on support for multiple fields in single grib messages * Turn on support for multi-fields in single GRIB messages
* *
* @param c : the context to be modified * @param c : the context to be modified
*/ */
void grib_multi_support_on(grib_context* c); void grib_multi_support_on(grib_context* c);
/** /**
* Turn off support for multiple fields in single GRIB messages * Turn off support for multi-fields in single GRIB messages
* *
* @param c : the context to be modified * @param c : the context to be modified
*/ */
void grib_multi_support_off(grib_context* c); void grib_multi_support_off(grib_context* c);
/** /**
* Reset file handle in multiple field support mode * Reset file handle in multi-field support mode
* *
* @param c : the context to be modified * @param c : the context to be modified
* @param f : the file pointer * @param f : the file pointer