Update javadoc comments to reduce warnings (#41)

1 files changed, 23 insertions, 2 deletions

diff --git a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java
index f92fbc4..d08001a 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java
@@ -15,7 +15,28 @@ package hdf.hdf5lib.callbacks;
 
 import hdf.hdf5lib.structs.H5L_info_t;
 
-// Information class for link callback (for H5Lvisit/H5Lvisit_by_name).
+/**
+ * Information class for link callback for H5Lvisit/H5Lvisit_by_name.
+ *
+ */
 public interface H5L_iterate_t extends Callbacks {
-    int callback(long group, String name, H5L_info_t info, H5L_iterate_opdata_t op_data);
+    /**
+     *  application callback for each group
+     *
+     *  @param loc_id    the ID for the group being iterated over
+     *  @param name      the name of the current link
+     *  @param info      the link's "info" struct
+     *  @param op_data   the operator data passed in to H5Literate
+     *
+     *  @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, H5L_info_t info, H5L_iterate_opdata_t op_data);
 }