diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2020-10-16 16:10:35 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-16 16:10:35 (GMT) |
commit | 9bd2102b7747b255b570d428399151296baa17d1 (patch) | |
tree | ec69c69944fba94f3586c804b36091fa88d76b0c /java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java | |
parent | e6cda4817b303e2f984a31a8c20dd12f326772c5 (diff) | |
download | hdf5-9bd2102b7747b255b570d428399151296baa17d1.zip hdf5-9bd2102b7747b255b570d428399151296baa17d1.tar.gz hdf5-9bd2102b7747b255b570d428399151296baa17d1.tar.bz2 |
Update javadoc comments to reduce warnings (#41)
Diffstat (limited to 'java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java')
-rw-r--r-- | java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java | 25 |
1 files changed, 23 insertions, 2 deletions
diff --git a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java index 9a55106..e627775 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java +++ b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java @@ -15,7 +15,28 @@ package hdf.hdf5lib.callbacks; import hdf.hdf5lib.structs.H5O_info_t; -// Information class for link callback(for H5Ovisit/H5Ovisit_by_name) +/** + * Information class for link callback for H5Ovisit/H5Ovisit_by_name. + * + */ public interface H5O_iterate_t extends Callbacks { - int callback(long group, String name, H5O_info_t info, H5O_iterate_opdata_t op_data); + /** + * application callback for each group + * + * @param loc_id the ID for the group or dataset being iterated over + * @param name the name of the current object + * @param info the object's "info" struct + * @param op_data the operator data passed in to H5Oiterate + * + * @return operation status + * A. Zero causes the iterator to continue, returning zero when all + * attributes have been processed. + * B. Positive causes the iterator to immediately return that positive + * value, indicating short-circuit success. The iterator can be + * restarted at the next attribute. + * C. Negative causes the iterator to immediately return that value, + * indicating failure. The iterator can be restarted at the next + * attribute. + */ + int callback(long loc_id, String name, H5O_info_t info, H5O_iterate_opdata_t op_data); } |