From 7bc1d598636cacca62b5e552a02ac80c7634609c Mon Sep 17 00:00:00 2001 From: Shahram Najm Date: Mon, 21 Aug 2017 16:38:12 +0100 Subject: [PATCH] Documentation of C API --- html/eccodes_8h.html | 4 ++-- html/group__codes__handle.html | 12 ++++++------ src/eccodes.c | 4 ++-- src/eccodes.h | 10 +++++----- src/grib_api.h | 6 +++--- src/grib_handle.c | 4 ++-- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/html/eccodes_8h.html b/html/eccodes_8h.html index 49c83ef24..95aa57c12 100644 --- a/html/eccodes_8h.html +++ b/html/eccodes_8h.html @@ -375,10 +375,10 @@ Functions codes_handle * codes_handle_new_from_message_copy (codes_context *c, const void *data, size_t data_len)  Create a handle from a user message. More...
  -codes_handle * codes_grib_handle_new_from_samples (codes_context *c, const char *res_name) +codes_handle * codes_grib_handle_new_from_samples (codes_context *c, const char *sample_name)  Create a handle from a GRIB message contained in a samples directory. More...
  -codes_handle * codes_bufr_handle_new_from_samples (codes_context *c, const char *res_name) +codes_handle * codes_bufr_handle_new_from_samples (codes_context *c, const char *sample_name)  Create a handle from a BUFR message contained in a samples directory. More...
  codes_handle * codes_handle_clone (codes_handle *h) diff --git a/html/group__codes__handle.html b/html/group__codes__handle.html index 022e734e9..9b835e36d 100644 --- a/html/group__codes__handle.html +++ b/html/group__codes__handle.html @@ -115,10 +115,10 @@ Functions codes_handle * codes_handle_new_from_message_copy (codes_context *c, const void *data, size_t data_len)  Create a handle from a user message. More...
  -codes_handle * codes_grib_handle_new_from_samples (codes_context *c, const char *res_name) +codes_handle * codes_grib_handle_new_from_samples (codes_context *c, const char *sample_name)  Create a handle from a GRIB message contained in a samples directory. More...
  -codes_handle * codes_bufr_handle_new_from_samples (codes_context *c, const char *res_name) +codes_handle * codes_bufr_handle_new_from_samples (codes_context *c, const char *sample_name)  Create a handle from a BUFR message contained in a samples directory. More...
  codes_handle * codes_handle_clone (codes_handle *h) @@ -201,7 +201,7 @@ Functions const char *  - res_name  + sample_name  @@ -216,7 +216,7 @@ Functions
Parameters
- +
c: the context from which the handle will be created (NULL for default context)
res_name: the resource name
sample_name: the name of the sample file (without the .tmpl extension)
@@ -376,7 +376,7 @@ Functions const char *  - res_name  + sample_name  @@ -391,7 +391,7 @@ Functions
Parameters
- +
c: the context from which the handle will be created (NULL for default context)
res_name: the resource name
sample_name: the name of the sample file (without the .tmpl extension)
diff --git a/src/eccodes.c b/src/eccodes.c index eb558bbec..e91a6063c 100644 --- a/src/eccodes.c +++ b/src/eccodes.c @@ -167,9 +167,9 @@ grib_handle* codes_handle_new_from_message_copy(grib_context* c, const void* dat { return grib_handle_new_from_message_copy(c,data,data_len); } -grib_handle* codes_grib_handle_new_from_samples (grib_context* c, const char* res_name) +grib_handle* codes_grib_handle_new_from_samples(grib_context* c, const char* sample_name) { - return grib_handle_new_from_samples(c, res_name); + return grib_handle_new_from_samples(c, sample_name); } grib_handle* codes_handle_clone(grib_handle* h) { diff --git a/src/eccodes.h b/src/eccodes.h index 95aa7ed48..249a3dea0 100644 --- a/src/eccodes.h +++ b/src/eccodes.h @@ -458,24 +458,24 @@ codes_handle* codes_handle_new_from_message_copy(codes_context* c, const void* d /** - * Create a handle from a GRIB message contained in a samples directory. + * Create a handle from a GRIB message contained in the samples directory. * The message is copied at the creation of the handle * * @param c : the context from which the handle will be created (NULL for default context) - * @param res_name : the resource name + * @param sample_name : the name of the sample file (without the .tmpl extension) * @return the new handle, NULL if the resource is invalid or a problem is encountered */ -codes_handle* codes_grib_handle_new_from_samples (codes_context* c, const char* res_name) ; +codes_handle* codes_grib_handle_new_from_samples (codes_context* c, const char* sample_name); /** * Create a handle from a BUFR message contained in a samples directory. * The message is copied at the creation of the handle * * @param c : the context from which the handle will be created (NULL for default context) - * @param res_name : the resource name + * @param sample_name : the name of the sample file (without the .tmpl extension) * @return the new handle, NULL if the resource is invalid or a problem is encountered */ -codes_handle* codes_bufr_handle_new_from_samples (codes_context* c, const char* res_name) ; +codes_handle* codes_bufr_handle_new_from_samples (codes_context* c, const char* sample_name); /** diff --git a/src/grib_api.h b/src/grib_api.h index 306b9c17f..2fd9c6f14 100644 --- a/src/grib_api.h +++ b/src/grib_api.h @@ -485,14 +485,14 @@ grib_handle* grib_handle_new_from_message_copy(grib_context* c, const void* data /** - * Create a handle from a message contained in a samples directory. + * Create a handle from a GRIB message contained in the samples directory. * The message is copied at the creation of the handle * * @param c : the context from which the handle will be created (NULL for default context) - * @param res_name : the resource name + * @param sample_name : the name of the sample file (without the .tmpl extension) * @return the new handle, NULL if the resource is invalid or a problem is encountered */ -grib_handle* grib_handle_new_from_samples (grib_context* c, const char* res_name) ; +grib_handle* grib_handle_new_from_samples (grib_context* c, const char* sample_name); diff --git a/src/grib_handle.c b/src/grib_handle.c index 2661c4a8d..c16912fe9 100644 --- a/src/grib_handle.c +++ b/src/grib_handle.c @@ -249,7 +249,7 @@ static grib_handle* grib_handle_create ( grib_handle *gl, grib_context* c, cons return gl; } -grib_handle* grib_handle_new_from_samples ( grib_context* c, const char* name ) +grib_handle* grib_handle_new_from_samples( grib_context* c, const char* name ) { grib_handle* g = 0; if ( c == NULL ) c = grib_context_get_default(); @@ -264,7 +264,7 @@ grib_handle* grib_handle_new_from_samples ( grib_context* c, const char* name ) printf("ECCODES DEBUG: grib_handle_new_from_samples '%s'\n", name); } - g=grib_external_template ( c,name ); + g = grib_external_template( c,name ); if ( !g ) grib_context_log ( c,GRIB_LOG_ERROR,"Unable to load sample file %s.tmpl\n in %s", name, c->grib_samples_path );