diff options
author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2023-05-06 22:35:55 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-06 22:35:55 (GMT) |
commit | 6162b6f12e40a50937ac4a94661d81cf03a04c65 (patch) | |
tree | 16a7f1375c41482f5e638c42bfa3cc9ccfc43431 | |
parent | 4b228ec6af3c53956fba7822c0ae808d3d3e2cb3 (diff) | |
download | hdf5-6162b6f12e40a50937ac4a94661d81cf03a04c65.zip hdf5-6162b6f12e40a50937ac4a94661d81cf03a04c65.tar.gz hdf5-6162b6f12e40a50937ac4a94661d81cf03a04c65.tar.bz2 |
Add Doxygen for H5S_ALL, _PLIST, and _BLOCK (#2921)
Fixes #688
-rw-r--r-- | src/H5Spublic.h | 27 |
1 files changed, 24 insertions, 3 deletions
diff --git a/src/H5Spublic.h b/src/H5Spublic.h index bd5a82c..d177e16 100644 --- a/src/H5Spublic.h +++ b/src/H5Spublic.h @@ -21,9 +21,30 @@ #include "H5Ipublic.h" /* Define special dataspaces for dataset I/O operations */ -#define H5S_ALL 0 /* (hid_t) */ -#define H5S_BLOCK 1 /* (hid_t) */ -#define H5S_PLIST 2 /* (hid_t) */ + +/** + * Used with @ref H5Dread and @ref H5Dwrite to indicate that the entire + * dataspace will be selected. In the case of a file dataspace, this means + * that the entire file dataspace, as defined by the dataset's dimensions, + * will be selected. In the case of a memory dataspace, this means that + * the specified file dataspace will also be used for the memory dataspace. + * Used in place of a file or memory dataspace @ref hid_t value. + */ +#define H5S_ALL 0 + +/** + * Indicates that the buffer provided in a call to @ref H5Dread or @ref H5Dwrite + * is a single contiguous block of memory, with the same number of elements + * as the file dataspace. Used in place of a memory dataspace @ref hid_t value. + */ +#define H5S_BLOCK 1 + +/** + * Used with @ref H5Dread and @ref H5Dwrite to indicate that the file dataspace + * selection was set via @ref H5Pset_dataset_io_hyperslab_selection calls. + * Used in place of a file dataspace @ref hid_t value. + */ +#define H5S_PLIST 2 #define H5S_UNLIMITED HSIZE_UNDEF /**< Value for 'unlimited' dimensions */ |