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 13:57:55 +01:00
parent f2a5fa4486
commit 504f6a0876
6 changed files with 67 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
html/eccodes_8h.html
View File

@ -493,6 +493,9 @@ Functions</h2></td></tr>
<tr class="memitem:gabb904f520644caa008034bd2be9349ec"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#gabb904f520644caa008034bd2be9349ec">codes_set_long_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const long *vals, size_t length)</td></tr>
<tr class="memdesc:gabb904f520644caa008034bd2be9349ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a long array from a key. <a href="group__get__set.html#gabb904f520644caa008034bd2be9349ec">More...</a><br/></td></tr>
<tr class="separator:gabb904f520644caa008034bd2be9349ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6840ee00df4366a431bedcef609f8ae5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5">codes_set_string_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const char **vals, size_t length)</td></tr>
<tr class="memdesc:ga6840ee00df4366a431bedcef609f8ae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a string array from a key. <a href="group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5">More...</a><br/></td></tr>
<tr class="separator:ga6840ee00df4366a431bedcef609f8ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9cf0dd7ede554cc4b8a56728d768d88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eccodes_8h.html#ab9cf0dd7ede554cc4b8a56728d768d88">codes_dump_content</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, FILE *out, const char *mode, unsigned long option_flags, void *arg)</td></tr>
<tr class="memdesc:ab9cf0dd7ede554cc4b8a56728d768d88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print all keys, with the context print procedure and dump mode to a resource. <a href="#ab9cf0dd7ede554cc4b8a56728d768d88">More...</a><br/></td></tr>
<tr class="separator:ab9cf0dd7ede554cc4b8a56728d768d88"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -644,7 +647,7 @@ Functions</h2></td></tr>
<table class="params">
<tr><td class="paramname">h</td><td>: the handle to be printed </td></tr>
<tr><td class="paramname">out</td><td>: output file handle </td></tr>
<tr><td class="paramname">mode</td><td>: available dump modes are: debug wmo c_code </td></tr>
<tr><td class="paramname">mode</td><td>: Examples of available dump modes: debug wmo </td></tr>
<tr><td class="paramname">option_flags</td><td>: all the CODES_DUMP_FLAG_x flags can be used </td></tr>
<tr><td class="paramname">arg</td><td>: used to provide a format to output data (experimental) </td></tr>
</table>

3
html/globals.html
View File

@ -518,6 +518,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>codes_set_string()
: <a class="el" href="group__get__set.html#ga6062cdd5950966bffa72e74708f85368">eccodes.h</a>
</li>
<li>codes_set_string_array()
: <a class="el" href="group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5">eccodes.h</a>
</li>
<li>CODES_STRING_TOO_SMALL
: <a class="el" href="group__errors.html#ga2d577c49ec3604d481c12f1bf5539eee">eccodes.h</a>
</li>

3
html/globals_func.html
View File

@ -341,6 +341,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>codes_set_string()
: <a class="el" href="group__get__set.html#ga6062cdd5950966bffa72e74708f85368">eccodes.h</a>
</li>
<li>codes_set_string_array()
: <a class="el" href="group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5">eccodes.h</a>
</li>
<li>codes_write_message()
: <a class="el" href="group__codes__handle.html#gac82dbaba240ebf6e76cdbcf2007a6bee">eccodes.h</a>
</li>

55
html/group__get__set.html
View File

@ -140,6 +140,9 @@ Functions</h2></td></tr>
<tr class="memitem:gabb904f520644caa008034bd2be9349ec"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#gabb904f520644caa008034bd2be9349ec">codes_set_long_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const long *vals, size_t length)</td></tr>
<tr class="memdesc:gabb904f520644caa008034bd2be9349ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a long array from a key. <a href="#gabb904f520644caa008034bd2be9349ec">More...</a><br/></td></tr>
<tr class="separator:gabb904f520644caa008034bd2be9349ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6840ee00df4366a431bedcef609f8ae5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5">codes_set_string_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const char **vals, size_t length)</td></tr>
<tr class="memdesc:ga6840ee00df4366a431bedcef609f8ae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a string array from a key. <a href="#ga6840ee00df4366a431bedcef609f8ae5">More...</a><br/></td></tr>
<tr class="separator:ga6840ee00df4366a431bedcef609f8ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
@ -1054,6 +1057,58 @@ Functions</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
</div>
</div>
<a class="anchor" id="ga6840ee00df4366a431bedcef609f8ae5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int codes_set_string_array </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **&#160;</td>
<td class="paramname"><em>vals</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a string array from a key. </p>
<p>If several keys of the same name are present, the last one is set </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#gac43a3c0bf2561ceeb4bcc22d734b53b1" title="Get long array values from a key. ">codes_get_long_array</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>: the handle to set the data to </td></tr>
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
<tr><td class="paramname">vals</td><td>: the address of a string array where the data will be read </td></tr>
<tr><td class="paramname">length</td><td>: a size_t that contains the length of the array on input </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
</div>
</div>
</div><!-- contents -->

2
html/search/all_63.js
View File

