summaryrefslogtreecommitdiffstats
path: root/src/H5Ppublic.h
diff options
context:
space:
mode:
authorLarry Knox <lrknox@hdfgroup.org>2023-03-29 18:15:11 (GMT)
committerGitHub <noreply@github.com>2023-03-29 18:15:11 (GMT)
commitabdc160a97c78b01580308fe43204a202d3a6951 (patch)
tree92e828b43bc13be1560f531c9d1d964a5a963d39 /src/H5Ppublic.h
parentab1af79798985b57401596677f7db8eb186f55a1 (diff)
downloadhdf5-abdc160a97c78b01580308fe43204a202d3a6951.zip
hdf5-abdc160a97c78b01580308fe43204a202d3a6951.tar.gz
hdf5-abdc160a97c78b01580308fe43204a202d3a6951.tar.bz2
Minor cherry-pick merges to 1.12 (#2581)
Diffstat (limited to 'src/H5Ppublic.h')
-rw-r--r--src/H5Ppublic.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h
index 04b8f0e..33a1df9 100644
--- a/src/H5Ppublic.h
+++ b/src/H5Ppublic.h
@@ -2321,10 +2321,13 @@ H5_DLL herr_t H5Pset_deflate(hid_t plist_id, unsigned level);
* (#H5Z_FILTER_DEFLATE) and the Fletcher32 error detection filter
* (#H5Z_FILTER_FLETCHER32).
*
- * The array \p c_values contains \p cd_nelmts integers which are
- * auxiliary data for the filter. The integer values will be
- * stored in the dataset object header as part of the filter
- * information.
+ * The array \p cd_values contains \p cd_nelmts unsigned integers
+ * which are auxiliary data for the filter. The values are typically
+ * used as parameters to control the filter. In a filter's
+ * \p set_local method (called from \p H5Dcreate), the values are
+ * interpreted and possibly modified before they are used to control
+ * the filter. These, possibly modified values, are then stored in
+ * the dataset object header as auxiliary data for the filter.
*
* The \p flags argument is a bit vector with the following
* fields specifying certain general properties of the filter: