Documentation update (doxygen/html)

This commit is contained in:
Shahram Najm 2016-09-27 14:18:30 +01:00
parent 504f6a0876
commit 4451b85533
3 changed files with 8 additions and 4 deletions

View File

@ -20,8 +20,13 @@ doxygen grib_api_wiz.cfg
# Do not copy this. Use default generated doxygen.css
# cp doxygen.css ../html/
# Change the links from example code back to confluence
# ./convert_links.sh
# Note:
# May have to edit html/interfaceeccodes_1_1codes__set.html
# to remove the weird */ inserted for subroutine 'codes_set_string'
# Remove temp files
rm -f eccodes.h
rm -f ecCodes.py

View File

@ -2159,13 +2159,13 @@ subroutine codes_set_force_real8_array ( msgid, key, value, status)
end subroutine codes_set_force_real8_array
!> @endcond
!> 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.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!> @param msgid id of the grib loaded in memory
!> @param msgid id of the message loaded in memory
!> @param key key name
!> @param value character value
!> @param status CODES_SUCCESS if OK, integer value on error

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">*/ <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 grib 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,7 +647,6 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>*/ </p>
<p>Set the character value for a string key in a grib 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>