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

Documentation update (doxygen/html)

This commit is contained in:
Shahram Najm 2016-09-27 14:36:41 +01:00
parent 4451b85533
commit f588d5b072
4 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doxygen/eccodes.dox
View File

@ -29,6 +29,7 @@ in <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> 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 <a href="https://software.ecmwf.int/wiki/display/ECC/GRIB-API+migration">here</a>.
\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.

4
html/classeccodes.html
View File

@ -5441,12 +5441,12 @@ Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>*/ </p>
<p>Set the character value for a string key in a grib message.</p>
<p>Set the character value for a string key in a message.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msgid</td><td>id of the grib loaded in memory </td></tr>
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
<tr><td class="paramname">key</td><td>key name </td></tr>
<tr><td class="paramname">value</td><td>character value </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>

2
html/index.html
View File

@ -91,7 +91,7 @@ Overview</h1>
<p>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.</p>
<p>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.</p>
<p>A selection of GRIB-API tools has been included in ecCodes (<a href="https://software.ecmwf.int/wiki/display/ECC/GRIB+tools">ecCodes GRIB tools</a>), while new tools are available for the BUFR (<a href="https://software.ecmwf.int/wiki/display/ECC/BUFR+tools">ecCodes BUFR tools</a>) 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 <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> format which can be used in many web based applications.</p>
<p>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.</p>
<p>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 <a href="https://software.ecmwf.int/wiki/display/ECC/GRIB-API+migration">here</a>.</p>
<dl class="section warning"><dt>Warning</dt><dd>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.<br/>
The functions with the "grib_" prefix will, however, be maintained in ecCodes.</dd></dl>
<h6></h6>

6
html/interfaceeccodes_1_1codes__set.html
View File

@ -109,7 +109,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a4b20fe82de5ba6f8355ff8a5d2725b3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the real(8) value for a key in a message. <a href="#a4b20fe82de5ba6f8355ff8a5d2725b3d">More...</a><br/></td></tr>
<tr class="separator:a4b20fe82de5ba6f8355ff8a5d2725b3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50acfd20f8dff8b4e547135057ef119a"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__set.html#a50acfd20f8dff8b4e547135057ef119a">codes_set_string</a> (msgid, key, value, status)</td></tr>
<tr class="memdesc:a50acfd20f8dff8b4e547135057ef119a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the character value for a string key in a grib message.<a href="#a50acfd20f8dff8b4e547135057ef119a">More...</a><br/></td></tr>
<tr class="memdesc:a50acfd20f8dff8b4e547135057ef119a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the character value for a string key in a message.<a href="#a50acfd20f8dff8b4e547135057ef119a">More...</a><br/></td></tr>
<tr class="separator:a50acfd20f8dff8b4e547135057ef119a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18b5890c85f15d5fefeefc2b99a09ce5"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__set.html#a18b5890c85f15d5fefeefc2b99a09ce5">codes_set_int_array</a> (msgid, key, value, status)</td></tr>
<tr class="memdesc:a18b5890c85f15d5fefeefc2b99a09ce5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the integers values for an array key in a message. <a href="#a18b5890c85f15d5fefeefc2b99a09ce5">More...</a><br/></td></tr>
@ -647,12 +647,12 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Set the character value for a string key in a grib message.</p>
<p>Set the character value for a string key in a message.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msgid</td><td>id of the grib loaded in memory </td></tr>
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
<tr><td class="paramname">key</td><td>key name </td></tr>
<tr><td class="paramname">value</td><td>character value </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>