Skip to content

Commit

Permalink
Correct issues with documentation URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
byrnHDF authored Sep 26, 2024
1 parent 31b8879 commit 58eac25
Show file tree
Hide file tree
Showing 24 changed files with 126 additions and 92 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/daily-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tarball.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/UsersGuide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
A brief discussion of the HDF object model
(Details of the HDF object model are available from

<a href="../javadocs/org.hdfgroup.object/hdf/object/package-summary.html">HDF Object Package</a>.)</li>
<a href="javadocs/hdfview_java_doc/org.hdfgroup.object/module-summary.html">HDF Object Package</a>.)</li>

</ul>

Expand Down
2 changes: 1 addition & 1 deletion docs/UsersGuide/ug01introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ <h2>

<p>
Information about the HDFView tool and related products is available
from the <a href="https://support.hdfgroup.org/downloads/HDFVIEW/">HDF-Java Home page</a>.
from the <a href="https://support.hdfgroup.org/releases/hdfview/latest-release.html">HDF-Java Home page</a>.
</p>


Expand Down
4 changes: 2 additions & 2 deletions docs/UsersGuide/ug02start.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ <h2>
An HDF file contains one or more objects, optionally grouped in a hierarchy.
For general information about the structure and contents of HDF files,
see the HDF documentation at
<a href="https://support.hdfgroup.org/documentation/HDF5/"> HDF5 Documentation</a> and
<a href="https://support.hdfgroup.org/documentation/HDF4/"> HDF4 Documentation</a>.</p>
<a href="https://support.hdfgroup.org/releases/hdf5/latest-docs.html"> HDF5 Documentation</a> and
<a href="https://support.hdfgroup.org/releases/hdf4/latest-docs.html"> HDF4 Documentation</a>.</p>

<p>
The structure of the file is displayed in the Tree panel, which is the left
Expand Down
12 changes: 6 additions & 6 deletions docs/UsersGuide/ug03objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h1>
<fieldset>Chapter 3: HDF Object Model</fieldset></h1>

<p>
This chapter provides basic information about the <a href="../javadocs/org.hdfgroup.object/hdf/object/package-summary.html">HDF Object Model</a>.
This chapter provides basic information about the <a href="javadocs/hdfview_java_doc/org.hdfgroup.object/module-summary.html">HDF Object Model</a>.
</p>
<ul class="ul">
<li class="add"><a href="ug03objects.html#ug03overview">3.1 Overview</a></li>
Expand Down Expand Up @@ -61,10 +61,10 @@ <h2>
libraries, and it requires the HDF4 and HDF5 wrappers.
The HDF4 and HDF5 wrappers are separate HDF Java products. For
details about the HDF4 and HDF5 native interfaces, see
<a href="https://github.com/HDFGroup/hdf4/blob/master/java/src/hdf/overview.html">
<a href="javadocs/hdf4_java_doc/overview-summary.html">
Java HDF Interface (JHI)</a>
and the
<a href="https://github.com/HDFGroup/hdf5/blob/develop/java/src/hdf/overview.html">
<a href="javadocs/hdf5_java_doc/overview-summary.html">
Java HDF5 Interface (JHI5)</a>.</p>

<p>
Expand Down Expand Up @@ -105,7 +105,7 @@ <h2>
are a sub-type of one of these abstract classes.</p>

<p>For details, see the Java docs at
<a href="javadocs/hdfview_java_doc/hdf/object/package-summary.html">javadocs</a>.</p>
<a href="javadocs/hdfview_java_doc/org.hdfgroup.object/module-summary.html">javadocs</a>.</p>

<br />
<h2>
Expand All @@ -115,10 +115,10 @@ <h2>
HDF5 files without directly calling the HDF4 and HDF5 library APIs. Library
calls are encapsulated into respective classes. The HDF Object Package
requires the
<a href="https://github.com/HDFGroup/hdf4/blob/master/java/src/hdf/overview.html">
<a href="javadocs/hdf4_java_doc/overview-summary.html">
Java HDF Interface (JHI)</a>
and the
<a href="https://github.com/HDFGroup/hdf5/blob/develop/java/src/hdf/overview.html">
<a href="javadocs/hdf5_java_doc/overview-summary.html">
Java HDF5 Interface (JHI5)</a>.</p>
<br />

Expand Down
6 changes: 3 additions & 3 deletions docs/UsersGuide/ug06imageview.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@

<p>
An HDF5 image is a dataset that conforms to the
<a href="https://support.hdfgroup.org/documentation/HDF5/HDF5+Image+and+Palette+Specification%2C+Version+1.2">
<a href="https://support.hdfgroup.org/releases/hdf5/documentation/ImageSpec.html">
HDF5 Image Specification</a>. 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
<a href="https://support.hdfgroup.org/documentation/HDF5/HDF5+Image+and+Palette+Specification%2C+Version+1.2">
<a href="https://support.hdfgroup.org/documentation//releases/hdf5/documentation/ImageSpec.html">
HDF5 Image Specification</a>.</p>

