summaryrefslogtreecommitdiffstats
path: root/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/src/hdf/hdf5lib/exceptions/HDF5Exception.java')
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5Exception.java18
1 files changed, 13 insertions, 5 deletions
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java b/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java
index b098a12..ad42644 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java
@@ -14,21 +14,23 @@
package hdf.hdf5lib.exceptions;
/**
- * <p>
+ * @page ERRORS Errors and Exceptions
* The class HDF5Exception returns errors from the Java HDF5 Interface.
- * <p>
+ *
* Two sub-classes of HDF5Exception are defined:
* <ol>
* <li>
- * HDF5LibraryException -- errors raised the HDF5 library code
+ * HDF5LibraryException -- errors raised by the HDF5 library code
* <li>
- * HDF5JavaException -- errors raised the HDF5 Java wrapper code
+ * HDF5JavaException -- errors raised by the HDF5 Java wrapper code
* </ol>
- * <p>
+ *
* These exceptions are sub-classed to represent specific error conditions, as
* needed. In particular, HDF5LibraryException has a sub-class for each major
* error code returned by the HDF5 library.
*
+ * @defgroup JERR HDF5 Library Exception Interface
+ *
*/
public class HDF5Exception extends RuntimeException {
/**
@@ -37,12 +39,16 @@ public class HDF5Exception extends RuntimeException {
protected String detailMessage;
/**
+ * @ingroup JERR
+ *
* Constructs an <code>HDF5Exception</code> with no specified detail
* message.
*/
public HDF5Exception() { super(); }
/**
+ * @ingroup JERR
+ *
* Constructs an <code>HDF5Exception</code> with the specified detail
* message.
*
@@ -56,6 +62,8 @@ public class HDF5Exception extends RuntimeException {
}
/**
+ * @ingroup JERR
+ *
* Returns the detail message of this exception
*
* @return the detail message or <code>null</code> if this object does not