summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/H5Apublic.h3
-rw-r--r--src/H5Dpublic.h3
-rw-r--r--src/H5Gpublic.h18
-rw-r--r--src/H5Lpublic.h12
-rw-r--r--src/H5Mpublic.h3
5 files changed, 20 insertions, 19 deletions
diff --git a/src/H5Apublic.h b/src/H5Apublic.h
index 7ed2938..e21e808 100644
--- a/src/H5Apublic.h
+++ b/src/H5Apublic.h
@@ -392,6 +392,9 @@ H5_DLL herr_t H5Aexists_by_name_async(hid_t loc_id, const char *obj_name, const
* creation property list associated with the attribute specified
* by \p attr_id.
*
+ * The creation property list identifier should be released with
+ * H5Pclose() to prevent resource leaks.
+ *
* \since 1.8.0
*
*/
diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h
index fbce3d6..45b941a 100644
--- a/src/H5Dpublic.h
+++ b/src/H5Dpublic.h
@@ -501,6 +501,9 @@ H5_DLL hid_t H5Dget_type(hid_t dset_id);
* a copy of the dataset creation property list associated with
* the dataset specified by \p dset_id.
*
+ * The creation property list identifier should be released with
+ * H5Pclose() to prevent resource leaks.
+ *
*/
H5_DLL hid_t H5Dget_create_plist(hid_t dset_id);
diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h
index d6cebf3..ace2071 100644
--- a/src/H5Gpublic.h
+++ b/src/H5Gpublic.h
@@ -119,7 +119,7 @@ extern "C" {
*
* \since 1.8.0
*
- * \see H5Gopen2(), H5Gclose()
+ * \see H5Gopen2()
*
*/
H5_DLL hid_t H5Gcreate2(hid_t loc_id, const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id);
@@ -211,7 +211,7 @@ H5_DLL hid_t H5Gcreate_anon(hid_t loc_id, hid_t gcpl_id, hid_t gapl_id);
*
* \since 1.8.0
*
- * \see H5Gcreate2(), H5Gclose()
+ * \see H5Gcreate2()
*
*/
H5_DLL hid_t H5Gopen2(hid_t loc_id, const char *name, hid_t gapl_id);
@@ -242,12 +242,10 @@ H5_DLL hid_t H5Gopen_async(hid_t loc_id, const char *name, hid_t gapl_id, hid_t
* property list associated with the group specified by \p group_id.
*
* The creation property list identifier should be released with
- * H5Gclose() to prevent resource leaks.
+ * H5Pclose() to prevent resource leaks.
*
* \since 1.8.0
*
- * \see H5Gcreate2(), H5Gclose()
- *
*/
H5_DLL hid_t H5Gget_create_plist(hid_t group_id);
@@ -274,8 +272,6 @@ H5_DLL hid_t H5Gget_create_plist(hid_t group_id);
*
* \since 1.8.0
*
- * \see H5Gcreate2(), H5Gclose()
- *
*/
H5_DLL herr_t H5Gget_info(hid_t loc_id, H5G_info_t *ginfo);
@@ -320,8 +316,6 @@ H5_DLL herr_t H5Gget_info_async(hid_t loc_id, H5G_info_t *ginfo /*out*/, hid_t e
*
* \since 1.8.0
*
- * \see H5Gcreate2(), H5Gclose()
- *
*/
H5_DLL herr_t H5Gget_info_by_name(hid_t loc_id, const char *name, H5G_info_t *ginfo, hid_t lapl_id);
@@ -381,8 +375,6 @@ H5_DLL herr_t H5Gget_info_by_name_async(hid_t loc_id, const char *name, H5G_info
*
* \since 1.8.0
*
- * \see H5Gcreate2(), H5Gclose()
- *
*/
H5_DLL herr_t H5Gget_info_by_idx(hid_t loc_id, const char *group_name, H5_index_t idx_type,
H5_iter_order_t order, hsize_t n, H5G_info_t *ginfo, hid_t lapl_id);
@@ -426,8 +418,6 @@ H5_DLL herr_t H5Gget_info_by_idx_async(hid_t loc_id, const char *group_name, H5_
*
* \since 1.8.0
*
- * \see H5Gcreate2(), H5Gclose()
- *
*/
H5_DLL herr_t H5Gflush(hid_t group_id);
@@ -451,8 +441,6 @@ H5_DLL herr_t H5Gflush(hid_t group_id);
*
* \since 1.8.0
*
- * \see H5Gcreate2(), H5Gclose()
- *
*/
H5_DLL herr_t H5Grefresh(hid_t group_id);
diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h
index d2d9e9d..6feefcd 100644
--- a/src/H5Lpublic.h
+++ b/src/H5Lpublic.h
@@ -884,10 +884,12 @@ H5_DLL ssize_t H5Lget_name_by_idx(hid_t loc_id, const char *group_name, H5_index
* not been indexed by the index type, they will first be sorted by
* that index then the iteration will begin; if the links have been
* so indexed, the sorting step will be unnecessary, so the iteration
- * may begin more quickly.
+ * may begin more quickly. Valid values include the following:
+ * \indexes
*
* \p order specifies the order in which objects are to be inspected
- * along the index \p idx_type.
+ * along the index \p idx_type. Valid values include the following:
+ * \orders
*
* \p idx_p tracks the iteration and allows an iteration to be
* resumed if it was stopped before all members were processed. It is
@@ -1641,10 +1643,12 @@ H5_DLL herr_t H5Lget_info_by_idx1(hid_t loc_id, const char *group_name, H5_index
* not been indexed by the index type, they will first be sorted by
* that index then the iteration will begin; if the links have been
* so indexed, the sorting step will be unnecessary, so the iteration
- * may begin more quickly.
+ * may begin more quickly. Valid values include the following:
+ * \indexes
*
* \p order specifies the order in which objects are to be inspected
- * along the index \p idx_type.
+ * along the index \p idx_type. Valid values include the following:
+ * \orders
*
* \p idx_p tracks the iteration and allows an iteration to be
* resumed if it was stopped before all members were processed. It is
diff --git a/src/H5Mpublic.h b/src/H5Mpublic.h
index 2cea579..86fe433 100644
--- a/src/H5Mpublic.h
+++ b/src/H5Mpublic.h
@@ -352,6 +352,9 @@ H5_DLL hid_t H5Mget_val_type(hid_t map_id);
* \details H5Mget_create_plist() returns an identifier for a copy of the
* creation property list for a map object specified by \p map_id.
*
+ * The creation property list identifier should be released with
+ * H5Pclose() to prevent resource leaks.
+ *
* \since 1.12.0
*
*/