From 736ccba76761b9c096949d728057157943314f93 Mon Sep 17 00:00:00 2001 From: Larry Knox Date: Sun, 2 Jun 2024 15:27:27 -0500 Subject: [PATCH] Fix a few function names in USAGE comments that don't match the actual (#4533) * Fix a few function names in USAGE comments that don't match the actual function names. * Remove typo '[' * Switch to working url for api-compatibility-macros.html. --- src/H5A.c | 2 +- src/H5FO.c | 9 +++++---- src/H5Sselect.c | 12 ++++++------ 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/src/H5A.c b/src/H5A.c index 129dd5f0de9..651ed13c256 100644 --- a/src/H5A.c +++ b/src/H5A.c @@ -1880,7 +1880,7 @@ H5Aiterate2(hid_t loc_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *i PURPOSE Calls a user's function for each attribute on an object USAGE - herr_t H5Aiterate2(loc_id, obj_name, idx_type, order, idx, op, op_data, lapl_id) + herr_t H5Aiterate_by_name(loc_id, obj_name, idx_type, order, idx, op, op_data, lapl_id) hid_t loc_id; IN: Base location for object const char *obj_name; IN: Name of object relative to location H5_index_t idx_type; IN: Type of index to use diff --git a/src/H5FO.c b/src/H5FO.c index 534acbe6905..74daa7b55b0 100644 --- a/src/H5FO.c +++ b/src/H5FO.c @@ -136,7 +136,7 @@ H5FO_opened(const H5F_t *f, haddr_t addr) PURPOSE Insert a newly opened object/pointer pair into the opened object info set USAGE - herr_t H5FO_insert(f,addr,obj) + herr_t H5FO_insert(f,addr,obj,delete_flag) H5F_t *f; IN/OUT: File's opened object info set haddr_t addr; IN: Address of object to insert void *obj; IN: Pointer to object to insert @@ -239,9 +239,10 @@ H5FO_delete(H5F_t *f, haddr_t addr) PURPOSE Mark an object to be deleted when it is closed USAGE - herr_t H5FO_mark(f,addr) + herr_t H5FO_mark(f,addr,deleted) const H5F_t *f; IN: File opened object is in haddr_t addr; IN: Address of object to delete + bool deleted; IN: true for to be deleted RETURNS Returns a non-negative ID for the object on success, negative on failure @@ -366,7 +367,7 @@ H5FO_dest(const H5F_t *f) PURPOSE Create the "top" open object count set USAGE - herr_t H5FO_create(f) + herr_t H5FO_top_create(f) H5F_t *f; IN/OUT: File to create opened object count set for RETURNS @@ -509,7 +510,7 @@ H5FO_top_decr(const H5F_t *f, haddr_t addr) PURPOSE Return the "top" reference count for an object in a file USAGE - hsize_t H5FO_top_incr(f, addr) + hsize_t H5FO_top_count(f, addr) H5F_t *f; IN/OUT: File's opened object info set haddr_t addr; IN: Address of object to increment diff --git a/src/H5Sselect.c b/src/H5Sselect.c index fb2927f3c3b..5625de3aab4 100644 --- a/src/H5Sselect.c +++ b/src/H5Sselect.c @@ -413,7 +413,7 @@ H5S_get_select_npoints(const H5S_t *space) Check whether the selection fits within the extent, with the current offset defined. USAGE - htri_t H5Sselect_void(dsid) + htri_t H5Sselect_valid(dsid) hid_t dsid; IN: Dataspace ID to query RETURNS true if the selection fits within the extent, false if it does not and @@ -451,7 +451,7 @@ H5Sselect_valid(hid_t spaceid) Check whether the selection fits within the extent, with the current offset defined. USAGE - htri_t H5S_select_void(space) + htri_t H5S_select_valid(space) H5S_t *space; IN: Dataspace to query RETURNS true if the selection fits within the extent, false if it does not and @@ -921,7 +921,7 @@ H5S_select_adjust_u(H5S_t *space, const hsize_t *offset) PURPOSE Adjust a selection by subtracting an offset USAGE - herr_t H5S_select_adjust_u(space, offset) + herr_t H5S_select_adjust_s(space, offset) H5S_t *space; IN/OUT: Pointer to dataspace to adjust const hssize_t *offset; IN: Offset to subtract RETURNS @@ -2786,8 +2786,8 @@ H5S_select_subtract(H5S_t *space, H5S_t *subtract_space) PURPOSE Create a dataspace selection iterator for a dataspace's selection USAGE - hid_t H5Ssel_iter_create(space) - hid_t space; IN: ID of the dataspace with selection to iterate over + hid_t H5Ssel_iter_create(space,elmt_size,flags) + hid_t space; IN: ID of the dataspace with selection to iterate over RETURNS Valid dataspace selection iterator ID on success, H5I_INVALID_HID on failure DESCRIPTION @@ -2997,7 +2997,7 @@ H5S_select_contig_block(H5S_t *space, bool *is_contig, hsize_t *off, size_t *len PURPOSE Resets a dataspace selection iterator back to an initial state. USAGE - herr_t H5Ssel_iter_reset(sel_iter_id) + herr_t H5Ssel_iter_reset(sel_iter_id,space_id) hid_t sel_iter_id; IN: ID of the dataspace selection iterator to reset hid_t space_id; IN: ID of the dataspace with selection to