Skip to content

Commit

Permalink
Update documentation (HDFGroup#4403)
Browse files Browse the repository at this point in the history
- Added File Image Operations to Technical Notes

* Use a correct example location
  • Loading branch information
bmribler authored and lrknox committed Apr 22, 2024
1 parent eadb90c commit 0dfb84c
Show file tree
Hide file tree
Showing 4 changed files with 1,618 additions and 3 deletions.
4 changes: 2 additions & 2 deletions doxygen/dox/GettingStarted.dox
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ A brief introduction to Parallel HDF5. If you are new to HDF5 please see the @re
HDF5-1.10 New Features
</td>
<td>
\li <a href="https://portal.hdfgroup.org/documentation/hdf5-docs/advanced_topics/intro_VDS.html">Introduction to the Virtual Dataset - VDS</a>
\li <a href="https://portal.hdfgroup.org/documentation/hdf5-docs/advanced_topics/intro_SWMR.html">Introduction to Single-Writer/Multiple-Reader (SWMR)</a>
\li \ref VDS
\li \ref SWMR
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/IntroHDF5.dox
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ on the <a href="http://hdfeos.org/">HDF-EOS Tools and Information Center</a> pag
\section secHDF5Examples Examples
\li \ref LBExamples
\li \ref ExAPI
\li <a href="https://github.com/HDFGroup/hdf5/tree/hdf5_1_14/examples">Examples in the Source Code</a>
\li <a href="https://github.com/HDFGroup/hdf5/tree/hdf5_1_14/HDF5Examples">Examples in the Source Code</a>

\section secHDF5ExamplesCompile How To Compile
For information on compiling in C, C++ and Fortran, see: \ref LBCompiling
Expand Down
7 changes: 7 additions & 0 deletions doxygen/dox/TechnicalNotes.dox
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
\li \ref api-compat-macros
\li \ref APPDBG
\li \ref FMTDISC
\li \ref FILEIMGOPS
\li \ref FILTER
\li \ref IOFLOW
\li \ref TNMDC
Expand Down Expand Up @@ -37,6 +38,12 @@

*/

/** \page FILEIMGOPS HDF5 File Image Operations

\htmlinclude FileImageOps.html

*/

/** \page FILTER HDF5 Filters

\htmlinclude Filters.html
Expand Down
Loading

0 comments on commit 0dfb84c

Please sign in to comment.