<ul class="ul">
Expand All @@ -53,7 +53,7 @@ <h2>
6.1 Display a 2-D or 3-D Image</h2>
<p>
HDFView displays HDF4 raster images or HDF5 datasets that follow the HDF5
<a href="https://support.hdfgroup.org/documentation/HDF5/HDF5+Image+and+Palette+Specification%2C+Version+1.2">Image
<a href="https://support.hdfgroup.org/releases/hdf5/documentation/ImageSpec.html">Image
and Palette Specification</a> 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a
* href="https://hdfgroup.github.io/hdf5/_i_m_g.html">HDF5 Image and Palette Specification</a>
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_i_m_g.html">HDF5
* Image and Palette Specification</a>
*
* @author Jordan T. Henderson
* @version 2.4 2//2016
Expand Down
6 changes: 3 additions & 3 deletions src/org.hdfgroup.object/hdf/object/CompoundDS.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* For more details on compound datatypes, See <a href=
* "https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*
* 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
Expand Down
9 changes: 5 additions & 4 deletions src/org.hdfgroup.object/hdf/object/Dataset.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <a href="https://hdfgroup.github.io/hdf5/_h5_d__u_g.html#sec_dataset">HDF5 Datasets in HDF5 User Guide</a>
* <a href="https://hdfgroup.github.io/hdf5/_h5_a__u_g.html#sec_attribute">HDF5 Attributes in HDF5 User
* Guide</a>
* For more details on dataset and attributes, See <a href=
* "https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_d__u_g.html#sec_dataset">HDF5
* Datasets in HDF5 User Guide</a> <a 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</a>
*
* @see hdf.object.ScalarDS
* @see hdf.object.CompoundDS
Expand Down
105 changes: 63 additions & 42 deletions src/org.hdfgroup.object/hdf/object/Datatype.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in
* HDF5 User Guide</a>
* defined in the See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*
* These characteristics apply to all the sub-classes. The sub-classes may have different ways to describe a
* datatype. We here define the <strong> native datatype</strong> to the datatype used by the sub-class. For
Expand All @@ -55,122 +56,142 @@ public abstract class Datatype extends HObject implements MetaDataContainer {
public static final int NATIVE = -1;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_NO_CLASS = -1;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_INTEGER = 0;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_FLOAT = 1;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_CHAR = 2;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_STRING = 3;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_BITFIELD = 4;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_OPAQUE = 5;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_COMPOUND = 6;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_REFERENCE = 7;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_ENUM = 8;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_VLEN = 9;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_ARRAY = 10;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int CLASS_TIME = 11;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int ORDER_LE = 0;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int ORDER_BE = 1;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int ORDER_VAX = 2;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int ORDER_NONE = 3;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int SIGN_NONE = 0;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int SIGN_2 = 1;

/**
* See <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* See <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*/
public static final int NSGN = 2;

Expand Down
10 changes: 6 additions & 4 deletions src/org.hdfgroup.object/hdf/object/ScalarDS.java
Original file line number Diff line number Diff line change
Expand Up @@ -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. *
************************************************************/

/**
Expand Down Expand Up @@ -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 <a href="https://hdfgroup.github.io/hdf5/_i_m_g.html"> HDF5 Image and Palette
* Specification</a>
* more details, read <a
* href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_i_m_g.html"> HDF5
* Image and Palette Specification</a>
*
* @return true if the dataset is an image; otherwise, returns false.
*/
Expand Down
3 changes: 2 additions & 1 deletion src/org.hdfgroup.object/hdf/object/fits/FitsAttribute.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
* Like a dataset, an attribute has a name, datatype and dataspace.
*
* For more details on attributes, <a
* href="https://hdfgroup.github.io/hdf5/_h5_a__u_g.html#sec_attribute">HDF5 Attributes in HDF5 User Guide</a>
* 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</a>
*
* The following code is an example of an attribute with 1D integer array of two elements.
*
Expand Down
6 changes: 3 additions & 3 deletions src/org.hdfgroup.object/hdf/object/fits/FitsDataset.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <a href="https://hdfgroup.github.io/hdf5/_h5_t__u_g.html#sec_datatype">HDF5 Datatypes in HDF5 User
* Guide</a>
* The library predefines a modest number of datatypes. For details, read <a href=
* "https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_t__u_g.html#sec_datatype">HDF5
* Datatypes in HDF5 User Guide</a>
*
* @version 1.1 9/4/2007
* @author Peter X. Cao
Expand Down
Loading

0 comments on commit 58eac25

Please sign in to comment.