diff options
Diffstat (limited to 'java/src/hdf/hdf5lib/callbacks')
19 files changed, 40 insertions, 1 deletions
diff --git a/java/src/hdf/hdf5lib/callbacks/Callbacks.java b/java/src/hdf/hdf5lib/callbacks/Callbacks.java index 86d6193..3d5fbd1 100644 --- a/java/src/hdf/hdf5lib/callbacks/Callbacks.java +++ b/java/src/hdf/hdf5lib/callbacks/Callbacks.java @@ -13,6 +13,7 @@ package hdf.hdf5lib.callbacks; /** + * @page CALLBACKS HDF5 Java Callbacks Interface * All callback definitions must derive from this interface. Any * derived interfaces must define a single public method named "callback". * You are responsible for deregistering your callback (if necessary) @@ -20,11 +21,14 @@ package hdf.hdf5lib.callbacks; * a callback which has been GC'd, you will likely crash the VM. If * there is no method to deregister the callback (e.g. <code>atexit</code> * in the C library), you must ensure that you always keep a live reference - * to the callback object.<p> + * to the callback object. + * * A callback should generally never throw an exception, since it doesn't * necessarily have an encompassing Java environment to catch it. Any * exceptions thrown will be passed to the default callback exception * handler. + * + * @defgroup JCALL HDF5 Library Java Callbacks */ public interface Callbacks { } diff --git a/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java index 6c68f36..9958b3b 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java @@ -20,6 +20,8 @@ import hdf.hdf5lib.structs.H5A_info_t; */ public interface H5A_iterate_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each attribute * * @param loc_id the ID for the group or dataset being iterated over diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java index cf7ada6..49323a2 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5D_append_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each dataset access property list * * @param dataset_id the ID for the dataset being iterated over diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java index 54c12e3..5f77998 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5D_iterate_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each dataset element * * @param elem the pointer to the element in memory containing the current point diff --git a/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java b/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java index 5722195..a8ef5df 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java @@ -20,6 +20,8 @@ import hdf.hdf5lib.structs.H5E_error2_t; */ public interface H5E_walk_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each error stack element * * @param nidx the index of the current error stack element diff --git a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java index 53635bf..7342e58 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java +++ b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java @@ -20,6 +20,8 @@ import hdf.hdf5lib.structs.H5L_info_t; */ public interface H5L_iterate_t extends Callbacks { /** + * @ingroup JCALL + * * application callback for each group * * @param loc_id the ID for the group being iterated over diff --git a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java index ecf868c..bfe8c67 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java +++ b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java @@ -20,6 +20,8 @@ import hdf.hdf5lib.structs.H5O_info_t; */ public interface H5O_iterate_t extends Callbacks { /** + * @ingroup JCALL + * * application callback for each group * * @param loc_id the ID for the group or dataset being iterated over diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java index 0a09a94..a235861 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_cls_close_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param prop_id the ID for the property list class being iterated over diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java index 53f86be..b218e0c 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_cls_copy_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param new_prop_id the ID for the property list copy diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java index 8f4e782..3d407d0 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_cls_create_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param prop_id the ID for the property list class being iterated over diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java index db98a67..51a5768 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_iterate_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param plist the ID for the property list being iterated over diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java index 1aa7ce4..2ddc980 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_prp_close_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param name the name of the property being closed diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java index 49cef7d..53caa94 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_prp_compare_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param value1 the value of the first property being compared 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 f4924ee..0b2349e 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 @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_prp_copy_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param name the name of the property being copied diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java index bce024b..6065ce0 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_prp_create_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param name the name of the property list being created diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java index 8c5dccc..4384ca7 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_prp_delete_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param prop_id the ID of the property list the property is deleted from diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java index 0f3457f..999c7b0 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_prp_get_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param prop_id the ID for the property list being queried diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java index a55ca3a..893344b 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java @@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks; */ public interface H5P_prp_set_func_cb extends Callbacks { /** + * @ingroup JCALL + * * application callback for each property list * * @param prop_id the ID for the property list being modified diff --git a/java/src/hdf/hdf5lib/callbacks/package-info.java b/java/src/hdf/hdf5lib/callbacks/package-info.java index 114045c..5ef3fab 100644 --- a/java/src/hdf/hdf5lib/callbacks/package-info.java +++ b/java/src/hdf/hdf5lib/callbacks/package-info.java @@ -12,6 +12,7 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /** + * @page CALLBACKS_UG HDF5 Java Callbacks Interface * All callback definitions must derive from the Callbacks interface. Any * derived interfaces must define a single public method named "callback". * You are responsible for deregistering your callback (if necessary) |