@ -261,7 +261,7 @@ var searchData=
['codes_5fset_5freal8_5farray',['codes_set_real8_array',['../interfaceeccodes_1_1codes__set.html#a14b3bc17ea1ee83936f32dd0fced44a4',1,'eccodes::codes_set::codes_set_real8_array()'],['../classeccodes.html#a14b3bc17ea1ee83936f32dd0fced44a4',1,'eccodes::codes_set_real8_array()']]],
['codes_5fset_5fsamples_5fpath',['codes_set_samples_path',['../classeccodes.html#af4be467f3273e17111becbd483c25018',1,'eccodes::codes_set_samples_path()'],['../namespaceec_codes.html#ab7f299aaed48129491cc365a8ca289c2',1,'ecCodes.codes_set_samples_path()']]],
['codes_5fset_5fstring',['codes_set_string',['../interfaceeccodes_1_1codes__set.html#a50acfd20f8dff8b4e547135057ef119a',1,'eccodes::codes_set::codes_set_string()'],['../classeccodes.html#a50acfd20f8dff8b4e547135057ef119a',1,'eccodes::codes_set_string()'],['../group__get__set.html#ga6062cdd5950966bffa72e74708f85368',1,'codes_set_string():&#160;eccodes.h'],['../namespaceec_codes.html#acbb0d241a917a3e726792157c1f5d973',1,'ecCodes.codes_set_string()']]],
['codes_5fset_5fstring_5farray',['codes_set_string_array',['../classeccodes.html#aae3ccb53638a4d16daf98d937a96e8b6',1,'eccodes']]],
['codes_5fset_5fstring_5farray',['codes_set_string_array',['../classeccodes.html#aae3ccb53638a4d16daf98d937a96e8b6',1,'eccodes::codes_set_string_array()'],['../group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5',1,'codes_set_string_array():&#160;eccodes.h']]],
['codes_5fset_5fvalues',['codes_set_values',['../namespaceec_codes.html#abc699d0bb7a7dded968ee0111342ffd0',1,'ecCodes']]],
['codes_5fskip_5fcoded',['codes_skip_coded',['../classeccodes.html#a56a1567687b281d07c193ce273c0e1b2',1,'eccodes::codes_skip_coded()'],['../namespaceec_codes.html#a4b7140ca0dd81372721cffd1d964e4ad',1,'ecCodes.codes_skip_coded()']]],
['codes_5fskip_5fcomputed',['codes_skip_computed',['../classeccodes.html#aad63202303a1b6aaf9f5e605622a8095',1,'eccodes::codes_skip_computed()'],['../namespaceec_codes.html#a587af29aac21a816f8ffd327a1fce779',1,'ecCodes.codes_skip_computed()']]],

2
html/search/functions_63.js
View File

@ -182,7 +182,7 @@ var searchData=
['codes_5fset_5freal8_5farray',['codes_set_real8_array',['../interfaceeccodes_1_1codes__set.html#a14b3bc17ea1ee83936f32dd0fced44a4',1,'eccodes::codes_set::codes_set_real8_array()'],['../classeccodes.html#a14b3bc17ea1ee83936f32dd0fced44a4',1,'eccodes::codes_set_real8_array()']]],
['codes_5fset_5fsamples_5fpath',['codes_set_samples_path',['../classeccodes.html#af4be467f3273e17111becbd483c25018',1,'eccodes::codes_set_samples_path()'],['../namespaceec_codes.html#ab7f299aaed48129491cc365a8ca289c2',1,'ecCodes.codes_set_samples_path()']]],
['codes_5fset_5fstring',['codes_set_string',['../interfaceeccodes_1_1codes__set.html#a50acfd20f8dff8b4e547135057ef119a',1,'eccodes::codes_set::codes_set_string()'],['../classeccodes.html#a50acfd20f8dff8b4e547135057ef119a',1,'eccodes::codes_set_string()'],['../group__get__set.html#ga6062cdd5950966bffa72e74708f85368',1,'codes_set_string():&#160;eccodes.h'],['../namespaceec_codes.html#acbb0d241a917a3e726792157c1f5d973',1,'ecCodes.codes_set_string()']]],
['codes_5fset_5fstring_5farray',['codes_set_string_array',['../classeccodes.html#aae3ccb53638a4d16daf98d937a96e8b6',1,'eccodes']]],
['codes_5fset_5fstring_5farray',['codes_set_string_array',['../classeccodes.html#aae3ccb53638a4d16daf98d937a96e8b6',1,'eccodes::codes_set_string_array()'],['../group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5',1,'codes_set_string_array():&#160;eccodes.h']]],
['codes_5fset_5fvalues',['codes_set_values',['../namespaceec_codes.html#abc699d0bb7a7dded968ee0111342ffd0',1,'ecCodes']]],
['codes_5fskip_5fcoded',['codes_skip_coded',['../classeccodes.html#a56a1567687b281d07c193ce273c0e1b2',1,'eccodes::codes_skip_coded()'],['../namespaceec_codes.html#a4b7140ca0dd81372721cffd1d964e4ad',1,'ecCodes.codes_skip_coded()']]],
['codes_5fskip_5fcomputed',['codes_skip_computed',['../classeccodes.html#aad63202303a1b6aaf9f5e605622a8095',1,'eccodes::codes_skip_computed()'],['../namespaceec_codes.html#a587af29aac21a816f8ffd327a1fce779',1,'ecCodes.codes_skip_computed()']]],