summaryrefslogtreecommitdiffstats
path: root/src/H5Ppublic.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/H5Ppublic.h')
-rw-r--r--src/H5Ppublic.h17
1 files changed, 11 insertions, 6 deletions
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h
index 1b5d2f4..903d549 100644
--- a/src/H5Ppublic.h
+++ b/src/H5Ppublic.h
@@ -3360,8 +3360,9 @@ H5_DLL herr_t H5Pget_core_write_tracking(hid_t fapl_id, hbool_t *is_enabled, siz
*
* Valid driver identifiers distributed with HDF5 are listed and
* described in the following table.
- *
+ * <div>
* \snippet{doc} tables/fileDriverLists.dox supported_file_driver_table
+ * </div>
*
* This list does not include custom drivers that might be
* defined and registered by a user.
@@ -6392,6 +6393,9 @@ H5_DLL herr_t H5Pset_dset_no_attrs_hint(hid_t dcpl_id, hbool_t minimize);
* when H5Dwrite() is called to write data to it, the library
* will create the file.
*
+ * \note On Windows, off_t is typically a 32-bit signed long value, which
+ * limits the valid offset that can be set to 2 GiB.
+ *
* \since 1.0.0
*
*/
@@ -6772,7 +6776,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
*
@@ -6807,7 +6811,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>
@@ -6815,7 +6819,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>
*
@@ -6863,9 +6867,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.