From 023688a8a4c50ccede1358069291b7742bb434d6 Mon Sep 17 00:00:00 2001 From: bmribler <39579120+bmribler@users.noreply.github.com> Date: Sun, 24 Mar 2024 16:12:36 -0400 Subject: [PATCH] Fix broken URLs in documentation (#4214) Fixes GH-3881 partially. There are pages that need to be recreated. --- doxygen/aliases | 10 +++++----- doxygen/dox/GettingStarted.dox | 4 ++-- doxygen/dox/IntroHDF5.dox | 2 +- doxygen/dox/LearnHDFView.dox | 2 +- doxygen/dox/UsersGuide.dox | 8 ++++---- doxygen/dox/VOLConnGuide.dox | 4 ++-- doxygen/dox/ViewTools.dox | 2 +- src/H5Fmodule.h | 8 ++++---- src/H5VLmodule.h | 2 +- 9 files changed, 21 insertions(+), 21 deletions(-) diff --git a/doxygen/aliases b/doxygen/aliases index ad868432bee..0f5a4a4ed8f 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -234,14 +234,14 @@ ALIASES += sa_metadata_ops="\sa \li H5Pget_all_coll_metadata_ops() \li H5Pget_co # References ################################################################################ -ALIASES += ref_cons_semantics="Enabling a Strict Consistency Semantics Model in Parallel HDF5" -ALIASES += ref_file_image_ops="HDF5 File Image Operations" +ALIASES += ref_cons_semantics="Enabling a Strict Consistency Semantics Model in Parallel HDF5" +ALIASES += ref_file_image_ops="HDF5 File Image Operations" ALIASES += ref_filter_pipe="Data Flow Pipeline for H5Dread()" -ALIASES += ref_group_impls="Group implementations in HDF5" -ALIASES += ref_h5lib_relver="HDF5 Library Release Version Numbers" +ALIASES += ref_group_impls="Group implementations in HDF5" +ALIASES += ref_h5lib_relver="HDF5 Library Release Version Numbers" ALIASES += ref_mdc_in_hdf5="Metadata Caching in HDF5" ALIASES += ref_mdc_logging="Metadata Cache Logging" -ALIASES += ref_news_112="New Features in HDF5 Release 1.12" +ALIASES += ref_news_112="New Features in HDF5 Release 1.12" ALIASES += ref_h5ocopy="Copying Committed Datatypes with H5Ocopy()" ALIASES += ref_sencode_fmt_change="RFC H5Secnode() / H5Sdecode() Format Change" ALIASES += ref_vlen_strings="\Emph{Creating variable-length string datatypes}" diff --git a/doxygen/dox/GettingStarted.dox b/doxygen/dox/GettingStarted.dox index 87f3566361e..feb5f919f9a 100644 --- a/doxygen/dox/GettingStarted.dox +++ b/doxygen/dox/GettingStarted.dox @@ -42,7 +42,7 @@ Parallel HDF5, and the HDF5-1.10 VDS and SWMR new features: diff --git a/doxygen/dox/IntroHDF5.dox b/doxygen/dox/IntroHDF5.dox index afe534be614..33cf4a91ca8 100644 --- a/doxygen/dox/IntroHDF5.dox +++ b/doxygen/dox/IntroHDF5.dox @@ -608,7 +608,7 @@ on the HDF-EOS Tools and Information Center pag \section secHDF5Examples Examples \li \ref LBExamples \li \ref ExAPI -\li Examples in the Source Code +\li Examples in the Source Code \li Other Examples \section secHDF5ExamplesCompile How To Compile diff --git a/doxygen/dox/LearnHDFView.dox b/doxygen/dox/LearnHDFView.dox index 8c617f21477..2916db841e6 100644 --- a/doxygen/dox/LearnHDFView.dox +++ b/doxygen/dox/LearnHDFView.dox @@ -7,7 +7,7 @@ This tutorial enables you to get a feel for HDF5 by using the HDFView browser. I any programming experience. \section sec_learn_hv_install HDFView Installation -\li Download and install HDFView. It can be downloaded from the Download HDFView page. +\li Download and install HDFView. It can be downloaded from the Download HDFView page. \li Obtain the storm1.txt text file, used in the tutorial. \section sec_learn_hv_begin Begin Tutorial diff --git a/doxygen/dox/UsersGuide.dox b/doxygen/dox/UsersGuide.dox index b6113ad15bd..3dd26f1a40a 100644 --- a/doxygen/dox/UsersGuide.dox +++ b/doxygen/dox/UsersGuide.dox @@ -374,7 +374,7 @@ These documents provide additional information for the use and tuning of specifi
-Using the High Level APIs +Using the High Level APIs \ref H5LT \ref H5IM \ref H5TB \ref H5PT \ref H5DS @@ -72,7 +72,7 @@ HDF5-1.10 New Features \li Introduction to the Virtual Dataset - VDS -\li Introduction to Single-Writer/Multiple-Reader (SWMR) +\li Introduction to Single-Writer/Multiple-Reader (SWMR)
-

HDF5 Dynamically Loaded Filters

+

HDF5 Dynamically Loaded Filters

Describes how an HDF5 application can apply a filter that is not registered with the HDF5 Library.

@@ -382,7 +382,7 @@ These documents provide additional information for the use and tuning of specifi
-

HDF5 File Image Operations

+

HDF5 File Image Operations

Describes how to work with HDF5 files in memory. Disk I/O is not required when file images are opened, created, read from, or written to.

@@ -390,7 +390,7 @@ These documents provide additional information for the use and tuning of specifi
-

Modified Region Writes

+

Modified Region Writes

Describes how to set write operations for in-memory files so that only modified regions are written to storage. Available when the Core (Memory) VFD is used.

@@ -438,4 +438,4 @@ Previous Chapter \ref sec_plist HDF5 repo, make changes, and create a pull request !\n -*/ \ No newline at end of file +*/ diff --git a/doxygen/dox/VOLConnGuide.dox b/doxygen/dox/VOLConnGuide.dox index fb662a0ef5a..7a03ab1590d 100644 --- a/doxygen/dox/VOLConnGuide.dox +++ b/doxygen/dox/VOLConnGuide.dox @@ -92,7 +92,7 @@ Public header Files you will need to be familiar with include:
Many VOL connectors are listed on The HDF Group's VOL plugin registration page, located at: -Registered VOL Connectors. +Registered VOL Connectors. Not all of these VOL connectors are supported by The HDF Group and the level of completeness varies, but the connectors found there can serve as examples of working implementations @@ -195,7 +195,7 @@ contact help@hdfgroup.org for help with this. We name you've chosen will appear on the registered VOL connectors page. As noted above, registered VOL connectors will be listed at: -Registered VOL Connectors +Registered VOL Connectors A new \b conn_version field has been added to the class struct for 1.13. This field is currently not used by the library so its use is determined by the connector author. Best practices for this field will be determined diff --git a/doxygen/dox/ViewTools.dox b/doxygen/dox/ViewTools.dox index 951605674be..f4c31c83663 100644 --- a/doxygen/dox/ViewTools.dox +++ b/doxygen/dox/ViewTools.dox @@ -48,7 +48,7 @@ Navigate back: \ref index "Main" / \ref GettingStarted \section secViewToolsCommandObtain Obtain Tools and Files (Optional) Pre-built binaries for Linux and Windows are distributed within the respective HDF5 binary release -packages, which can be obtained from the Download HDF5 page. +packages, which can be obtained from the Download HDF5 page. HDF5 files can be obtained from various places such as \ref HDF5Examples and HDF-EOS and Tools and Information Center. Specifically, the following examples are used in this tutorial topic: diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h index 91489242164..1cabd76057d 100644 --- a/src/H5Fmodule.h +++ b/src/H5Fmodule.h @@ -235,10 +235,10 @@ * Note that the root group, indicated above by /, was automatically created when the file was created. * * h5dump is described on the - * Tools + * + * Tools * page under - * - * Libraries and Tools Reference. + * Command-line Tools. * The HDF5 DDL grammar is described in the document \ref DDLBNF114. * * \subsection subsec_file_summary File Function Summaries @@ -888,7 +888,7 @@ * * Additional parameters may be added to these functions in the future. * - * @see + * @see * HDF5 File Image Operations * section for information on more advanced usage of the Memory file driver, and * @see diff --git a/src/H5VLmodule.h b/src/H5VLmodule.h index 19baf344d57..0cca38cf1db 100644 --- a/src/H5VLmodule.h +++ b/src/H5VLmodule.h @@ -83,7 +83,7 @@ * to be much more common than internal implementations. * * A list of VOL connectors can be found here: - * + * * Registered VOL Connectors * * This list is incomplete and only includes the VOL connectors that have been registered with