From 61982b60fd5e3a29044a1cdd1931b0ab9f96dec1 Mon Sep 17 00:00:00 2001
From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com>
Date: Thu, 2 Nov 2023 07:55:50 -0500
Subject: [PATCH] Update some doxygen links to local refs (#3814)
---
doxygen/dox/LearnBasics2.dox | 6 +++---
doxygen/dox/LearnBasics3.dox | 8 ++++----
doxygen/dox/Overview.dox | 4 ++--
doxygen/dox/ViewTools.dox | 8 ++++----
doxygen/dox/ViewTools2.dox | 2 +-
5 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/doxygen/dox/LearnBasics2.dox b/doxygen/dox/LearnBasics2.dox
index 87bbe87fe4..f436a027d8 100644
--- a/doxygen/dox/LearnBasics2.dox
+++ b/doxygen/dox/LearnBasics2.dox
@@ -728,12 +728,12 @@ There are numerous datatype functions that allow a user to alter a pre-defined d
Refer to the \ref H5T in the \ref RM. Example functions are #H5Tset_size and #H5Tset_precision.
\section secLBDtypeSpec Specific Datatypes
-On the Examples by API
-page under Datatypes
+On the \ref ExAPI
+page under \ref sec_exapi_dtypes
you will find many example programs for creating and reading datasets with different datatypes.
Below is additional information on some of the datatypes. See
-the Examples by API
+the \ref ExAPI
page for examples of these datatypes.
\subsection subsecLBDtypeSpec Array Datatype vs Array Dataspace
diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox
index 748745827f..a91368b00f 100644
--- a/doxygen/dox/LearnBasics3.dox
+++ b/doxygen/dox/LearnBasics3.dox
@@ -152,13 +152,13 @@ To use the compact storage layout, call: #H5Pset_layout
\li Create a dataset with the modified property list. (See #H5Dcreate)
\li Close the property list. (See #H5Pclose)
For example code, see the \ref HDF5Examples page.
-Specifically look at the Examples by API.
+Specifically look at the \ref ExAPI.
There are examples for different languages.
The C example to create a chunked dataset is:
-h5ex_d_chunk.c
+h5ex_d_chunk.c
The C example to create a compact dataset is:
-h5ex_d_compact.c
+h5ex_d_compact.c
\section secLBDsetLayoutChange Changing the Layout after Dataset Creation
The dataset layout is a Dataset Creation Property List. This means that once the dataset has been
@@ -290,7 +290,7 @@ is met, at a certain point in the future.)
\subsection subsecLBContentsProgUsing Using #H5Literate, #H5Lvisit and #H5Ovisit
For example code, see the \ref HDF5Examples page.
-Specifically look at the Examples by API.
+Specifically look at the \ref ExAPI.
There are examples for different languages, where examples of using #H5Literate and #H5Ovisit/#H5Lvisit are included.
The h5ex_g_traverse example traverses a file using H5Literate:
diff --git a/doxygen/dox/Overview.dox b/doxygen/dox/Overview.dox
index 54cc638d9d..438788eb02 100644
--- a/doxygen/dox/Overview.dox
+++ b/doxygen/dox/Overview.dox
@@ -23,8 +23,8 @@ documents cover a mix of tasks, concepts, and reference, to help a specific
\par Versions
Version-specific documentation (see the version in the title area) can be found
here:
- - HDF5 develop
branch (this site)
- - HDF5 1.14.x
+ - HDF5 develop
branch (this site)
+ - HDF5 1.14.x
- HDF5 1.12.x
- HDF5 1.10.x
- HDF5 1.8.x
diff --git a/doxygen/dox/ViewTools.dox b/doxygen/dox/ViewTools.dox
index 66b2def062..951605674b 100644
--- a/doxygen/dox/ViewTools.dox
+++ b/doxygen/dox/ViewTools.dox
@@ -53,7 +53,7 @@ packages, which can be obtained from the HDF-EOS and Tools and
Information Center. Specifically, the following examples are used in this tutorial topic:
\li HDF5 Files created from compiling the \ref LBExamples
-\li HDF5 Files on the Examples by API page
+\li HDF5 Files on the \ref ExAPI page
\li NPP JPSS files, SVM01_npp.. (gzipped)
and SVM09_npp.. (gzipped)
\li HDF-EOS OMI-Aura file
@@ -497,7 +497,7 @@ In the file shown below the dataset /
\endcode
You can obtain the h5ex_d_gzip.c
program that created this file, as well as the file created,
-from the Examples by API page.
+from the \ref ExAPI page.
\subsection subsecViewToolsViewDset_h5ls h5ls
Specific datasets can be specified with h5ls
by simply adding the dataset path and dataset after the
@@ -925,7 +925,7 @@ The output of the above command is shown below:
\subsection subsecViewToolsViewDtypes_h5dump h5dump
The following datatypes are discussed, using the output of h5dump
with HDF5 files from the
-Examples by API page:
+\ref ExAPI page:
- @ref subsubsecViewToolsViewDtypes_array
- @ref subsubsecViewToolsViewDtypes_objref
@@ -1036,7 +1036,7 @@ the elements or slab that is selected. A dataset with a Region Reference datatyp
one or more Region References.
An example of a Region Reference dataset (h5ex_t_regref.h5
) can be found on the
-Examples by API page,
+\ref ExAPI page,
under Datatypes. If you examine this dataset with h5dump
you will see that /DS1
is a
Region Reference dataset as indicated by its datatype, highlighted in bold below:
\code
diff --git a/doxygen/dox/ViewTools2.dox b/doxygen/dox/ViewTools2.dox
index 4d8788a81f..71d74652d4 100644
--- a/doxygen/dox/ViewTools2.dox
+++ b/doxygen/dox/ViewTools2.dox
@@ -727,7 +727,7 @@ GROUP "/" {
\endcode
The second example imports string data. The example program that creates this file can be downloaded
-from the Examples by API page.
+from the \ref ExAPI page.
Note that string data requires use of the h5dump -y
option to exclude indexes and the h5dump --width=1