diff options
author | Frank Baker <fbaker@hdfgroup.org> | 2006-10-12 22:25:07 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 2006-10-12 22:25:07 (GMT) |
commit | 9601ee7d101e99ce54b9642cf053b00b7a196834 (patch) | |
tree | f6933deff0e87d19bba1f5d9d65cb652a78c061b | |
parent | 2bf7a8b00ad6fdae9b8ab1a74132ddb4f717952e (diff) | |
download | hdf5-9601ee7d101e99ce54b9642cf053b00b7a196834.zip hdf5-9601ee7d101e99ce54b9642cf053b00b7a196834.tar.gz hdf5-9601ee7d101e99ce54b9642cf053b00b7a196834.tar.bz2 |
[svn-r12757]
Description:
Fixed several small directly-reported bugs (i.e., not in Bugzilla).
Minor copy edits and format errors fixed in these function entries:
H5Iget_name H5Pset_chunk
H5Tenum_nameof H5Tenum_valueof
H5Pset_deflate: Corrected 'level' parameter type (to uint).
HTML coding format cleanup thoroughout the above functions.
Tested:
Firefox
-rw-r--r-- | doc/html/RM_H5I.html | 30 | ||||
-rw-r--r-- | doc/html/RM_H5P.html | 18 | ||||
-rw-r--r-- | doc/html/RM_H5T.html | 32 |
3 files changed, 46 insertions, 34 deletions
diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index cd0a58b..3061045 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -340,7 +340,8 @@ END SUBROUTINE h5iget_file_id_f <dl> <dt><strong>Name:</strong> <a name="Identify-GetName">H5Iget_name</a> <dt><strong>Signature:</strong> - <dd><em>ssize_t</em> <code>H5Iget_name</code>(<em>hid_t</em> <code>obj_id</code>, + <dd><em>ssize_t</em> <code>H5Iget_name</code>( + <em>hid_t</em> <code>obj_id</code>, <em>char *</em><code>name</code>, <em>size_t</em> <code>size</code> ) @@ -385,19 +386,20 @@ END SUBROUTINE h5iget_file_id_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> <td valign="top">IN: Identifier of the object. - This identifier can refer to a group, dataset, or named datatype.</td></tr> + This identifier can refer to a group, dataset, + or named datatype.</td></tr> <tr> - <td valign="top"><em>char *</em><code>name</code></td> + <td valign="top"><em>char *</em><code>name</code></td> <td valign="top">OUT: A name associated with the identifier.</td></tr> <tr> - <td valign="top"><em>size_t size</em></td> + <td valign="top"><em>size_t</em> <code>size</code></td> <td valign="top">IN: The size of the <code>name</code> buffer.</td></tr> </table></ul> <dt><strong>Returns:</strong> - <dd>Returns the length of the name if successful, - returning <code>0</code> (zero) if no name is associated with the identifier. + <dd>Returns the length of the name if successful, returning <code>0</code> + (zero) if no name is associated with the identifier. Otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5iget_name_f <dd> @@ -413,7 +415,7 @@ SUBROUTINE h5iget_name_f(obj_id, buf, buf_size, hdferr) END SUBROUTINE h5iget_name_f </pre> - <!--<dt><strong>Non-C API(s):</strong> + <!--<dt><strong>Non-C API(s):</strong> <dd> <img src="Graphics/Java.gif"> @@ -422,14 +424,14 @@ END SUBROUTINE h5iget_name_f <dt><strong>History:</strong> <ul><table width="90%"> <tr> - <td valign="top" align="left" width="10%"> - <strong>Release</strong> </td> + <td valign="top" align="left" width="10%"> + <strong>Release</strong> </td> <td valign="top" align="left"> - <strong>C</strong></td></tr> + <strong>C</strong></td></tr> <tr> - <td valign="top">1.6.0</td> + <td valign="top">1.6.0</td> <td valign="top"> - Function introduced in this release.</td></tr> + Function introduced in this release.</td></tr> </table></ul> </dl> @@ -717,7 +719,7 @@ Describes HDF5 Release 1.6.5, November 2005 </address> <!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 6 February 2006"); +document.writeln("Last modified: 12 October 2006"); --> </SCRIPT> diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 6c1639d..5f9e741 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -2156,7 +2156,7 @@ END SUBROUTINE h5pget_cache_f <td valign="top">OUT: Array to store the chunk dimensions.</td></tr> </table></ul> <dt><strong>Returns:</strong> - <dd>Returns chunk dimensionality successful; + <dd>Returns chunk dimensionality if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5pget_chunk_f <dd> @@ -6618,8 +6618,9 @@ END SUBROUTINE h5pset_chunk_f <dl> <dt><strong>Name:</strong> <a name="Property-SetDeflate">H5Pset_deflate</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Pset_deflate</code>(<em>hid_t</em> <code>plist</code>, - <em>int</em> <code>level</code> + <dd><em>herr_t</em> <code>H5Pset_deflate</code>( + <em>hid_t</em> <code>plist</code>, + <em>uint</em> <code>level</code> ) <dt><strong>Purpose:</strong> <dd>Sets compression method and compression level. @@ -6628,15 +6629,18 @@ END SUBROUTINE h5pset_chunk_f dataset creation property list to <code>H5D_COMPRESS_DEFLATE</code> and the compression level to <code>level</code>, which should be a value from zero to nine, inclusive. + <p> Lower compression levels are faster but result in less compression. + <p> This is the same algorithm as used by the GNU gzip program. <dt><strong>Parameters:</strong> <ul><table> <tr> - <td valign="top"><em>hid_t</em> <code>plist </code></td> - <td valign="top">IN: Identifier for the dataset creation property list.</td></tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for the dataset creation + property list.</td></tr> <tr> - <td valign="top"><em>int</em> <code>level</code></td> + <td valign="top"><em>uint</em> <code>level</code></td> <td valign="top">IN: Compression level.</td></tr> </table></ul> <dt><strong>Returns:</strong> @@ -10775,7 +10779,7 @@ Describes HDF5 Release 1.6.5, November 2005 </address> <!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 10 August 2006"); +document.writeln("Last modified: 12 October 2006"); --> </SCRIPT> diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 327e70f..4c9bde5 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -1048,13 +1048,15 @@ END SUBROUTINE h5tenum_insert_f <dl> <dt><strong>Name:</strong> <a name="Datatype-EnumNameOf">H5Tenum_nameof</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Tenum_nameof</code>(<em>hid_t</em> <code>type</code> + <dd><em>herr_t</em> <code>H5Tenum_nameof</code>( + <em>hid_t</em> <code>type</code>, <em>void</em> *<code>value</code>, <em>char</em> *<code>name</code>, <em>size_t</em> <code>size</code> ) <dt><strong>Purpose:</strong> - <dd>Returns the symbol name corresponding to a specified member of an enumeration datatype. + <dd>Returns the symbol name corresponding to a specified + member of an enumeration datatype. <dt><strong>Description:</strong> <dd><code>H5Tenum_nameof</code> finds the symbol name that corresponds to the specified <code>value</code> @@ -1069,17 +1071,18 @@ END SUBROUTINE h5tenum_insert_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top"><em>hid_t</em> <code>type</code></td> <td valign="top">IN: Enumeration datatype identifier.</td></tr> <tr> - <td valign="top"><em>void</em> *<code>value, </code></td> + <td valign="top"><em>void</em> *<code>value </code></td> <td valign="top">IN: Value of the enumeration datatype.</td></tr> <tr> - <td valign="top"><em>char</em> *<code>name</code>,</td> + <td valign="top"><em>char</em> *<code>name</code></td> <td valign="top">OUT: Buffer for output of the symbol name.</td></tr> <tr> - <td valign="top"><em>size_t</em> <code>size</code></td> - <td valign="top">IN: Anticipated size of the symbol name, in bytes (characters).</td></tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">IN: Anticipated size of the symbol name, + in bytes (characters).</td></tr> </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. @@ -1114,7 +1117,8 @@ END SUBROUTINE h5tenum_nameof_f <dl> <dt><strong>Name:</strong> <a name="Datatype-EnumValueOf">H5Tenum_valueof</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Tenum_valueof</code>(<em>hid_t</em> <code>type</code> + <dd><em>herr_t</em> <code>H5Tenum_valueof</code>( + <em>hid_t</em> <code>type</code>, <em>char</em> *<code>name</code>, <em>void</em> *<code>value</code> ) @@ -1131,14 +1135,16 @@ END SUBROUTINE h5tenum_nameof_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top"><em>hid_t</em> <code>type</code></td> <td valign="top">IN: Enumeration datatype identifier.</td></tr> <tr> - <td valign="top"><em>const char</em> *<code>name, </code></td> - <td valign="top">IN: Symbol name of the enumeration datatype.</td></tr> + <td valign="top"><em>const char</em> *<code>name </code></td> + <td valign="top">IN: Symbol name of the enumeration + datatype.</td></tr> <tr> - <td valign="top"><em>void</em> *<code>value</code>,</td> - <td valign="top">OUT: Buffer for output of the value of the enumeration datatype.</td></tr> + <td valign="top"><em>void</em> *<code>value</code></td> + <td valign="top">OUT: Buffer for output of the value + of the enumeration datatype.</td></tr> </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; |