From f588d5b072fc9595ab46eb262b9ce5833e198294 Mon Sep 17 00:00:00 2001 From: Shahram Najm Date: Tue, 27 Sep 2016 14:36:41 +0100 Subject: [PATCH] Documentation update (doxygen/html) --- doxygen/eccodes.dox | 1 + html/classeccodes.html | 4 ++-- html/index.html | 2 +- html/interfaceeccodes_1_1codes__set.html | 6 +++--- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doxygen/eccodes.dox b/doxygen/eccodes.dox index b6ebb2949..52f02c647 100644 --- a/doxygen/eccodes.dox +++ b/doxygen/eccodes.dox @@ -29,6 +29,7 @@ in JSON format which can be use Migration from GRIB-API to %ecCodes is expected to be transparent for current GRIB-API users. The GRIB-API library is fully available in the %ecCodes library. Users are encouraged to test their GRIB-API applications by linking with the %ecCodes library and to provide feedback of any problems encountered. +For further details see here. \warning Name clashes prevent a simultaneous use of the GRIB-API and %ecCodes libraries. For this reason, and to simplify the software maintenance, it is planned to replace GRIB-API by %ecCodes.\n The functions with the "grib_" prefix will, however, be maintained in %ecCodes. diff --git a/html/classeccodes.html b/html/classeccodes.html index 165c87fca..7a527ba46 100644 --- a/html/classeccodes.html +++ b/html/classeccodes.html @@ -5441,12 +5441,12 @@ Public Member Functions

*/

-

Set the character value for a string key in a grib message.

+

Set the character value for a string key in a message.

In case of error, if the status parameter (optional) is not given, the program will exit with an error message.
Otherwise the error message can be gathered with codes_get_error_string.

Parameters
- + diff --git a/html/index.html b/html/index.html index ce0ad5909..8e906592e 100644 --- a/html/index.html +++ b/html/index.html @@ -91,7 +91,7 @@ Overview

For GRIB encoding and decoding, the GRIB-API functionality is provided fully in ecCodes with the same user interface and behaviour. Interfaces for C, Fortran 90 and Python are all maintained as in GRIB-API. However, the GRIB-API Fortran 77 interface is no longer available.

In addition, a new set of functions with the prefix "codes_" is provided to operate on all the supported message formats. These functions have the same interface and behaviour as the "grib_" functions.

A selection of GRIB-API tools has been included in ecCodes (ecCodes GRIB tools), while new tools are available for the BUFR (ecCodes BUFR tools) and GTS formats. The new tools have been developed to be as similar as possible to the existing GRIB-API tools maintaining, where possible, the same options and behaviour. A significant difference compared with GRIB-API tools is that bufr_dump produces output in JSON format which can be used in many web based applications.

-

Migration from GRIB-API to ecCodes is expected to be transparent for current GRIB-API users. The GRIB-API library is fully available in the ecCodes library. Users are encouraged to test their GRIB-API applications by linking with the ecCodes library and to provide feedback of any problems encountered.

+

Migration from GRIB-API to ecCodes is expected to be transparent for current GRIB-API users. The GRIB-API library is fully available in the ecCodes library. Users are encouraged to test their GRIB-API applications by linking with the ecCodes library and to provide feedback of any problems encountered. For further details see here.

Warning
Name clashes prevent a simultaneous use of the GRIB-API and ecCodes libraries. For this reason, and to simplify the software maintenance, it is planned to replace GRIB-API by ecCodes.
The functions with the "grib_" prefix will, however, be maintained in ecCodes.
diff --git a/html/interfaceeccodes_1_1codes__set.html b/html/interfaceeccodes_1_1codes__set.html index 2b718810a..92569cd41 100644 --- a/html/interfaceeccodes_1_1codes__set.html +++ b/html/interfaceeccodes_1_1codes__set.html @@ -109,7 +109,7 @@ Public Member Functions - + @@ -647,12 +647,12 @@ Public Member Functions
msgidid of the grib loaded in memory
msgidid of the message loaded in memory
keykey name
valuecharacter value
statusCODES_SUCCESS if OK, integer value on error
 Set the real(8) value for a key in a message. More...
 
subroutine codes_set_string (msgid, key, value, status)
 Set the character value for a string key in a grib message.More...
 Set the character value for a string key in a message.More...
 
subroutine codes_set_int_array (msgid, key, value, status)
 Set the integers values for an array key in a message. More...
-

Set the character value for a string key in a grib message.

+

Set the character value for a string key in a message.

In case of error, if the status parameter (optional) is not given, the program will exit with an error message.
Otherwise the error message can be gathered with codes_get_error_string.

Parameters
- +
msgidid of the grib loaded in memory
msgidid of the message loaded in memory
keykey name
valuecharacter value
statusCODES_SUCCESS if OK, integer value on error