diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2023-11-02 12:55:50 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-02 12:55:50 (GMT) |
commit | 61982b60fd5e3a29044a1cdd1931b0ab9f96dec1 (patch) | |
tree | a4fbf8471f958dd9d8610bd138cbb3d37dc34cfe /doxygen/dox | |
parent | 94a992689e0ff1de71f191f606bdc231211fb2d6 (diff) | |
download | hdf5-61982b60fd5e3a29044a1cdd1931b0ab9f96dec1.zip hdf5-61982b60fd5e3a29044a1cdd1931b0ab9f96dec1.tar.gz hdf5-61982b60fd5e3a29044a1cdd1931b0ab9f96dec1.tar.bz2 |
Update some doxygen links to local refs (#3814)
Diffstat (limited to 'doxygen/dox')
-rw-r--r-- | doxygen/dox/LearnBasics2.dox | 6 | ||||
-rw-r--r-- | doxygen/dox/LearnBasics3.dox | 8 | ||||
-rw-r--r-- | doxygen/dox/Overview.dox | 4 | ||||
-rw-r--r-- | doxygen/dox/ViewTools.dox | 8 | ||||
-rw-r--r-- | 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 87bbe87..f436a02 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 <a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a> -page under <a href="https://confluence.hdfgroup.org/display/HDF5/Examples+by+API#ExamplesbyAPI-datatypes">Datatypes</a> +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 <a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a> +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 7487458..a91368b 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 <a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a>. +Specifically look at the \ref ExAPI. There are examples for different languages. The C example to create a chunked dataset is: -<a href="https://support.hdfgroup.org/ftp/HDF5/examples/examples-by-api/hdf5-examples/1_8/C/H5D/h5ex_d_chunk.c">h5ex_d_chunk.c</a> +<a href="https://github.com/HDFGroup/hdf5-examples/blob/master/C/H5D/h5ex_d_chunk.c">h5ex_d_chunk.c</a> The C example to create a compact dataset is: -<a href="https://support.hdfgroup.org/ftp/HDF5/examples/examples-by-api/hdf5-examples/1_8/C/H5D/h5ex_d_compact.c">h5ex_d_compact.c</a> +<a href="https://github.com/HDFGroup/hdf5-examples/blob/master/C/H5D/h5ex_d_compact.c">h5ex_d_compact.c</a> \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 <a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a>. +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 54cc638..438788e 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: - - <a href="https://docs.hdfgroup.org/hdf5/develop/index.html">HDF5 <code>develop</code> branch (this site)</a> - - <a href="https://docs.hdfgroup.org/hdf5/v1_14/index.html">HDF5 1.14.x</a> + - <a href="https://hdfgroup.github.io/hdf5/index.html">HDF5 <code>develop</code> branch (this site)</a> + - <a href="https://hdfgroup.github.io/hdf5/v1_14/index.html">HDF5 1.14.x</a> - <a href="https://docs.hdfgroup.org/hdf5/v1_12/index.html">HDF5 1.12.x</a> - <a href="https://docs.hdfgroup.org/hdf5/v1_10/index.html">HDF5 1.10.x</a> - <a href="https://docs.hdfgroup.org/hdf5/v1_8/index.html">HDF5 1.8.x</a> diff --git a/doxygen/dox/ViewTools.dox b/doxygen/dox/ViewTools.dox index 66b2def..9516056 100644 --- a/doxygen/dox/ViewTools.dox +++ b/doxygen/dox/ViewTools.dox @@ -53,7 +53,7 @@ packages, which can be obtained from the <a href="https://portal.hdfgroup.org/di HDF5 files can be obtained from various places such as \ref HDF5Examples and <a href="http://www.hdfeos.org/">HDF-EOS and Tools and Information Center</a>. Specifically, the following examples are used in this tutorial topic: \li HDF5 Files created from compiling the \ref LBExamples -\li HDF5 Files on the <a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a> page +\li HDF5 Files on the \ref ExAPI page \li NPP JPSS files, <a href="https://support.hdfgroup.org/ftp/HDF5/examples/files/tutorial/SVM01_npp_d20130524_t1255132_e1256374_b08146_c20130524192048864992_noaa_ops.h5.gz">SVM01_npp.. (gzipped)</a> and <a href="https://support.hdfgroup.org/ftp/HDF5/examples/files/tutorial/SVM09_npp_d20120229_t0849107_e0854511_b01759_c20120229145452682127_noaa_ops.h5.gz">SVM09_npp.. (gzipped)</a> \li HDF-EOS <a href="https://support.hdfgroup.org/ftp/HDF5/examples/files/tutorial/OMI-Aura.he5">OMI-Aura file</a> @@ -497,7 +497,7 @@ In the file shown below the dataset <code style="background-color:whitesmoke;">/ \endcode You can obtain the <code style="background-color:whitesmoke;">h5ex_d_gzip.c</code> program that created this file, as well as the file created, -from the <a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a> page. +from the \ref ExAPI page. \subsection subsecViewToolsViewDset_h5ls h5ls Specific datasets can be specified with <code style="background-color:whitesmoke;">h5ls</code> 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 <code style="background-color:whitesmoke;">h5dump</code> with HDF5 files from the -<a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a> page: +\ref ExAPI page: <ul> <li>@ref subsubsecViewToolsViewDtypes_array</li> <li>@ref subsubsecViewToolsViewDtypes_objref</li> @@ -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 (<code style="background-color:whitesmoke;">h5ex_t_regref.h5</code>) can be found on the -<a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a> page, +\ref ExAPI page, under Datatypes. If you examine this dataset with <code style="background-color:whitesmoke;">h5dump</code> you will see that <code style="background-color:whitesmoke;">/DS1</code> 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 4d8788a..71d7465 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 <a href="https://portal.hdfgroup.org/display/HDF5/Examples+by+API">Examples by API</a> page. +from the \ref ExAPI page. Note that string data requires use of the <code style="background-color:whitesmoke;">h5dump -y</code> option to exclude indexes and the <code style="background-color:whitesmoke;">h5dump --width=1</code> |