diff options
author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2024-01-18 17:03:43 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-18 17:03:43 (GMT) |
commit | 5ae4ecc1f20659b3abffcc4098a91e085173017b (patch) | |
tree | ff386d0a01c495d81703b5a8baa1baa6ea32729d /src/H5Ppublic.h | |
parent | b72cc4f7f4efead63c3a2582ce472ce8a5b5b0ae (diff) | |
download | hdf5-5ae4ecc1f20659b3abffcc4098a91e085173017b.zip hdf5-5ae4ecc1f20659b3abffcc4098a91e085173017b.tar.gz hdf5-5ae4ecc1f20659b3abffcc4098a91e085173017b.tar.bz2 |
Clean up Doxygen for szip functions and constants (#3943)
Diffstat (limited to 'src/H5Ppublic.h')
-rw-r--r-- | src/H5Ppublic.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index c6a780f..df0ede1 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -6857,7 +6857,7 @@ H5_DLL herr_t H5Pset_scaleoffset(hid_t plist_id, H5Z_SO_scale_type_t scale_type, * Valid values are #H5_SZIP_EC_OPTION_MASK and * #H5_SZIP_NN_OPTION_MASK. * \param[in] pixels_per_block The number of pixels or data elements in each - * data block + * data block (max #H5_SZIP_MAX_PIXELS_PER_BLOCK) * * \return \herr_t * @@ -6892,7 +6892,7 @@ H5_DLL herr_t H5Pset_scaleoffset(hid_t plist_id, H5Z_SO_scale_type_t scale_type, * <table> * <tr> * <th>Option</th> - * <th>Description (Mutually exclusive; select one.)</th> + * <th>Description (Mutually exclusive; select one)</th> * </tr> * <tr> * <td>#H5_SZIP_EC_OPTION_MASK</td> @@ -6900,7 +6900,7 @@ H5_DLL herr_t H5Pset_scaleoffset(hid_t plist_id, H5Z_SO_scale_type_t scale_type, * </tr> * <tr> * <td>#H5_SZIP_NN_OPTION_MASK</td> - * <td>Selects nearest neighbor coding method</td> + * <td>Selects nearest neighbor preprocessing followed by entropy coding</td> * </tr> * </table> * @@ -6948,9 +6948,10 @@ H5_DLL herr_t H5Pset_scaleoffset(hid_t plist_id, H5Z_SO_scale_type_t scale_type, * conflict can be detected only when the property list is used. * - Users should be aware that there are factors that affect one's * rights and ability to use SZIP compression by reviewing the - * SZIP copyright notice. + * SZIP copyright notice. (This limitation does not apply to the + * libaec library). * - * \note \b For \b Users \b Familiar \b with \b SZIP \b in \b Other \b Contexts: + * \note <b> For Users Familiar with SZIP in Other Contexts: </b> * * \note The following notes are of interest primarily to those who have * used SZIP compression outside of the HDF5 context. |