diff options
author | Mark Kittisopikul <mkitti@users.noreply.github.com> | 2023-03-08 20:46:47 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-03-08 20:46:47 (GMT) |
commit | 9884e189acf391f43b6112af912d48cdd30802e8 (patch) | |
tree | d31668b7bf3970699effc73b27b5149c9fe5b719 /src/H5D.c | |
parent | 5d3d43b1ee8db30e8e04705eb529e09e992cf922 (diff) | |
download | hdf5-9884e189acf391f43b6112af912d48cdd30802e8.zip hdf5-9884e189acf391f43b6112af912d48cdd30802e8.tar.gz hdf5-9884e189acf391f43b6112af912d48cdd30802e8.tar.bz2 |
Remove redundant and flawed documentation of H5D_chunk_iter_op_t from H5D.c (#2512)
Forward port of 9f252f1 from #2329
Diffstat (limited to 'src/H5D.c')
-rw-r--r-- | src/H5D.c | 26 |
1 files changed, 0 insertions, 26 deletions
@@ -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 |