Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct some links in doxygen - not found #5146

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Correct some links in doxygen - not found #5146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
084ce62
Correct some links in doxygen - not found
byrnHDF Nov 25, 2024
b81c1d7
Merge branch 'HDFGroup:develop' into develop-doxy-links
byrnHDF Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion HDF5Examples/C/H5FLT/tfiles/h5ex_d_zfp.tst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions doxygen/aliases
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
6 changes: 3 additions & 3 deletions doxygen/dox/ExamplesAPI.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ Languages are C, Fortran, Java (JHI5), Java Object Package, Python (High Level),
<a href="https://\HVURL/test/org.hdfgroup.object.example.test/datasets/H5ObjectEx_D_ReadWrite.java">JavaObj</a>
MATLAB PyHigh PyLow
</td>
<td>h5ex_d_rdwrc.h5</td>
<td><a href="https://\SRCURL/HDF5Examples/C/H5D/tfiles/16/h5ex_d_rdwrc.tst">h5ex_d_rdwrc.tst</a></td>
<td>h5ex_d_rdwr.h5</td>
<td><a href="https://\SRCURL/HDF5Examples/C/H5D/tfiles/16/h5ex_d_rdwr.tst">h5ex_d_rdwr.tst</a></td>
<td><a href="https://\SRCURL/HDF5Examples/C/H5D/tfiles/16/h5ex_d_rdwr.ddl">h5ex_d_rdwr.ddl</a></td>
</tr>
<tr>
Expand Down Expand Up @@ -483,7 +483,7 @@ FORTRAN
</td>
<td>h5ex_t_convert.h5</td>
<td><a href="https://\SRCURL/HDF5Examples/C/H5T/tfiles/16/h5ex_t_convert.tst">h5ex_t_convert.tst</a></td>
<td><a href="https://\SRCURL/HDF5Examples/C/H5T/tfiles/18/h5ex_t_convert.ddl">h5ex_t_convert.ddl</a></td>
<td>h5ex_t_convert.ddl not applicable</td>
</tr>
<tr>
<td>Read / Write Complex Compound (Attribute)</td>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/IntroHDF5.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ For information on compiling in C, C++ and Fortran, see: \ref LBCompiling
<a href="http://hdfeos.org/zoo/index.php">IDL, MATLAB, and NCL Examples for HDF-EOS</a>
Examples of how to access and visualize NASA HDF-EOS files using IDL, MATLAB, and NCL.

<a href="https://\AEXURL/misc-examples/">Miscellaneous Examples</a>
<a href="https://\AEXURL/misc-examples/index.html">Miscellaneous Examples</a>
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.

<a href="https://\AEXURL/special_values_HDF5_example.tar">Using Special Values</a>
Expand Down
6 changes: 3 additions & 3 deletions doxygen/dox/LearnBasics.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,15 @@ These examples (C, C++, Fortran, Java, Python) are provided in the HDF5 source c
<tr>
<td>Read and write to a dataset
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_rdwt.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_rdwt.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_rdwt.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5DatasetRead.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_rdwt.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_rdwt.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_rdwt.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_rdwt.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5DatasetRead.java">Java</a> Python
</td>
<td>
</td>
</tr>
<tr>
<td>Create an attribute
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtatt.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtatt.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtatt.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5AttributeCreate.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtatt.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtatt.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtatt.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtatt.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5AttributeCreate.java">Java</a> Python
</td>
<td>
</td>
Expand All @@ -99,7 +99,7 @@ These examples (C, C++, Fortran, Java, Python) are provided in the HDF5 source c
<tr>
<td>Create groups in a file using absolute and relative paths
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrpar.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrpar.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrpar.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5GroupAbsoluteRelativeCreate.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtgrpar.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrpar.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrpar.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrpar.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5GroupAbsoluteRelativeCreate.java">Java</a> Python
</td>
<td>
</td>
Expand Down
4 changes: 2 additions & 2 deletions doxygen/dox/LearnBasics3.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,15 +968,15 @@ 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 <a href="https://\SRCURL/release_docs/USING_CMake_examples.txt">Using CMake to Build Applications</a> to build applications with different languages and options.
See <a href="https://\SRCURL/release_docs/USING_CMake_Examples.txt">Using CMake to Build Applications</a> 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.

\subsection subsecLBCompilingCMakeExamples HDF5 Examples
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 <a href="https://\SRCURL/HDF5Examples">HDF5 Examples</a> in the HDF5 github repository.

Go into the share directory and follow the instructions in <a href="https://\SRCURL/release_docs/USING_CMake_examples.txt">Using CMake to Build Examples</a> to build the examples.
Go into the share directory and follow the instructions in <a href="https://\SRCURL/release_docs/USING_CMake_Examples.txt">Using CMake to Build Examples</a> 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:
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/Overview.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ documents cover a mix of tasks, concepts, and reference, to help a specific
<em>audience</em> succeed.

\par Offline reading
You can <a href="https://\DWNURL/hdf5-1.14.5.doxygen.zip">download</a> it as an archive for offline reading.
You can <a href="https://\RELURL/v1_14/v1_14_5/hdf5-1.14.5.doxygen.zip">download</a> it as an archive for offline reading.

\par ToDo List
There is plenty of <a href="./todo.html">unfinished business</a>.
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/TechnicalNotes.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<a href="https://docs.hdfgroup.org/documentation/HDF5/features/SWMR/HDF5_SWMR_Users_Guide.pdf">SWMR User Guide</a>
<a href="https://\DOCURL/features/SWMR/HDF5_SWMR_Users_Guide.pdf">SWMR User Guide</a>

\subsubsection subsubsec_swmr_doc_apis HDF5 Library APIs
<ul>
Expand Down
9 changes: 3 additions & 6 deletions doxygen/hdf5_footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,15 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
<li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion
$generatedby&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
</small></address>
</div><!-- doc-content -->
<!--END !GENERATE_TREEVIEW-->

</body>
Expand Down
4 changes: 4 additions & 0 deletions doxygen/hdf5_header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN FULL_SIDEBAR-->
<script type="text/javascript">var page_layout=1;</script>
<!--END FULL_SIDEBAR-->
<!--END DISABLE_INDEX-->
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
Expand Down
Loading