Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
- Added File Image Operations to Technical Notes
- Fixed a few more link
  • Loading branch information
bmribler committed Apr 15, 2024
1 parent 84fac90 commit c39294a
Show file tree
Hide file tree
Showing 5 changed files with 1,357 additions and 4 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/display/HDF5/Introduction+to+the+Virtual+Dataset++-+VDS">Introduction to the Virtual Dataset - VDS</a>
\li <a href="https://docs.hdfgroup.org/hdf5/develop/group___s_w_m_r.html">Introduction to Single-Writer/Multiple-Reader (SWMR)</a>
\li \ref VDS
\li \ref SWMR
</td>
</tr>
<tr>
Expand Down
1 change: 0 additions & 1 deletion doxygen/dox/IntroHDF5.dox
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,6 @@ 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/develop/examples">Examples in the Source Code</a>
\li <a href="https://portal.hdfgroup.org/display/HDF5/Other+Examples">Other Examples</a>

\section secHDF5ExamplesCompile How To Compile
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
2 changes: 1 addition & 1 deletion doxygen/dox/ViewTools.dox
Original file line number Diff line number Diff line change
Expand Up @@ -997,7 +997,7 @@ In other words, it is an array of four elements, in which each element is a 3 by

This dataset is much more complex. Also note that subsetting cannot be done on Array datatypes.

See this <a href="https://docs.hdfgroup.org/hdf5/develop/_l_b_datatypes.html">section</a> for more information on the Array datatype.
See this <a href="https://docs.hdfgroup.org/hdf5/develop/_l_b_datatypes.html#title4">section</a> for more information on the Array datatype.

\subsubsection subsubsecViewToolsViewDtypes_objref Object Reference
An Object Reference is a reference to an entire object (dataset, group, or named datatype).
Expand Down
Loading

0 comments on commit c39294a

Please sign in to comment.