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

Jump to bottom

Update documentation #4403

Merged
merged 4 commits into from
Apr 16, 2024
Merged

Update documentation #4403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c39294a
Update documentation
bmribler Apr 15, 2024
3405993
Format tables
bmribler Apr 16, 2024
0051019
Fix format
bmribler Apr 16, 2024
680c602
Use a correct example location
bmribler Apr 16, 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
4 changes: 2 additions & 2 deletions doxygen/dox/GettingStarted.dox
View file
Open in desktop
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
3 changes: 1 addition & 2 deletions doxygen/dox/IntroHDF5.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,8 +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/develop/examples">Examples in the Source Code</a>
Copy link
Contributor

@byrnHDF byrnHDF Apr 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be reverted and point to the HDF5Examples source: https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples

\li <a href="https://portal.hdfgroup.org/display/HDF5/Other+Examples">Other Examples</a>
\li <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples">Other Examples</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
View file
Open in desktop
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
View file
Open in desktop
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
Loading