diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2021-11-17 05:13:59 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-17 05:13:59 (GMT) |
commit | b823ddc52636596a886c9cc8424142b7c28a1b29 (patch) | |
tree | 377861e61b68d5c1d6536d1dc7f87ee24a4ca758 /java/src/hdf/hdf5lib/exceptions/package-info.java | |
parent | 28e92647f08aed7b875576ecf552a2204f259e8d (diff) | |
download | hdf5-b823ddc52636596a886c9cc8424142b7c28a1b29.zip hdf5-b823ddc52636596a886c9cc8424142b7c28a1b29.tar.gz hdf5-b823ddc52636596a886c9cc8424142b7c28a1b29.tar.bz2 |
Add javadoc to packages - HDFFV-11285 (#1197)
Diffstat (limited to 'java/src/hdf/hdf5lib/exceptions/package-info.java')
-rw-r--r-- | java/src/hdf/hdf5lib/exceptions/package-info.java | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/java/src/hdf/hdf5lib/exceptions/package-info.java b/java/src/hdf/hdf5lib/exceptions/package-info.java new file mode 100644 index 0000000..8640ccb --- /dev/null +++ b/java/src/hdf/hdf5lib/exceptions/package-info.java @@ -0,0 +1,31 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * Copyright by The HDF Group. * + * * + * All rights reserved. * + * * + * This file is part of HDF5. The full HDF5 copyright notice, including * + * terms governing use, modification, and redistribution, is contained in * + * the COPYING file, which can be found at the root of the source code * + * distribution tree, or in https://www.hdfgroup.org/licenses. * + * If you do not have access to either file, you may request a copy from * + * help@hdfgroup.org. * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +/** + * <p> + * The package exceptions contains error classes for the Java HDF5 Interface. + * <p> + * There are two sub-classes of exceptions defined: + * <ol> + * <li> + * HDF5LibraryException -- errors raised the HDF5 library code + * <li> + * HDF5JavaException -- errors raised the HDF5 Java wrapper code + * </ol> + * <p> + * The HDF5LibraryException is the base class for the classes that represent specific error conditions. + * In particular, HDF5LibraryException has a sub-class for each major + * error code returned by the HDF5 library. + * + */ +package hdf.hdf5lib.exceptions;
\ No newline at end of file |