added valid flags for h5ssel_iter_create in docs

brtnfld · Jan 19, 2024 · 974e66e · 974e66e
1 parent 4123b46
commit 974e66e
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 15 deletions.
diff --git a/configure.ac b/configure.ac
@@ -13,7 +13,7 @@
 ## ----------------------------------------------------------------------
 ## Initialize configure.
 ##
-AC_PREREQ([2.71])
+AC_PREREQ([2.69])
 
 ## AC_INIT takes the name of the package, the version number, and an
 ## email address to report bugs. AC_CONFIG_SRCDIR takes a unique file

diff --git a/fortran/src/H5Sff.F90 b/fortran/src/H5Sff.F90
@@ -1479,7 +1479,9 @@ END SUBROUTINE h5ssel_iter_close_f
 !!
 !! \param space_id    Dataspace identifier
 !! \param elmt_size   Size of element in the selection
-!! \param flags       Selection iterator flag
+!! \param flags       Selection iterator flag, valid values are:
+!!                    \li H5S_SEL_ITER_GET_SEQ_LIST_SORTED_F, ref. @ref H5S_SEL_ITER_GET_SEQ_LIST_SORTED
+!!                    \li H5S_SEL_ITER_SHARE_WITH_DATASPACE_F, ref. @ref H5S_SEL_ITER_SHARE_WITH_DATASPACE
 !! \param ds_iter_id  Dataspace selection iterator identifier
 !! \param hdferr      \fortran_error
 !!

diff --git a/src/H5Spublic.h b/src/H5Spublic.h
@@ -54,19 +54,19 @@
 
 /* Flags for selection iterators */
 #define H5S_SEL_ITER_GET_SEQ_LIST_SORTED                                                                     \
-    0x0001 /**< Retrieve elements from iterator in increasing offset order, for                              \
-            * each call to retrieve sequences. Currently, this only applies to                               \
-            * point selections, as hyperslab selections are always returned in                               \
-            * increasing offset order. Note that the order is only increasing                                \
-            * for each call to H5Sget_seq_list(), the next set of sequences                                  \
-            * could start with an earlier offset than the previous one.                                      \
+    0x0001 /**< Retrieve elements from iterator in increasing offset order, for
+            * each call to retrieve sequences. Currently, this only applies to
+            * point selections, as hyperslab selections are always returned in
+            * increasing offset order. Note that the order is only increasing
+            * for each call to H5Sget_seq_list(), the next set of sequences
+            * could start with an earlier offset than the previous one.
             */
 #define H5S_SEL_ITER_SHARE_WITH_DATASPACE                                                                    \
-    0x0002 /**< Don't copy the dataspace selection when creating the selection                               \
-            * iterator. This can improve performance of creating the iterator,                               \
-            * but the dataspace \Bold{MUST NOT} be modified or closed until the                              \
-            * selection iterator is closed or the iterator's behavior will be                                \
-            * undefined.                                                                                     \
+    0x0002 /**< Don't copy the dataspace selection when creating the selection
+            * iterator. This can improve performance of creating the iterator,
+            * but the dataspace \Bold{MUST NOT} be modified or closed until the
+            * selection iterator is closed or the iterator's behavior will be
+            * undefined.
             */
 
 /**
@@ -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