summaryrefslogtreecommitdiffstats
path: root/src/H5Spublic.h
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2024-01-23 15:59:10 (GMT)
committerGitHub <noreply@github.com>2024-01-23 15:59:10 (GMT)
commit54fb80938256f565210d4c22b3021d6b96d0f56a (patch)
tree5505902a82af9699b5adbd54ff9870e95b2ff207 /src/H5Spublic.h
parent51f150a94590f3b495d32c44f6d507eb5a7565a0 (diff)
downloadhdf5-54fb80938256f565210d4c22b3021d6b96d0f56a.zip
hdf5-54fb80938256f565210d4c22b3021d6b96d0f56a.tar.gz
hdf5-54fb80938256f565210d4c22b3021d6b96d0f56a.tar.bz2
Fortran API work. (#3941)
* - Added Fortran APIs: H5FGET_INTENT_F, H5SSELECT_ITER_CREATE_F, H5SSEL_ITER_GET_SEQ_LIST_F, H5SSELECT_ITER_CLOSE_F, H5S_mp_H5SSELECT_ITER_RESET_F - Added Fortran Parameters: H5S_SEL_ITER_GET_SEQ_LIST_SORTED_F, H5S_SEL_ITER_SHARE_WITH_DATASPACE_F - Added tests for new APIs - Removed H5F C wrapper stubs - Documentation misc. cleanup.
Diffstat (limited to 'src/H5Spublic.h')
-rw-r--r--src/H5Spublic.h21
1 files changed, 11 insertions, 10 deletions
diff --git a/src/H5Spublic.h b/src/H5Spublic.h
index 2b6384f..5422d96 100644
--- a/src/H5Spublic.h
+++ b/src/H5Spublic.h
@@ -848,7 +848,7 @@ H5_DLL herr_t H5Soffset_simple(hid_t space_id, const hssize_t *offset);
*
* \brief Closes a dataspace selection iterator
*
- * \space_id{sel_iter_id}
+ * \param[in] sel_iter_id Identifier of the dataspace selection iterator
*
* \return \herr_t
*
@@ -865,8 +865,9 @@ H5_DLL herr_t H5Ssel_iter_close(hid_t sel_iter_id);
*
* \space_id{spaceid}
* \param[in] elmt_size Size of element in the selection
- * \param[in] flags Selection iterator flag
- *
+ * \param[in] flags Selection iterator flag, valid values are:
+ * \li @ref H5S_SEL_ITER_GET_SEQ_LIST_SORTED
+ * \li @ref H5S_SEL_ITER_SHARE_WITH_DATASPACE
* \return \hid_t{valid dataspace selection iterator}
*
* \details H5Ssel_iter_create() creates a selection iterator and initializes
@@ -882,13 +883,13 @@ H5_DLL hid_t H5Ssel_iter_create(hid_t spaceid, size_t elmt_size, unsigned flags)
* \brief Retrieves a list of offset / length sequences for the elements in
* an iterator
*
- * \space_id{sel_iter_id}
- * \param[in] maxseq Maximum number of sequences to retrieve
- * \param[in] maxelmts Maximum number of elements to retrieve in sequences
- * \param[out] nseq Number of sequences retrieved
- * \param[out] nelmts Number of elements retrieved, in all sequences
- * \param[out] off Array of sequence offsets
- * \param[out] len Array of sequence lengths
+ * \param[in] sel_iter_id Identifier of the dataspace selection iterator
+ * \param[in] maxseq Maximum number of sequences to retrieve
+ * \param[in] maxelmts Maximum number of elements to retrieve in sequences
+ * \param[out] nseq Number of sequences retrieved
+ * \param[out] nelmts Number of elements retrieved, in all sequences
+ * \param[out] off Array of sequence offsets
+ * \param[out] len Array of sequence lengths
*
* \return \herr_t
*