From ca6ceb2f6d1bb06e712ba474fd93244f35006353 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Tue, 26 Nov 2024 09:40:08 -0600 Subject: [PATCH 1/4] Correct some links in doxygen - not found (#5146) --- HDF5Examples/C/H5FLT/tfiles/h5ex_d_zfp.tst | 2 +- doxygen/aliases | 6 ++++-- doxygen/dox/ExamplesAPI.dox | 6 +++--- doxygen/dox/IntroHDF5.dox | 2 +- doxygen/dox/LearnBasics.dox | 6 +++--- doxygen/dox/LearnBasics3.dox | 4 ++-- doxygen/dox/Overview.dox | 2 +- doxygen/dox/TechnicalNotes.dox | 2 +- doxygen/hdf5_footer.html | 9 +++------ doxygen/hdf5_header.html | 4 ++++ 10 files changed, 23 insertions(+), 20 deletions(-) diff --git a/HDF5Examples/C/H5FLT/tfiles/h5ex_d_zfp.tst b/HDF5Examples/C/H5FLT/tfiles/h5ex_d_zfp.tst index 2bec93cce2f..8b95b6e205b 100644 --- a/HDF5Examples/C/H5FLT/tfiles/h5ex_d_zfp.tst +++ b/HDF5Examples/C/H5FLT/tfiles/h5ex_d_zfp.tst @@ -4,7 +4,7 @@ zfp filter is available for encoding and decoding. ....Close the file and reopen for reading ........ Filter info is available from the dataset creation property Filter identifier is 32013 - Number of parameters is 6 with the value 268456209 + Number of parameters is 6 with the value 269504785 To find more about the filter check H5Z-ZFP-1.1.1 (ZFP-1.0.1) github.com/LLNL/H5Z-ZFP ....Reading zfp compressed data ................ Maximum value in DS1 is 1890.0000 diff --git a/doxygen/aliases b/doxygen/aliases index fffec1cc2aa..cbc6e81f6cf 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -7,10 +7,12 @@ ALIASES += THG="The HDF Group" ALIASES += HDFURL="support.hdfgroup.org" # URL for archived files ALIASES += ARCURL="\HDFURL/archive/support/HDF5/doc" +# URL for release files +ALIASES += RELURL="\HDFURL/releases/hdf5" # URL for documentation -ALIASES += DOCURL="\HDFURL/releases/hdf5/documentation" +ALIASES += DOCURL="\RELURL/documentation" # URL for downloads -ALIASES += DWNURL="\HDFURL/releases/hdf5/downloads" +ALIASES += DWNURL="\RELURL/downloads/latest" # URL for RFCs ALIASES += RFCURL="\DOCURL/rfc" ALIASES += AEXURL="\HDFURL/archive/support/ftp/HDF5/examples" diff --git a/doxygen/dox/ExamplesAPI.dox b/doxygen/dox/ExamplesAPI.dox index f3903cec1d2..cf44405db11 100644 --- a/doxygen/dox/ExamplesAPI.dox +++ b/doxygen/dox/ExamplesAPI.dox @@ -150,8 +150,8 @@ Languages are C, Fortran, Java (JHI5), Java Object Package, Python (High Level), JavaObj MATLAB PyHigh PyLow -h5ex_d_rdwrc.h5 -h5ex_d_rdwrc.tst +h5ex_d_rdwr.h5 +h5ex_d_rdwr.tst h5ex_d_rdwr.ddl @@ -483,7 +483,7 @@ FORTRAN h5ex_t_convert.h5 h5ex_t_convert.tst -h5ex_t_convert.ddl +h5ex_t_convert.ddl not applicable Read / Write Complex Compound (Attribute) diff --git a/doxygen/dox/IntroHDF5.dox b/doxygen/dox/IntroHDF5.dox index d008ddcfc86..e83f8b22280 100644 --- a/doxygen/dox/IntroHDF5.dox +++ b/doxygen/dox/IntroHDF5.dox @@ -625,7 +625,7 @@ For information on compiling in C, C++ and Fortran, see: \ref LBCompiling IDL, MATLAB, and NCL Examples for HDF-EOS Examples of how to access and visualize NASA HDF-EOS files using IDL, MATLAB, and NCL. -Miscellaneous Examples +Miscellaneous Examples These (very old) examples resulted from working with users, and are not fully tested. Most of them are in C, with a few in Fortran and Java. Using Special Values diff --git a/doxygen/dox/LearnBasics.dox b/doxygen/dox/LearnBasics.dox index 4db515c1a57..33426cf1311 100644 --- a/doxygen/dox/LearnBasics.dox +++ b/doxygen/dox/LearnBasics.dox @@ -75,7 +75,7 @@ These examples (C, C++, Fortran, Java, Python) are provided in the HDF5 source c Read and write to a dataset -C Fortran C++ Java Python +C Fortran C++ Java Python @@ -83,7 +83,7 @@ These examples (C, C++, Fortran, Java, Python) are provided in the HDF5 source c Create an attribute -C Fortran C++ Java Python +C Fortran C++ Java Python @@ -99,7 +99,7 @@ These examples (C, C++, Fortran, Java, Python) are provided in the HDF5 source c Create groups in a file using absolute and relative paths -C Fortran C++ Java Python +C Fortran C++ Java Python diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox index 6e569aa41bb..c93c23971c0 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/doxygen/dox/LearnBasics3.dox @@ -968,7 +968,7 @@ or on WINDOWS you may need to add the path to the bin folder to PATH. \section secLBCompilingCMake Compiling an Application with CMake \subsection subsecLBCompilingCMakeScripts CMake Scripts for Building Applications -See Using CMake to Build Applications to build applications with different languages and options. +See Using CMake to Build Applications to build applications with different languages and options. For a more complete script (and to help resolve issues) see the script provided with the HDF5 Examples project. @@ -976,7 +976,7 @@ For a more complete script (and to help resolve issues) see the script provided The installed HDF5 can be verified by compiling the HDF5 Examples project, included with the CMake built HDF5 binaries in the share folder or you can go to the HDF5 Examples in the HDF5 github repository. -Go into the share directory and follow the instructions in Using CMake to Build Examples to build the examples. +Go into the share directory and follow the instructions in Using CMake to Build Examples to build the examples. In general, users must first set the HDF5_ROOT environment variable to the installed location of the CMake configuration files for HDF5. For example, on Windows the following path might be set: diff --git a/doxygen/dox/Overview.dox b/doxygen/dox/Overview.dox index b472d4d2a8d..6caffd147aa 100644 --- a/doxygen/dox/Overview.dox +++ b/doxygen/dox/Overview.dox @@ -21,7 +21,7 @@ documents cover a mix of tasks, concepts, and reference, to help a specific audience succeed. \par Offline reading - You can download it as an archive for offline reading. + You can download it as an archive for offline reading. \par ToDo List There is plenty of unfinished business. diff --git a/doxygen/dox/TechnicalNotes.dox b/doxygen/dox/TechnicalNotes.dox index 787a0d8a448..b0f1c8f4cbc 100644 --- a/doxygen/dox/TechnicalNotes.dox +++ b/doxygen/dox/TechnicalNotes.dox @@ -1094,7 +1094,7 @@ A beneficial side effect of using SWMR access is better fault tolerance. It is m \subsection subsec_swmr_doc Documentation \subsubsection subsubsec_swmr_doc_guide User Guide -SWMR User Guide +SWMR User Guide \subsubsection subsubsec_swmr_doc_apis HDF5 Library APIs