summaryrefslogtreecommitdiffstats
path: root/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2020-10-16 16:10:35 (GMT)
committerGitHub <noreply@github.com>2020-10-16 16:10:35 (GMT)
commit9bd2102b7747b255b570d428399151296baa17d1 (patch)
treeec69c69944fba94f3586c804b36091fa88d76b0c /java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java
parente6cda4817b303e2f984a31a8c20dd12f326772c5 (diff)
downloadhdf5-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/H5P_prp_copy_func_cb.java')
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java22
1 files changed, 21 insertions, 1 deletions
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java
index 57994bb5..59e4bb8 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java
@@ -13,7 +13,27 @@
package hdf.hdf5lib.callbacks;
-//Information class for link callback(for H5Pregister2)
+/**
+ * Information class for link callback for H5Pregister2.
+ *
+ */
public interface H5P_prp_copy_func_cb extends Callbacks {
+ /**
+ * application callback for each property list
+ *
+ * @param name the name of the property being copied
+ * @param size the size of the property value
+ * @param value the value of the property being copied
+ *
+ * @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(String name, long size, byte[] value);
}