summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLarry Knox <lrknox@hdfgroup.org>2023-03-15 23:14:48 (GMT)
committerGitHub <noreply@github.com>2023-03-15 23:14:48 (GMT)
commitf24debb1a2602b424744acafa939e74350a842f7 (patch)
tree22c9b9c45fd6827b0305e6d3f3969636e9a040cb
parent0491aba7d2c11750ac3101083b2e073c5e3e4dc1 (diff)
downloadhdf5-f24debb1a2602b424744acafa939e74350a842f7.zip
hdf5-f24debb1a2602b424744acafa939e74350a842f7.tar.gz
hdf5-f24debb1a2602b424744acafa939e74350a842f7.tar.bz2
Remove redundant and flawed documentation of H5D_chunk_iter_op_t from H5D.c (#2512) (#2566)
Forward port of 9f252f1 from #2329 Co-authored-by: Mark Kittisopikul <mkitti@users.noreply.github.com>
-rw-r--r--src/H5D.c26
1 files changed, 0 insertions, 26 deletions
diff --git a/src/H5D.c b/src/H5D.c
index 006f4a9..ee6e0f3 100644
--- a/src/H5D.c
+++ b/src/H5D.c
@@ -2510,32 +2510,6 @@ done:
* H5D_chunk_iter_op_t cb IN: User callback function, called for every chunk.
* void *op_data IN/OUT: Optional user data passed on to user callback.
*
- * Callback information:
- * H5D_chunk_iter_op_t is defined as:
- *
- * typedef int (*H5D_chunk_iter_op_t)(
- * const hsize_t *offset,
- * unsigned filter_mask,
- * haddr_t addr,
- * hsize_t size,
- * void *op_data);
- *
- * H5D_chunk_iter_op_t parameters:
- * hsize_t *offset; IN/OUT: Logical position of the chunk’s first element in units of dataset
- * elements
- * unsigned filter_mask; IN: Bitmask indicating the filters used when the chunk was written haddr_t
- * addr; IN: Chunk address in the file
- * hsize_t; IN: Chunk size in bytes, 0 if the chunk does not exist
- * void *op_data; IN/OUT: Pointer to any user-defined data associated with the operation.
- *
- * The return values from an operator are:
- * Zero (H5_ITER_CONT) causes the iterator to continue, returning zero when all
- * elements have been processed.
- * Positive (H5_ITER_STOP) causes the iterator to immediately return that positive
- * value, indicating short-circuit success.
- * Negative (H5_ITER_ERROR) causes the iterator to immediately return that value,
- * indicating failure.
- *
* Return: Non-negative on success, negative on failure
*
* Programmer: Gaute Hope