diff --git a/.github/workflows/daily-build.yml b/.github/workflows/daily-build.yml index 97648e77..cf4ea140 100644 --- a/.github/workflows/daily-build.yml +++ b/.github/workflows/daily-build.yml @@ -5,7 +5,7 @@ on: workflow_dispatch: inputs: use_ignore: - description: 'Ignore has changes check' + description: 'Ignore has_changes check' type: string required: false default: check diff --git a/.github/workflows/tarball.yml b/.github/workflows/tarball.yml index c745ddb5..f570b4b5 100644 --- a/.github/workflows/tarball.yml +++ b/.github/workflows/tarball.yml @@ -5,7 +5,7 @@ on: workflow_call: inputs: use_ignore: - description: 'Ignore has changes check' + description: 'Ignore has_changes check' type: string required: false default: check diff --git a/docs/UsersGuide/index.html b/docs/UsersGuide/index.html index 1be4b5e3..15d003cb 100644 --- a/docs/UsersGuide/index.html +++ b/docs/UsersGuide/index.html @@ -31,7 +31,7 @@ A brief discussion of the HDF object model (Details of the HDF object model are available from -HDF Object Package.) +HDF Object Package.) diff --git a/docs/UsersGuide/ug01introduction.html b/docs/UsersGuide/ug01introduction.html index 3e96d7d9..1aae76c5 100755 --- a/docs/UsersGuide/ug01introduction.html +++ b/docs/UsersGuide/ug01introduction.html @@ -57,7 +57,7 @@
Information about the HDFView tool and related products is available - from the HDF-Java Home page. + from the HDF-Java Home page.
diff --git a/docs/UsersGuide/ug02start.html b/docs/UsersGuide/ug02start.html index 7895e4eb..14c87151 100755 --- a/docs/UsersGuide/ug02start.html +++ b/docs/UsersGuide/ug02start.html @@ -176,8 +176,8 @@The structure of the file is displayed in the Tree panel, which is the left diff --git a/docs/UsersGuide/ug03objects.html b/docs/UsersGuide/ug03objects.html index b33c3b7b..355c4031 100755 --- a/docs/UsersGuide/ug03objects.html +++ b/docs/UsersGuide/ug03objects.html @@ -15,7 +15,7 @@
-This chapter provides basic information about the HDF Object Model. +This chapter provides basic information about the HDF Object Model.
@@ -105,7 +105,7 @@
For details, see the Java docs at -javadocs.
+javadocs.An HDF5 image is a dataset that conforms to the - + HDF5 Image Specification. HDFView supports two types of images: indexed and true color. Both indexed image and true color image have predefined attributes and data layout according to the HDF5 image specification. For more details about HDF5 image, see the - + HDF5 Image Specification.
HDFView displays HDF4 raster images or HDF5 datasets that follow the HDF5
-Image
+Image
and Palette Specification for indexed images with an 8-bit standard
RGB color model palette or three-dimensional true color images.
Other image formats supported by the Image and Palette Specification are
diff --git a/src/org.hdfgroup.hdfview/hdf/view/ImageView/DefaultImageView.java b/src/org.hdfgroup.hdfview/hdf/view/ImageView/DefaultImageView.java
index e3791cad..4dce4f1e 100644
--- a/src/org.hdfgroup.hdfview/hdf/view/ImageView/DefaultImageView.java
+++ b/src/org.hdfgroup.hdfview/hdf/view/ImageView/DefaultImageView.java
@@ -136,7 +136,8 @@
*
* A default color table is provided for images without palette attached to it. Current choice of default
* palettes include Gray, Rainbow, Nature and Wave. For more infomation on palette, read HDF5 Image and Palette Specification
+ * href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_i_m_g.html">HDF5
+ * Image and Palette Specification
*
* @author Jordan T. Henderson
* @version 2.4 2//2016
diff --git a/src/org.hdfgroup.object/hdf/object/CompoundDS.java b/src/org.hdfgroup.object/hdf/object/CompoundDS.java
index feeafd1d..5aa0b3ba 100644
--- a/src/org.hdfgroup.object/hdf/object/CompoundDS.java
+++ b/src/org.hdfgroup.object/hdf/object/CompoundDS.java
@@ -45,9 +45,9 @@
* which is unique within that type, and a datatype of that member in a compound datum. Compound datatypes can
* be nested, i.e. members of a compound datatype can be some other compound datatype.
*
- * For more details on compound datatypes, See
- * HDF5 Datatypes in HDF5 User
- * Guide
+ * For more details on compound datatypes, See HDF5
+ * Datatypes in HDF5 User Guide
*
* Since Java cannot handle C-structured compound data, data in a compound dataset is loaded in to an Java
* List. Each element of the list is a data array that corresponds to a compound field. The data is
diff --git a/src/org.hdfgroup.object/hdf/object/Dataset.java b/src/org.hdfgroup.object/hdf/object/Dataset.java
index 1afb649b..3d6de786 100644
--- a/src/org.hdfgroup.object/hdf/object/Dataset.java
+++ b/src/org.hdfgroup.object/hdf/object/Dataset.java
@@ -38,10 +38,11 @@
* data may take many library calls if we use the library APIs directly. The read() and write functions hide
* all the details of these calls from users.
*
- * For more details on dataset and attributes, See
- * HDF5 Datasets in HDF5 User Guide
- * HDF5 Attributes in HDF5 User
- * Guide
+ * For more details on dataset and attributes, See HDF5
+ * Datasets in HDF5 User Guide HDF5
+ * Attributes in HDF5 User Guide
*
* @see hdf.object.ScalarDS
* @see hdf.object.CompoundDS
diff --git a/src/org.hdfgroup.object/hdf/object/Datatype.java b/src/org.hdfgroup.object/hdf/object/Datatype.java
index 37c74893..9c84cd0a 100644
--- a/src/org.hdfgroup.object/hdf/object/Datatype.java
+++ b/src/org.hdfgroup.object/hdf/object/Datatype.java
@@ -28,8 +28,9 @@
* Datatype is an abstract class that defines datatype characteristics and APIs for a data type.
*
* A datatype has four basic characteristics: class, size, byte order and sign. These characteristics are
- * defined in the See HDF5 Datatypes in
- * HDF5 User Guide
+ * defined in the See HDF5
+ * Datatypes in HDF5 User Guide
*
* These characteristics apply to all the sub-classes. The sub-classes may have different ways to describe a
* datatype. We here define the native datatype to the datatype used by the sub-class. For
@@ -55,122 +56,142 @@ public abstract class Datatype extends HObject implements MetaDataContainer {
public static final int NATIVE = -1;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_NO_CLASS = -1;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_INTEGER = 0;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_FLOAT = 1;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_CHAR = 2;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_STRING = 3;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_BITFIELD = 4;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_OPAQUE = 5;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_COMPOUND = 6;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_REFERENCE = 7;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_ENUM = 8;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_VLEN = 9;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_ARRAY = 10;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int CLASS_TIME = 11;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int ORDER_LE = 0;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int ORDER_BE = 1;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int ORDER_VAX = 2;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int ORDER_NONE = 3;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int SIGN_NONE = 0;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int SIGN_2 = 1;
/**
- * See HDF5 Datatypes in HDF5 User
- * Guide
+ * See HDF5
+ * Datatypes in HDF5 User Guide
*/
public static final int NSGN = 2;
diff --git a/src/org.hdfgroup.object/hdf/object/ScalarDS.java b/src/org.hdfgroup.object/hdf/object/ScalarDS.java
index cb6a59d6..ece95a26 100644
--- a/src/org.hdfgroup.object/hdf/object/ScalarDS.java
+++ b/src/org.hdfgroup.object/hdf/object/ScalarDS.java
@@ -40,8 +40,9 @@ public abstract class ScalarDS extends Dataset {
private static final Logger log = LoggerFactory.getLogger(ScalarDS.class);
/************************************************************
- * The following constant strings are copied from * https://hdfgroup.github.io/hdf5/_i_m_g.html * to make
- *the definition consistent with the image specs. *
+ * The following constant strings are copied from *
+ *https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_i_m_g.html * to make the
+ *definition consistent with the image specs. *
************************************************************/
/**
@@ -307,8 +308,9 @@ public String getPaletteName(int idx)
* Returns true if this dataset is an image.
*
* For all Images, they must have an attribute called "CLASS". The value of this attribute is "IMAGE". For
- * more details, read HDF5 Image and Palette
- * Specification
+ * more details, read HDF5
+ * Image and Palette Specification
*
* @return true if the dataset is an image; otherwise, returns false.
*/
diff --git a/src/org.hdfgroup.object/hdf/object/fits/FitsAttribute.java b/src/org.hdfgroup.object/hdf/object/fits/FitsAttribute.java
index f23a17f4..28f31855 100644
--- a/src/org.hdfgroup.object/hdf/object/fits/FitsAttribute.java
+++ b/src/org.hdfgroup.object/hdf/object/fits/FitsAttribute.java
@@ -41,7 +41,8 @@
* Like a dataset, an attribute has a name, datatype and dataspace.
*
* For more details on attributes, HDF5 Attributes in HDF5 User Guide
+ * href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_a__u_g.html#sec_attribute">HDF5
+ * Attributes in HDF5 User Guide
*
* The following code is an example of an attribute with 1D integer array of two elements.
*
diff --git a/src/org.hdfgroup.object/hdf/object/fits/FitsDataset.java b/src/org.hdfgroup.object/hdf/object/fits/FitsDataset.java
index 990078b6..ebdede97 100644
--- a/src/org.hdfgroup.object/hdf/object/fits/FitsDataset.java
+++ b/src/org.hdfgroup.object/hdf/object/fits/FitsDataset.java
@@ -39,9 +39,9 @@
* FitsDataset describes an multi-dimension array of HDF5 scalar or atomic data types, such as byte, int,
* short, long, float, double and string, and operations performed on the scalar dataset
*
- * The library predefines a modest number of datatypes. For details, read
- * HDF5 Datatypes in HDF5 User
- * Guide
+ * The library predefines a modest number of datatypes. For details, read HDF5
+ * Datatypes in HDF5 User Guide
*
* @version 1.1 9/4/2007
* @author Peter X. Cao
diff --git a/src/org.hdfgroup.object/hdf/object/h4/H4CompoundAttribute.java b/src/org.hdfgroup.object/hdf/object/h4/H4CompoundAttribute.java
index 231016af..ff2f109f 100644
--- a/src/org.hdfgroup.object/hdf/object/h4/H4CompoundAttribute.java
+++ b/src/org.hdfgroup.object/hdf/object/h4/H4CompoundAttribute.java
@@ -43,7 +43,8 @@
* Like a dataset, an attribute has a name, datatype and dataspace.
*
* For more details on attributes, HDF5 Attributes in HDF5 User Guide
+ * href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_a__u_g.html#sec_attribute">HDF5
+ * Attributes in HDF5 User Guide
*
* The following code is an example of an attribute with 1D integer array of two elements.
*
diff --git a/src/org.hdfgroup.object/hdf/object/h4/H4ScalarAttribute.java b/src/org.hdfgroup.object/hdf/object/h4/H4ScalarAttribute.java
index 5f437441..f6cc126c 100644
--- a/src/org.hdfgroup.object/hdf/object/h4/H4ScalarAttribute.java
+++ b/src/org.hdfgroup.object/hdf/object/h4/H4ScalarAttribute.java
@@ -39,7 +39,8 @@
* Like a dataset, an attribute has a name, datatype and dataspace.
*
* For more details on attributes, read HDF5 Attributes in HDF5 User Guide
+ * href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_a__u_g.html#sec_attribute">HDF5
+ * Attributes in HDF5 User Guide
*
* The following code is an example of an attribute with 1D integer array of two elements.
*
diff --git a/src/org.hdfgroup.object/hdf/object/h5/H5CompoundAttr.java b/src/org.hdfgroup.object/hdf/object/h5/H5CompoundAttr.java
index e1663d38..324dd8bd 100644
--- a/src/org.hdfgroup.object/hdf/object/h5/H5CompoundAttr.java
+++ b/src/org.hdfgroup.object/hdf/object/h5/H5CompoundAttr.java
@@ -61,9 +61,9 @@
* unique within that type, and a byte offset that determines the first byte (smallest byte address) of that
* member in a compound datum.
*
- * For more information on HDF5 attributes and datatypes, read the
- * HDF5 Attributes in HDF5 User
- * Guide
+ * For more information on HDF5 attributes and datatypes, read the HDF5
+ * Attributes in HDF5 User Guide
*
* There are two basic types of compound attributes: simple compound data and nested compound data. Members of
* a simple compound attribute have atomic datatypes. Members of a nested compound attribute are compound or
diff --git a/src/org.hdfgroup.object/hdf/object/h5/H5CompoundDS.java b/src/org.hdfgroup.object/hdf/object/h5/H5CompoundDS.java
index 8c62e5ce..5f39b8bc 100644
--- a/src/org.hdfgroup.object/hdf/object/h5/H5CompoundDS.java
+++ b/src/org.hdfgroup.object/hdf/object/h5/H5CompoundDS.java
@@ -62,10 +62,11 @@
* unique within that type, and a byte offset that determines the first byte (smallest byte address) of that
* member in a compound datum.
*
- * For more information on HDF5 datasets and datatypes, read
- * HDF5 Datasets in HDF5 User Guide
- * HDF5 Datatypes in HDF5 User
- * Guide
+ * For more information on HDF5 datasets and datatypes, read HDF5
+ * Datasets in HDF5 User Guide HDF5
+ * Datatypes in HDF5 User Guide
*
* There are two basic types of compound datasets: simple compound data and nested compound data. Members of a
* simple compound dataset have atomic datatypes. Members of a nested compound dataset are compound or array
diff --git a/src/org.hdfgroup.object/hdf/object/h5/H5File.java b/src/org.hdfgroup.object/hdf/object/h5/H5File.java
index 627482fa..abfdb8e5 100644
--- a/src/org.hdfgroup.object/hdf/object/h5/H5File.java
+++ b/src/org.hdfgroup.object/hdf/object/h5/H5File.java
@@ -633,7 +633,8 @@ public static final ListselectionFlag
parameter controls whether this will be an indexed or true color image. If
diff --git a/src/org.hdfgroup.object/hdf/object/h5/H5Group.java b/src/org.hdfgroup.object/hdf/object/h5/H5Group.java
index c1b8c3f4..a6c8cb03 100644
--- a/src/org.hdfgroup.object/hdf/object/h5/H5Group.java
+++ b/src/org.hdfgroup.object/hdf/object/h5/H5Group.java
@@ -45,7 +45,9 @@
*
* For more information on HDF5 Groups,
*
- * HDF5 Groups in HDF5 User Guide
+ * HDF5
+ * Groups in HDF5 User Guide
*
* @version 1.1 9/4/2007
* @author Peter X. Cao
diff --git a/src/org.hdfgroup.object/hdf/object/h5/H5ScalarAttr.java b/src/org.hdfgroup.object/hdf/object/h5/H5ScalarAttr.java
index b56e4725..0fb912a6 100644
--- a/src/org.hdfgroup.object/hdf/object/h5/H5ScalarAttr.java
+++ b/src/org.hdfgroup.object/hdf/object/h5/H5ScalarAttr.java
@@ -59,7 +59,8 @@
* Like a dataset, an attribute has a name, datatype and dataspace.
*
* For more details on attributes, HDF5 Attributes in HDF5 User Guide
+ * href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_a__u_g.html#sec_attribute">HDF5
+ * Attributes in HDF5 User Guide
*
* The following code is an example of an attribute with 1D integer array of two elements.
*
diff --git a/src/org.hdfgroup.object/hdf/object/h5/H5ScalarDS.java b/src/org.hdfgroup.object/hdf/object/h5/H5ScalarDS.java
index 66b2ea28..7f85c7b9 100644
--- a/src/org.hdfgroup.object/hdf/object/h5/H5ScalarDS.java
+++ b/src/org.hdfgroup.object/hdf/object/h5/H5ScalarDS.java
@@ -50,9 +50,9 @@
* H5ScalarDS describes a multi-dimension array of HDF5 scalar or atomic data types, such as byte, int, short,
* long, float, double and string, and operations performed on the scalar dataset.
*
- * The library predefines a modest number of datatypes. For details, read
- * HDF5 Datatypes in HDF5 User
- * Guide
+ * The library predefines a modest number of datatypes. For details, read HDF5
+ * Datatypes in HDF5 User Guide
*
* @version 1.1 9/4/2007
* @author Peter X. Cao
diff --git a/src/org.hdfgroup.object/hdf/object/nc2/NC2Attribute.java b/src/org.hdfgroup.object/hdf/object/nc2/NC2Attribute.java
index ac65f977..66dda057 100644
--- a/src/org.hdfgroup.object/hdf/object/nc2/NC2Attribute.java
+++ b/src/org.hdfgroup.object/hdf/object/nc2/NC2Attribute.java
@@ -41,7 +41,8 @@
* Like a dataset, an attribute has a name, datatype and dataspace.
*
* For more details on attributes, HDF5 Attributes in HDF5 User Guide
+ * href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_a__u_g.html#sec_attribute">HDF5
+ * Attributes in HDF5 User Guide
*
* The following code is an example of an attribute with 1D integer array of two elements.
*
diff --git a/src/org.hdfgroup.object/hdf/object/nc2/NC2Dataset.java b/src/org.hdfgroup.object/hdf/object/nc2/NC2Dataset.java
index 41fee0d2..62dbdeee 100644
--- a/src/org.hdfgroup.object/hdf/object/nc2/NC2Dataset.java
+++ b/src/org.hdfgroup.object/hdf/object/nc2/NC2Dataset.java
@@ -35,9 +35,9 @@
* NC2Dataset describes an multi-dimension array of HDF5 scalar or atomic data types, such as byte, int,
* short, long, float, double and string, and operations performed on the scalar dataset
*
- * The library predefines a modest number of datatypes. For details, read
- * HDF5 Datatypes in HDF5 User
- * Guide
+ * The library predefines a modest number of datatypes. For details, read HDF5
+ * Datatypes in HDF5 User Guide
*
* @version 1.1 9/4/2007
* @author Peter X. Cao