mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Add navigation links to doxygen pages (#5498)
* Add navigation links to doxygen pages * Fix missing link and revert merge issues
This commit is contained in:
@@ -1044,7 +1044,7 @@ span.msoDel
|
||||
{mso-style-type:export-only;
|
||||
margin-bottom:8.0pt;
|
||||
line-height:107%;}
|
||||
@page WordSection1
|
||||
\page WordSection1
|
||||
{size:11.0in 8.5in;
|
||||
mso-page-orientation:landscape;
|
||||
margin:1.0in 1.0in 1.0in 1.0in;
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page About About
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
\section about_history History
|
||||
|
||||
The implementation of this documentation set is based on the fantastic work of the
|
||||
@@ -113,4 +116,6 @@ be
|
||||
https://\RFCURL/my_great_rfc_name.pdf
|
||||
\endverbatim
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
|
||||
/** \page APPDBG Debugging HDF5 Applications
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_adddbg_intro Introduction
|
||||
The HDF5 library contains a number of debugging features to make programmers' lives
|
||||
easier including the ability to print detailed error messages, check invariant
|
||||
@@ -155,4 +158,7 @@ and spaces is sent to file descriptor 255 which should be redirected by the shel
|
||||
</table>
|
||||
The components of the HDF5_DEBUG value may be separated by any non-lowercase letter.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page collective_calls Collective Calling Requirements in Parallel HDF5 Applications
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_collective_calls_intro Introduction
|
||||
* This document addresses two topics of concern
|
||||
@@ -1261,5 +1264,8 @@
|
||||
</table>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
/** \page collective_metadata_io Collective Metadata I/O
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref TN
|
||||
* <hr>
|
||||
*
|
||||
* The purpose of this page is to briefly describe the new HDF5 Collective Metadata I/O feature and
|
||||
* provide a gateway to available documentation. The page includes the following sections:
|
||||
* <ul>
|
||||
@@ -245,4 +249,7 @@
|
||||
* or all the above functions with an extra property list parameter to allow an individual setting
|
||||
* for the collective calling requirement.
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref TN
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page Cookbook Cookbook
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
Healthy, everyday recipes for every taste and budget...
|
||||
|
||||
\ref Files
|
||||
@@ -20,4 +23,7 @@ Healthy, everyday recipes for every taste and budget...
|
||||
\li \ref sec_cmake_presets_build
|
||||
\li \ref sec_cmake_presets_files
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page copying_committed Copying Committed Datatypes with H5Ocopy
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
* <hr>
|
||||
* HDF5 Release 1.8.9 May 2012
|
||||
*
|
||||
* \section sec_copying_committed_datatypes Copying Committed Datatypes with H5Ocopy
|
||||
@@ -139,5 +142,8 @@
|
||||
* \li #H5Pget_mcdt_search_cb
|
||||
*
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page DDLBNF110 DDL in BNF through HDF5 1.10
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
\section intro110 Introduction
|
||||
|
||||
This document contains the data description language (DDL) for an HDF5 file. The
|
||||
@@ -645,4 +648,7 @@ GROUP "/" {
|
||||
}
|
||||
\endcode
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page DDLBNF112 DDL in BNF for HDF5 1.12 through HDF5 1.14.3
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
\section intro112 Introduction
|
||||
|
||||
This document contains the data description language (DDL) for an HDF5 file. The
|
||||
@@ -648,4 +651,7 @@ GROUP "/" {
|
||||
}
|
||||
\endcode
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page DDLBNF114 DDL in BNF for HDF5 1.14.4 and above
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
\section intro114 Introduction
|
||||
|
||||
This document contains the data description language (DDL) for an HDF5 file. The
|
||||
@@ -649,4 +652,7 @@ GROUP "/" {
|
||||
}
|
||||
\endcode
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page DDLBNF200 DDL in BNF for HDF5 2.0.0 and above
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
\todo Revise this & break it up!
|
||||
|
||||
\section intro200 Introduction
|
||||
@@ -664,4 +667,7 @@ GROUP "/" {
|
||||
}
|
||||
\endcode
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page ExAPI Examples by API
|
||||
/** \page ExAPI Examples by API
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
<hr>
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
/** \page FTS Full-Text Search
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
\htmlonly
|
||||
<script async src="https://cse.google.com/cse.js?cx=f671574fa55cc44e6"></script>
|
||||
<div class="gcse-search"></div>
|
||||
\endhtmlonly
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
|
||||
/** \page FMTDISC HDF5 File Format Discussion
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>Document's Audience:</dt>
|
||||
@@ -1110,5 +1113,8 @@ Message 5...
|
||||
<no info="" for="" this="" message="">
|
||||
\endcode
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
/** \page freeing_memory Freeing Memory Allocated by the HDF5 Library
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
* <hr>
|
||||
*
|
||||
* Several functions in the HDF5 C API return buffers allocated by the HDF5 Library. When
|
||||
* application code uses a different library for memory management than the HDF Library,
|
||||
* a corrupt heap or a resource leak can occur when these allocated buffers are freed. This
|
||||
@@ -97,5 +101,8 @@
|
||||
* created that return libraryallocated memory. The preferred mechanism will still be to use the
|
||||
* "preliminary call" scheme described in the "Introduction" on page 4 where the user allocates the buffer.
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page GettingStarted Getting Started with HDF5
|
||||
/** \page GettingStarted Getting Started with HDF5
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page GLS Glossary
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
\section GLS_A A
|
||||
|
||||
<DL>
|
||||
@@ -571,4 +574,7 @@ and an HDF5 path name in that file.</DD>
|
||||
<DD></DD>
|
||||
</DL>
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
|
||||
/** \page FMT1 HDF5 File Format Specification Version 1.0
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
<ol type="I">
|
||||
<li> @ref sec_fmt1_intro</li>
|
||||
<li> @ref sec_fmt1_boot</li>
|
||||
@@ -2466,4 +2470,7 @@ the first field included and a [pointer to the] string name for the last field).
|
||||
Data of a compound datatype is stored as a contiguous stream of the items in the structure, with each
|
||||
item formatted according to its datatype.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
|
||||
/** \page FMT11 HDF5 File Format Specification Version 1.1
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
<ol type="I">
|
||||
<li> @ref sec_fmt11_intro</li>
|
||||
<li> @ref sec_fmt11_meta
|
||||
@@ -3884,4 +3888,7 @@ i.e. <code>0xffff...ff</code>.
|
||||
\anchor FMT11UnlimitedDim The "unlimited size" for a size is a value with all bits set,
|
||||
i.e. <code>0xffff...ff</code>.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
|
||||
/** \page FMT2 HDF5 File Format Specification Version 2.0
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
<ol type="I">
|
||||
<li> @ref sec_fmt2_intro
|
||||
<ol type="A">
|
||||
@@ -9282,4 +9286,7 @@ Allocation types that are mapped to basic allocation types are described below:
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
|
||||
/** \page FMT3 HDF5 File Format Specification Version 3.0
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
<ol type="I">
|
||||
<li> @ref sec_fmt3_intro
|
||||
<ol type="A">
|
||||
@@ -12588,4 +12592,7 @@ raw data in the file. The global heap ID is used to locate the reference encodin
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
/** \page CompTS HDF5 Compression Troubleshooting
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
The purpose of this technical note is to help HDF5 users with troubleshooting problems
|
||||
with \ref H5Z_UG, especially with compression filters. The document assumes that the
|
||||
reader knows HDF5 basics and is aware of the compression feature in HDF5.
|
||||
@@ -655,4 +659,7 @@ See the following documents published by The HDF Group for more information.
|
||||
\li The “Filter Behavior in HDF5” note is part of the #H5Pset_filter function call entry. See
|
||||
the \ref H5P in the \ref RM.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
@@ -1,4 +1,8 @@
|
||||
/** \page improve_compressed_perf Improving I/O Performance When Working with HDF5 Compressed Datasets
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref TN
|
||||
* <hr>
|
||||
*
|
||||
* Internal compression is one of several powerful HDF5 features that distinguish HDF5
|
||||
* from other binary formats and make it very attractive for storing and organizing data.
|
||||
* Internal HDF5 compression saves storage space and I/O bandwidth and allows efficient
|
||||
@@ -643,4 +647,7 @@
|
||||
* chosen when creating files and investigation of possible solutions when performance problems are
|
||||
* encountered.
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref TN
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
/** \page IOFLOW HDF5 Raw I/O Flow Notes
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\li Created by Quincey Koziol, August 20, 2003
|
||||
\li Document's Audience: Current H5 library designers and knowledgeable external developers.
|
||||
|
||||
@@ -94,5 +98,8 @@ This section provides notes to augment the information in the accompanying figur
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
|
||||
/** \page IMG HDF5 Image and Palette Specification Version 1.2
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
The HDF5 specification defines the standard objects and storage for the
|
||||
standard HDF5 objects. (For information about the HDF5 library, model and
|
||||
@@ -707,4 +709,7 @@ have a "YUV" Palette in its <b>PALETTE</b> attribute array. This
|
||||
would be a legal HDF5 file and also conforms to this specification, although
|
||||
it may or may not be correct for a given application.</p>
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page IntroHDF5 Introduction to HDF5
|
||||
/** \page IntroHDF5 Introduction to HDF5
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
<hr>
|
||||
@@ -607,7 +607,11 @@ to it and then close it in separate steps:
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
|
||||
|
||||
@page HDF5Examples HDF5 Examples
|
||||
\page HDF5Examples HDF5 Examples
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
<hr>
|
||||
|
||||
Example programs of how to use HDF5 are provided below.
|
||||
For HDF-EOS specific examples, see the <a href="http://hdfeos.org/zoo/index.php">examples</a>
|
||||
of how to access and visualize NASA HDF-EOS files using Python, IDL, MATLAB, and NCL
|
||||
@@ -631,4 +635,7 @@ These (very old) examples resulted from working with users, and are not fully te
|
||||
<a href="https://\AEXURL/special_values_HDF5_example.tar">Using Special Values</a>
|
||||
These examples show how to create special values in an HDF5 application.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page IntroParContHyperslab Writing by Contiguous Hyperslab
|
||||
/** \page IntroParContHyperslab Writing by Contiguous Hyperslab
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
<hr>
|
||||
@@ -217,7 +217,7 @@ displayed in columns if it was printed using Fortran 90 code.
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
|
||||
@page IntroParRegularSpaced Writing by Regularly Spaced Data
|
||||
\page IntroParRegularSpaced Writing by Regularly Spaced Data
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
<hr>
|
||||
@@ -357,7 +357,7 @@ because \ref sec_cltools_h5dump is written in C. The data would be displayed in
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
|
||||
@page IntroParPattern Writing by Pattern
|
||||
\page IntroParPattern Writing by Pattern
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
<hr>
|
||||
@@ -468,7 +468,7 @@ The \ref sec_cltools_h5dump utility is written in C so the output is in C order.
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
|
||||
@page IntroParChunk Writing by Chunk
|
||||
\page IntroParChunk Writing by Chunk
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref IntroParHDF5
|
||||
<hr>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page IntroParHDF5 A Brief Introduction to Parallel HDF5
|
||||
/** \page IntroParHDF5 A Brief Introduction to Parallel HDF5
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
<hr>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page LearnBasics Learning the Basics
|
||||
/** \page LearnBasics Learning the Basics
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
<hr>
|
||||
@@ -36,7 +36,7 @@ page and in the HDF5 source code (C, C++, Fortran).
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
|
||||
|
||||
@page LBExamples Examples from Learning the Basics
|
||||
\page LBExamples Examples from Learning the Basics
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page LBFileOrg HDF5 File Organization
|
||||
/** \page LBFileOrg HDF5 File Organization
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
@@ -26,7 +26,7 @@ Next Chapter \ref LBAPI
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBAPI The HDF5 API
|
||||
\page LBAPI The HDF5 API
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
@@ -143,7 +143,7 @@ Previous Chapter \ref LBFileOrg - Next Chapter \ref LBProg
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBProg Programming Issues
|
||||
\page LBProg Programming Issues
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
@@ -226,7 +226,7 @@ Previous Chapter \ref LBAPI - Next Chapter \ref LBFileCreate
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBFileCreate Creating an HDF5 File
|
||||
\page LBFileCreate Creating an HDF5 File
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
@@ -425,7 +425,7 @@ Previous Chapter \ref LBProg - Next Chapter \ref LBDsetCreate
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBDsetCreate Creating a Dataset
|
||||
\page LBDsetCreate Creating a Dataset
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -745,7 +745,7 @@ Previous Chapter \ref LBFileCreate - Next Chapter \ref LBDsetRW
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBDsetRW Reading From and Writing To a Dataset
|
||||
\page LBDsetRW Reading From and Writing To a Dataset
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -887,7 +887,7 @@ Previous Chapter \ref LBDsetCreate - Next Chapter \ref LBAttrCreate
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBAttrCreate Creating an Attribute
|
||||
\page LBAttrCreate Creating an Attribute
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page LBGrpCreate Creating an Group
|
||||
/** \page LBGrpCreate Creating an Group
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -67,7 +67,7 @@ Previous Chapter \ref LBAttrCreate - Next Chapter \ref LBGrpCreateNames
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBGrpCreateNames Creating Groups using Absolute and Relative Names
|
||||
\page LBGrpCreateNames Creating Groups using Absolute and Relative Names
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -199,7 +199,7 @@ Previous Chapter \ref LBGrpCreate - Next Chapter \ref LBGrpDset
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBGrpDset Creating Datasets in Groups
|
||||
\page LBGrpDset Creating Datasets in Groups
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -310,7 +310,7 @@ Previous Chapter \ref LBGrpCreateNames - Next Chapter \ref LBDsetSubRW
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBDsetSubRW Reading From or Writing To a Subset of a Dataset
|
||||
\page LBDsetSubRW Reading From or Writing To a Subset of a Dataset
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -491,7 +491,7 @@ Previous Chapter \ref LBGrpDset - Next Chapter \ref LBDatatypes
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBDatatypes Datatype Basics
|
||||
\page LBDatatypes Datatype Basics
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page LBPropsList Property Lists Basics
|
||||
/** \page LBPropsList Property Lists Basics
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -43,7 +43,7 @@ Previous Chapter \ref LBDatatypes - Next Chapter \ref LBDsetLayout
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBDsetLayout Dataset Storage Layout
|
||||
\page LBDsetLayout Dataset Storage Layout
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -192,7 +192,7 @@ Previous Chapter \ref LBPropsList - Next Chapter \ref LBExtDset
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
|
||||
@page LBExtDset Extendible Datasets
|
||||
\page LBExtDset Extendible Datasets
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -238,7 +238,7 @@ Previous Chapter \ref LBDsetLayout - Next Chapter \ref LBComDset
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBComDset Compressed Datasets
|
||||
\page LBComDset Compressed Datasets
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -282,7 +282,7 @@ Previous Chapter \ref LBExtDset - Next Chapter \ref LBContents
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBContents Discovering the Contents of an HDF5 File
|
||||
\page LBContents Discovering the Contents of an HDF5 File
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -328,7 +328,7 @@ Previous Chapter \ref LBComDset - Next Chapter \ref LBQuiz
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBQuiz Learning the basics QUIZ
|
||||
\page LBQuiz Learning the basics QUIZ
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -426,7 +426,7 @@ Previous Chapter \ref LBContents - Next Chapter \ref LBQuizAnswers
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBQuizAnswers Learning the basics QUIZ with Answers
|
||||
\page LBQuizAnswers Learning the basics QUIZ with Answers
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
@@ -721,7 +721,7 @@ Previous Chapter \ref LBQuiz - Next Chapter \ref LBCompiling
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
|
||||
@page LBCompiling Compiling HDF5 Applications
|
||||
\page LBCompiling Compiling HDF5 Applications
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page LearnHDFView Learning HDF5 with HDFView
|
||||
/** \page LearnHDFView Learning HDF5 with HDFView
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
<hr>
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page TNMDC Metadata Caching in HDF5
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\todo Revise this!
|
||||
|
||||
\section intro Introduction
|
||||
@@ -1017,4 +1020,7 @@ and the average successful and unsuccessful search depths in the hash table. If
|
||||
these latter figures are significantly above 1, you should increase the size of
|
||||
the hash table.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page mod_region_writes Modified Region Writes
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
* <hr>
|
||||
*
|
||||
* The Core virtual file driver allows the manipulating of HDF5 files in memory instead of in
|
||||
* physical storage. In previous versions, changing any part of a file in memory meant the
|
||||
@@ -118,4 +121,7 @@
|
||||
* \ref sec_file chapter in the \ref UG.
|
||||
*
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
*
|
||||
*/
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page predefined_datatypes_tables HDF5 Predefined Datatypes
|
||||
*
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref RM
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_predefined_datatypes_tables HDF5 Predefined Datatypes
|
||||
*
|
||||
* The following datatypes are predefined in HDF5.
|
||||
@@ -10,36 +13,40 @@
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_complex_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
*
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_std_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
*
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_unix_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
*
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_string_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
*
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_intel_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
*
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_dec_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
*
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_mips_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
*
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_native_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
*
|
||||
* <div>
|
||||
* \snippet{doc} tables/predefinedDatatypes.dox predefined_c9x_datatypes_table
|
||||
* </div>
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref SPEC
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page RFC RFCs
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
<table>
|
||||
<tr><th>RFC ID</th><th>Title</th></tr>
|
||||
<tr> <td>2022-08-19</td> <td>\ref_rfc20220819</td></tr>
|
||||
@@ -101,4 +104,7 @@
|
||||
<tr> <td>2004-08-11</td> <td>\ref_rfc20040811</td></tr>
|
||||
</table>
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page RM HDF5 Reference Manual
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
The functions provided by the HDF5 API are grouped into the following
|
||||
\Emph{modules}:
|
||||
|
||||
@@ -178,4 +181,7 @@ Follow these simple rules and stay out of trouble:
|
||||
<a href="https://github.com/HDFGroup/hdf5/pulls">pull request</a> !\n
|
||||
See the \ref RMT for general guidance.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
|
||||
/** \page RELVERSION HDF5 Library Release Version Numbers
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_relver_intro Introduction
|
||||
HDF5 software is updated on a regular basis. These updates, known
|
||||
as releases, range in scope and size from small to large. Some updates
|
||||
@@ -261,4 +264,8 @@ compatibility is unrelated to the HDF5 release version for a given
|
||||
release.
|
||||
|
||||
@see BRANCHEXPL
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
|
||||
/** \page SWMRTN Introduction to Single-Writer/Multiple-Reader (SWMR)
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_swmr_intro Introduction to SWMR
|
||||
The Single-Writer / Multiple-Reader (SWMR) feature enables multiple processes to read an HDF5 file
|
||||
while it is being written to (by a single process) without using locks or requiring communication between processes.
|
||||
@@ -143,4 +146,7 @@ will see valid data displayed with h5watch.
|
||||
\li View the file with \ref sec_cltools_h5dump. You will see that it is a valid file even though the application did not
|
||||
close properly. It will contain data up to the point that it was interrupted.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page SPEC Specifications
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
\section sec_spec_ddl DDL
|
||||
|
||||
\li \ref DDLBNF110
|
||||
@@ -20,4 +23,7 @@
|
||||
\li \ref TBLSPEC
|
||||
\li \ref sec_dim_scales_spec
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
|
||||
/** \page TBLSPEC HDF5 Table Specification Version 1.0
|
||||
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
<hr>
|
||||
|
||||
The HDF5 specification defines the standard objects and storage for the standard HDF5
|
||||
objects. (For information about the HDF5 library, model and specification, see the HDF
|
||||
documentation.) This document is an additional specification to define a standard profile
|
||||
@@ -96,5 +100,7 @@ status = H5Fclose(file_id);
|
||||
|
||||
For more information see the @ref H5TB reference manual page and the @ref H5TB_UG, which includes examples.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref SPEC
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page TN Technical Notes
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
\li \ref api-compat-macros
|
||||
\li \ref APPDBG
|
||||
\li \ref FMTDISC
|
||||
@@ -26,5 +29,8 @@
|
||||
\li \ref VOL_Connector
|
||||
\li \ref CMakeVols
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page thread-safe-lib Thread Safe Library
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_tsafe_compilation Library header files and conditional compilation
|
||||
The following code is placed at the beginning of H5private.h:
|
||||
\code
|
||||
@@ -563,4 +566,7 @@ created) or if the wrong values were read back.
|
||||
}
|
||||
\endcode
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
/** @page CommandTools Command Line Tools for HDF5 Files
|
||||
/** \page CommandTools Command Line Tools for HDF5 Files
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
Navigate back: \ref index "Main" / \ref UG
|
||||
<hr>
|
||||
|
||||
|
||||
\section sec_cltools Command Line Tools for HDF5 Files
|
||||
There are several command line tools provided with HDF5.
|
||||
\li \ref sec_cltools_h5copy
|
||||
\li \ref sec_cltools_h5diff
|
||||
@@ -24,6 +23,6 @@ There are several command line tools provided with HDF5.
|
||||
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
Navigate back: \ref index "Main" / \ref UG
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page LBTraining Training Videos
|
||||
/** \page LBTraining Training Videos
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
|
||||
<hr>
|
||||
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
|
||||
/** \page UNICODE Using UTF-8 Encoding in HDF5 Applications
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_unicode_intro Introduction
|
||||
Text and character data are often discussed as though text means ASCII text. We even go so far as
|
||||
to call a file containing only ASCII text a plain text file. This works reasonably well for English
|
||||
@@ -142,4 +145,7 @@ ASCII or UTF-8, the two encodings will be indistinguishable, and the encodings w
|
||||
<h3>NOTES</h3>
|
||||
1. UTF-8 is the only Unicode standard encoding supported in HDF5.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page UG HDF5 User Guide
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
<hr>
|
||||
|
||||
\ref sec_data_model
|
||||
\li \ref subsec_data_model_intro
|
||||
\li \ref subsec_data_model_abstract
|
||||
@@ -335,6 +338,10 @@
|
||||
|
||||
\ref sec_map
|
||||
|
||||
\ref sec_reference
|
||||
|
||||
\ref sec_filter_plugins
|
||||
|
||||
\section sec_hl HDF5 High Level APIs
|
||||
\li \ref H5DO_UG
|
||||
<ul>
|
||||
@@ -352,7 +359,7 @@
|
||||
\li \ref H5TB_UG
|
||||
\li \ref H5PT_UG
|
||||
|
||||
\ref sec_cltools
|
||||
\section sec_cltools Command Line Tools for HDF5 Files
|
||||
\li \ref H5TOOL_CP_UG
|
||||
\li \ref H5TOOL_DF_UG
|
||||
\li \ref H5TOOL_DP_UG
|
||||
@@ -372,8 +379,14 @@
|
||||
|
||||
\ref sec_addition
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main"
|
||||
|
||||
\page AR_UG Additional Resources
|
||||
|
||||
Navigate back: \ref index "Main" / \ref UG
|
||||
<hr>
|
||||
|
||||
\section sec_addition Additional Resources
|
||||
These documents provide additional information for the use and tuning of specific HDF5 features.
|
||||
<table style=" border-spacing:0; padding-left:6.00pt; padding-top:6.00pt; padding-right:6.00pt; padding-bottom:6.00pt; float:aligncenter; width:100%; max-width:432.00pt;" cellspacing="0">
|
||||
@@ -484,12 +497,13 @@ These documents provide additional information for the use and tuning of specifi
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Previous Chapter \ref sec_plist
|
||||
|
||||
\par Don't like what you see? - You can help to improve this User Guide
|
||||
Complete the survey linked near the top of this page!\n
|
||||
We treat documentation like code: Fork the
|
||||
<a href="https://github.com/HDFGroup/hdf5">HDF5 repo</a>, make changes, and create a
|
||||
<a href="https://github.com/HDFGroup/hdf5/pulls">pull request</a> !\n
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref UG
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page UsingIdentifiers Using Identifiers
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_using_identifiers Using Identifiers
|
||||
*
|
||||
@@ -94,4 +97,7 @@
|
||||
* \li #H5Tget_member_type
|
||||
* \li #H5Tget_super
|
||||
* \li #H5Topen
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
|
||||
/** \page VDSTN Introduction to the Virtual Dataset - VDS
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_vds_intro Introduction to VDS
|
||||
The HDF5 Virtual Dataset (VDS) feature enables users to access data in a collection of HDF5 files as a
|
||||
single HDF5 dataset and to use the HDF5 APIs to work with that dataset.
|
||||
@@ -112,4 +115,7 @@ on the vds.h5 file created in Example 1.You can see that the entire source file
|
||||
|
||||
<img src="tutrvds-map.png" alt="tutrvds-map.png" width=650>
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
|
||||
/** \page VFLTN HDF5 Virtual File Layer
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_vfl_intro Introduction
|
||||
The HDF5 file format describes how HDF5 data structures and dataset raw data are mapped
|
||||
to a linear format address space and the HDF5 library implements that bidirectional mapping
|
||||
@@ -1022,4 +1025,7 @@ statistics as it passes all requests through to the MPI-IO driver. Therefore we
|
||||
a function which takes a format address and or object type and returns the driver which would have
|
||||
been used at the lowest level to process the request.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/** \page VOL_Connector HDF5 Virtual Object Layer (VOL) Connector Author Guide
|
||||
|
||||
Navigate back: \ref index "Main"
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section secVOLIntro Introduction
|
||||
@@ -4876,5 +4876,5 @@ H5_DLL herr_t H5VLoptional(void *obj, hid_t connector_id, H5VL_optional_args_t *
|
||||
\endcode
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref VOL_Connector
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page ViewTools Tools for Viewing and Editing HDF5 Files
|
||||
/** \page ViewTools Tools for Viewing and Editing HDF5 Files
|
||||
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
<hr>
|
||||
@@ -42,7 +42,7 @@ The following are basic facts about HDF5 files to keep in mind while completing
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
|
||||
@page ViewToolsCommand Command-line Tools
|
||||
\page ViewToolsCommand Command-line Tools
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
<hr>
|
||||
|
||||
@@ -158,7 +158,7 @@ does not cover all of the HDF5 tools.
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted
|
||||
|
||||
@page ViewToolsView Command-line Tools For Viewing HDF5 Files
|
||||
\page ViewToolsView Command-line Tools For Viewing HDF5 Files
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref ViewToolsCommand
|
||||
<hr>
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page ViewToolsEdit Command-line Tools For Editing HDF5 Files
|
||||
/** \page ViewToolsEdit Command-line Tools For Editing HDF5 Files
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref ViewToolsCommand
|
||||
<hr>
|
||||
|
||||
@@ -472,7 +472,7 @@ Navigate back: \ref index "Main" / \ref GettingStarted / \ref ViewToolsCommand
|
||||
|
||||
*/
|
||||
|
||||
/** @page ViewToolsConvert Command-line Tools For Converting HDF5 Files
|
||||
/** \page ViewToolsConvert Command-line Tools For Converting HDF5 Files
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref ViewToolsCommand
|
||||
<hr>
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @page ViewToolsJPSS Use Case: Examining a JPSS NPP File With HDF5 Tools
|
||||
/** \page ViewToolsJPSS Use Case: Examining a JPSS NPP File With HDF5 Tools
|
||||
Navigate back: \ref index "Main" / \ref GettingStarted / \ref ViewToolsCommand
|
||||
<hr>
|
||||
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page api-compat-macros API Compatibility Macros
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section audience Audience
|
||||
The target audience for this document has existing applications that use the
|
||||
HDF5 library, and is considering moving to the latest HDF5 release to take
|
||||
@@ -895,4 +898,7 @@
|
||||
the application migration process.</li>
|
||||
</ol>
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page BRANCHEXPL HDF5 Git Branching Model Explained
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
This document describes current HDF5 branches.
|
||||
|
||||
Branches are tested nightly and testing results are available at
|
||||
@@ -60,4 +63,7 @@ are usually not kept in sync with the develop branch.
|
||||
|
||||
As for feature branches, inactive branches should have a BRANCH.md file as described above.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page hdf5_chunking Chunking in HDF5
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_hdf5_chunking_intro Introduction
|
||||
* Datasets in HDF5 not only provide a convenient, structured, and self-describing way to store data,
|
||||
@@ -395,4 +398,7 @@
|
||||
* the edge of a dataset, only storing the used portions of these edge chunks, and allowing multiple reader processes to read the same
|
||||
* dataset as a single writer process writes to it.
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref AR_UG
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page CMakeVols HDF5 Building and testing HDF5 VOL connectors with CMake FetchContent
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_cmakevols_intro Introduction
|
||||
This document details the process of using CMake options to build and test
|
||||
an HDF5 VOL connector alongside the HDF5 library when building HDF5 from
|
||||
@@ -214,5 +217,8 @@ or similar, one should ensure that those environment variables are set before
|
||||
running tests. Otherwise, the tests that run with that connector will likely
|
||||
fail due to being unable to load the necessary libraries for its dependencies.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page CODECONV HDF5 Library Code Conventions
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
This document describes some practices that are new, or newly
|
||||
documented, starting in 2020.
|
||||
|
||||
@@ -55,4 +58,7 @@ purpose:
|
||||
|
||||
Some attributes may be phased in or phased out in the future.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page Accessibility
|
||||
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
<hr>
|
||||
|
||||
\section secAccessibility Accessibility
|
||||
|
||||
\subsection CB_MaintainCompat Maintaining Compatibility with other HDF5 Library Versions
|
||||
@@ -36,4 +39,7 @@ do not contain features introduced in later versions (forward compatibility).
|
||||
See the recipe \ref CB_LargeAttributes for an example where we use HDF5
|
||||
compatibility settings to enable the creation of large HDF5 attributes.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
|
||||
*/
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page Attributes
|
||||
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
<hr>
|
||||
|
||||
\section secAttributes Attributes
|
||||
|
||||
\subsection CB_LargeAttributes Creating "Large" HDF5 Attributes
|
||||
@@ -35,4 +38,7 @@ case, for at least two reasons:
|
||||
\par See Also
|
||||
See \ref CB_MaintainCompat for HDF5 compatibility implications.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
|
||||
*/
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page Files
|
||||
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
<hr>
|
||||
|
||||
\section secFiles Files
|
||||
|
||||
\subsection CB_FreeSpace Tracking Free Space in HDF5 Files
|
||||
@@ -68,4 +71,7 @@ try to truncate the rest of the file and destroy the HDF5 portion of the file.
|
||||
\par See Also
|
||||
References to related recipes
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page Performance
|
||||
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
<hr>
|
||||
|
||||
\section secPerformance Performance
|
||||
|
||||
\subsection CB_MDCPerf Assessing HDF5 Metadata Cache Performance
|
||||
@@ -18,4 +21,7 @@ A discussion of the fine points and variants of the solution
|
||||
\par See Also
|
||||
References to related recipes
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
|
||||
*/
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page cmake-presets Building with CMake Presets
|
||||
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
<hr>
|
||||
|
||||
\section sec_cmake_presets_build Building HDF5 with CMake
|
||||
|
||||
\par Problem
|
||||
@@ -636,4 +639,7 @@ The ci-base preset sets the following CMake variables:
|
||||
\li "binaryDir": "${sourceParentDir}/build/${presetName}"
|
||||
\li "installDir": "${sourceParentDir}/install/${presetName}"
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref Cookbook
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page FileLock HDF5 File Locking in HDF5
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_filelock_intro Introduction
|
||||
This document describes the file locking scheme that was added to HDF5 in
|
||||
version 1.10.0 and how you can work around it, if you choose to do so. I'll
|
||||
@@ -331,5 +334,8 @@ about files being locked forever if a process exits abnormally. If a writer
|
||||
crashed and the library didn't clear the superblock mark, you can remove it with
|
||||
the \ref sec_cltools_h5clear command-line tool, which is built with the library.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page rel_spec_110 Release Specific Information for HDF5 1.10
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info
|
||||
* <hr>
|
||||
|
||||
\section sec_rel_spec_110_migrate Migrating from HDF5 1.8 to HDF5 1.10
|
||||
The HDF Group will drop support for HDF5 1.8.\* releases in the summer of 2020. We strongly recommend
|
||||
@@ -381,5 +384,8 @@ RFCs for the new features in HDF5-1.10:
|
||||
\li \ref_rfc20160105
|
||||
|
||||
\ref rel_spec_110_change
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page rel_spec_112 Release Specific Information for HDF5 1.12
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info
|
||||
* <hr>
|
||||
|
||||
\section sec_rel_spec_112_migrate Migrating from HDF5 1.10 to HDF5 1.12
|
||||
Also see the video presentation:
|
||||
@@ -143,5 +146,8 @@ See Update to Selections for more details.
|
||||
\li \ref subsec_rel_spec_112_feat_hyper
|
||||
|
||||
\ref rel_spec_112_change
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page rel_spec_114 Release Specific Information for HDF5 1.14
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info
|
||||
* <hr>
|
||||
|
||||
\section sec_rel_spec_114_migrate Migrating from HDF5 1.12 to HDF5 1.14
|
||||
# Migrating to HDF5 1.14 from Previous Versions of HDF5
|
||||
@@ -92,4 +95,8 @@ that were released in 1.13.0-1.13.3.
|
||||
|
||||
\ref sec_rel_spec_114_change
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page rel_spec_18 Release Specific Information for HDF5 1.8
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info
|
||||
* <hr>
|
||||
|
||||
\section sec_rel_spec_18_change Software Changes from Release to Release for HDF5-1.8
|
||||
This document is designed to help developers maintain HDF5-based applications as they are used with
|
||||
@@ -2313,4 +2316,8 @@ Additional new "influential environment variables" in this release include the f
|
||||
\li F77
|
||||
\li FFLAGS
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \defgroup H5LR Extensions
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref RM
|
||||
* <hr>
|
||||
*
|
||||
* <em>Working with region references, hyperslab selections,
|
||||
* and bit-fields (H5LR, H5LT)</em>
|
||||
@@ -607,6 +610,9 @@ H5_HLRDLL herr_t H5LTread_region(const char *file,
|
||||
*
|
||||
* \since 1.0
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref RM
|
||||
*
|
||||
*/
|
||||
H5_HLRDLL herr_t H5LTread_bitfield_value(hid_t dset_id, int num_values, const unsigned *offset,
|
||||
const unsigned *lengths, hid_t space, int *buf);
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page InitShut HDF5 Library initialization and shutdown
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_initshut_app Application perspective
|
||||
|
||||
\subsection subsec_initshut_app_implicit Implicit initialization and shutdown
|
||||
@@ -52,4 +55,7 @@ table are marked as "barriers," and if a new module should only be
|
||||
shutdown <strong>strictly after</strong> the preceding modules, then it should be marked
|
||||
as a barrier. See the comments in <code>H5_term_library</code> for more information.
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page ParCompr HDF5 Parallel Compression
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
\section sec_parcompr_intro Introduction
|
||||
When an HDF5 dataset is created, the application can specify
|
||||
optional data filters to be applied to the dataset (as long as
|
||||
@@ -332,4 +335,7 @@ hid_t file_id = H5Fcreate("file.h5", H5F_ACC_TRUNC, H5P_DEFAULT, fapl_id);
|
||||
...
|
||||
\endcode
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page release_specific_info Release Specific Information
|
||||
*
|
||||
* Navigate back: \ref index "Main"
|
||||
* <hr>
|
||||
|
||||
\ref rel_spec_114
|
||||
\li \ref sec_rel_spec_114_feat
|
||||
@@ -19,5 +22,8 @@
|
||||
\li \ref sec_rel_spec_18_change
|
||||
|
||||
\ref api-compat-macros
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/** \page RMT Reference Manual (RM) Page Template
|
||||
|
||||
Navigate back: \ref index "Main" / \ref RM
|
||||
<hr>
|
||||
|
||||
We treat documentation like code and use
|
||||
<a href="https://www.doxygen.nl/index.html">Doxygen</a> to
|
||||
<a href="https://\SRCURL/src/H5Fpublic.h">markup
|
||||
@@ -96,4 +99,7 @@ the <a href="https://www.oreilly.com/library/view/97-things-every/9780596809515/
|
||||
* \version 1.MAJOR.MINOR Function was deprecated in this release
|
||||
\endverbatim
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref RM
|
||||
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page rel_spec_110_change Release Software Changes for HDF5 1.10
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_110
|
||||
* <hr>
|
||||
|
||||
\section sec_rel_spec_110_change Software Changes from Release to Release in HDF5 1.10
|
||||
For a description of the major new features that were introduced,
|
||||
@@ -656,4 +659,7 @@ so while existing code will need to be recompiled in order to use the newer libr
|
||||
these functions do not need to be changed in application code using them provided that the
|
||||
\ref api-compat-macros are configured appropriately.
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_110
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page rel_spec_112_change Release Software Changes for HDF5 1.12
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_112
|
||||
* <hr>
|
||||
|
||||
\section sec_rel_spec_112_change Software Changes from Release to Release in HDF5 1.12
|
||||
For a description of the major new features that were introduced, please see \ref sec_rel_spec_112_feat.
|
||||
@@ -210,5 +213,8 @@ See API Compatibility Macros in HDF5 for details on using HDF5 version 1.12 with
|
||||
|
||||
[Compatibility report for Release 1.12.0 versus Release 1.10.6]()
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_112
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \page rel_spec_114_change Release Software Changes for HDF5 1.14
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_114
|
||||
* <hr>
|
||||
|
||||
\section sec_rel_spec_114_change Software Changes from Release to Release in HDF5 1.14
|
||||
|
||||
@@ -253,4 +256,7 @@ Following are the new APIs introduced in HDF5-1.14.0.
|
||||
\li #H5Tcommit_async - Asynchronous version of #H5Tcommit2
|
||||
\li #H5Topen_async - Asynchronous version of #H5Topen2
|
||||
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_114
|
||||
*/
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
/** \page ThrdSafe HDF5 Threadsafety Warning
|
||||
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
<hr>
|
||||
|
||||
Any application that creates threads that use the HDF5 library must join those threads before
|
||||
either process exit or library close through H5close(). If all HDF5-using threads aren't joined,
|
||||
the threads may exhibit undefined behavior.
|
||||
@@ -37,6 +41,9 @@ The issues with this approach are as follows:
|
||||
|
||||
Despite these issues, if a more performant method was found to perform threadcounting like this,
|
||||
it might still constitute a worthwhile change.
|
||||
|
||||
|
||||
<hr>
|
||||
Navigate back: \ref index "Main" / \ref TN
|
||||
|
||||
*/
|
||||
|
||||
@@ -18,6 +18,10 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/** \page H5DO_UG HDF5 High Level Optimizations
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* Since version 1.10.3 these functions are deprecated in favor of #H5Dwrite_chunk and #H5Dread_chunk.
|
||||
*
|
||||
* \section sec_hldo_direct_chunk Direct Chunk Write Function
|
||||
@@ -228,6 +232,11 @@ extern "C" {
|
||||
* // Data verification here
|
||||
* ...
|
||||
* \endcode
|
||||
*
|
||||
* Next Chapter \ref sec_dim_scales_stand
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*/
|
||||
|
||||
/**\defgroup H5DO HDF5 Optimizations APIs (H5DO)
|
||||
|
||||
@@ -31,6 +31,9 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/** \page H5DS_UG HDF5 High Level Dimension Scales
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_dim_scales_stand HDF5 Standard for Dimension Scales
|
||||
* Dimension scales are stored as datasets, with additional metadata indicating that they are to
|
||||
@@ -751,6 +754,12 @@ extern "C" {
|
||||
* @see H5DS Reference Manual
|
||||
*
|
||||
* @todo Under Construction
|
||||
*
|
||||
* Previous Chapter \ref sec_hldo_direct_chunk - Next Chapter \ref sec_hl_images
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*
|
||||
*/
|
||||
|
||||
/**\defgroup H5DS HDF5 Dimension Scales APIs (H5DS)
|
||||
|
||||
@@ -18,7 +18,18 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/** \page H5IM_UG HDF5 High Level Images
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_hl_images HDF5 Images
|
||||
*
|
||||
* @todo Under Construction
|
||||
*
|
||||
* Previous Chapter \ref sec_dim_scales_stand - Next Chapter \ref sec_hl_lite_api
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*/
|
||||
|
||||
/**\defgroup H5IM HDF5 Images API (H5IM)
|
||||
|
||||
@@ -35,7 +35,18 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/** \page H5LT_UG HDF5 High Level Lite
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_hl_lite_api HDF5 Lite APIs
|
||||
*
|
||||
* @todo Under Construction
|
||||
*
|
||||
* Previous Chapter \ref sec_hl_images - Next Chapter \ref sec_hl_table_api
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*/
|
||||
|
||||
/**\defgroup H5LT HDF5 Lite APIs (H5LT,H5LD)
|
||||
|
||||
@@ -18,7 +18,18 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/** \page H5PT_UG HDF5 High Level Packet Table
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_hl_packet_table_api HDF5 Table APIs
|
||||
*
|
||||
* @todo Under Construction
|
||||
*
|
||||
* Previous Chapter \ref sec_hl_table_api
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*/
|
||||
|
||||
/**\defgroup H5PT HDF5 Packet Table APIs (H5PT)
|
||||
|
||||
@@ -18,7 +18,18 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/** \page H5TB_UG HDF5 High Level Table
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_hl_table_api HDF5 Table APIs
|
||||
*
|
||||
* @todo Under Construction
|
||||
*
|
||||
* Previous Chapter \ref sec_hl_lite_api - Next Chapter \ref sec_hl_packet_table_api
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*/
|
||||
|
||||
/**\defgroup H5TB HDF5 Table APIs (H5TB)
|
||||
|
||||
@@ -13,6 +13,9 @@
|
||||
#define H5WATCH_H
|
||||
|
||||
/** \page H5TOOL_WH_UG The HDF5 h5watch Tool
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref CommandTools
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_cltools_h5watch h5watch
|
||||
*
|
||||
@@ -57,6 +60,11 @@
|
||||
* \li <strong>\<path_to_dataset\></strong> Path separated by slashes to the specified dataset
|
||||
* \li <strong>\<dsetname\></strong> Name of the dataset
|
||||
*
|
||||
* Previous Chapter \ref sec_cltools_h5repart
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref CommandTools
|
||||
*
|
||||
*/
|
||||
|
||||
#endif /* H5WATCH_H */
|
||||
|
||||
@@ -61,7 +61,7 @@ import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* @page HDF5LIB HDF5 Java API Package
|
||||
* \page HDF5LIB HDF5 Java API Package
|
||||
* This class is the Java interface for the HDF5 library.
|
||||
* <p>
|
||||
* This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps
|
||||
|
||||
@@ -15,7 +15,7 @@ package hdf.hdf5lib;
|
||||
import hdf.hdf5lib.structs.H5O_token_t;
|
||||
|
||||
/**
|
||||
* @page HDF5CONST Constants and Enumerated Types
|
||||
* \page HDF5CONST Constants and Enumerated Types
|
||||
* This class contains C constants and enumerated types of HDF5 library. The
|
||||
* values of these constants are obtained from the library by calling
|
||||
* the JNI function jconstant, where jconstant is used for any of the private constants
|
||||
|
||||
@@ -18,7 +18,7 @@ import hdf.hdf5lib.exceptions.HDF5Exception;
|
||||
import hdf.hdf5lib.exceptions.HDF5JavaException;
|
||||
|
||||
/**
|
||||
* @page HDFARRAY Java Array Conversion
|
||||
* \page HDFARRAY Java Array Conversion
|
||||
* This is a class for handling multidimensional arrays for HDF.
|
||||
* <p>
|
||||
* The purpose is to allow the storage and retrieval of arbitrary array types containing scientific data.
|
||||
|
||||
@@ -16,7 +16,7 @@ import hdf.hdf5lib.exceptions.HDF5Exception;
|
||||
import hdf.hdf5lib.exceptions.HDF5JavaException;
|
||||
|
||||
/**
|
||||
* @page HDFNATIVE Native Arrays of Numbers
|
||||
* \page HDFNATIVE Native Arrays of Numbers
|
||||
* This class encapsulates native methods to deal with arrays of numbers,
|
||||
* converting from numbers to bytes and bytes to numbers.
|
||||
* <p>
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
package hdf.hdf5lib.callbacks;
|
||||
|
||||
/**
|
||||
* @page CALLBACKS HDF5 Java H5Callbacks Interface
|
||||
* \page CALLBACKS HDF5 Java H5Callbacks Interface
|
||||
* All callback definitions must derive from this interface. Any
|
||||
* derived interfaces must define a single public method named "callback".
|
||||
* You are responsible for deregistering your callback (if necessary)
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/**
|
||||
* @page CALLBACKS_UG HDF5 Java H5Callbacks Interface
|
||||
* \page CALLBACKS_UG HDF5 Java H5Callbacks Interface
|
||||
* All callback definitions must derive from the H5Callbacks interface. Any
|
||||
* derived interfaces must define a single public method named "callback".
|
||||
* You are responsible for deregistering your callback (if necessary)
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
package hdf.hdf5lib.exceptions;
|
||||
|
||||
/**
|
||||
* @page ERRORS Errors and Exceptions
|
||||
* \page ERRORS Errors and Exceptions
|
||||
* The class HDF5Exception returns errors from the Java HDF5 Interface.
|
||||
*
|
||||
* Two sub-classes of HDF5Exception are defined:
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
package hdf.hdf5lib.exceptions;
|
||||
|
||||
/**
|
||||
* @page ERRORSJAVA Java Wrapper Errors and Exceptions
|
||||
* \page ERRORSJAVA Java Wrapper Errors and Exceptions
|
||||
* The class HDF5JavaException returns errors from the Java wrapper of theHDF5
|
||||
* library.
|
||||
* <p>
|
||||
|
||||
@@ -16,7 +16,7 @@ import hdf.hdf5lib.H5;
|
||||
import hdf.hdf5lib.HDF5Constants;
|
||||
|
||||
/**
|
||||
* @page ERRORSLIB HDF5 Library Errors and Exceptions
|
||||
* \page ERRORSLIB HDF5 Library Errors and Exceptions
|
||||
* The class HDF5LibraryException returns errors raised by the HDF5 library.
|
||||
*
|
||||
* Each major error code from the HDF5 Library is represented by a sub-class of
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/**
|
||||
* @page ERRORS_UG Errors and Exceptions
|
||||
* \page ERRORS_UG Errors and Exceptions
|
||||
* <p>
|
||||
* The package exceptions contains error classes for the Java HDF5 Interface.
|
||||
* <p>
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/**
|
||||
@page HDF5LIB_UG HDF5 Java Package
|
||||
\page HDF5LIB_UG HDF5 Java Package
|
||||
* This package is the Java interface for the HDF5 library.
|
||||
* <p>
|
||||
* This code is the called by Java programs to access the entry points of the HDF5 library.
|
||||
|
||||
@@ -27,6 +27,9 @@
|
||||
#define H5_MY_PKG_INIT YES
|
||||
|
||||
/** \page H5A_UG HDF5 Attributes
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_attribute HDF5 Attributes
|
||||
*
|
||||
@@ -352,6 +355,9 @@
|
||||
*
|
||||
* Previous Chapter \ref sec_dataspace - Next Chapter \ref sec_error
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*
|
||||
* \defgroup H5A Attributes (H5A)
|
||||
*
|
||||
* An HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data
|
||||
|
||||
@@ -27,6 +27,9 @@
|
||||
#define H5_MY_PKG_INIT YES
|
||||
|
||||
/** \page H5D_UG HDF5 Datasets
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* \section sec_dataset HDF5 Datasets
|
||||
*
|
||||
@@ -2868,6 +2871,9 @@
|
||||
*
|
||||
* Previous Chapter \ref sec_group - Next Chapter \ref sec_datatype
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
@@ -27,6 +27,10 @@
|
||||
#define H5_MY_PKG_INIT YES
|
||||
|
||||
/** \page H5ES_UG HDF5 Event Set
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
* <hr>
|
||||
*
|
||||
* @todo Under Construction
|
||||
*
|
||||
* \section sec_async The HDF5 Event Set Interface
|
||||
@@ -110,6 +114,9 @@
|
||||
*
|
||||
* Previous Chapter \ref sec_vol - Next Chapter \ref sec_map
|
||||
*
|
||||
* <hr>
|
||||
* Navigate back: \ref index "Main" / \ref UG
|
||||
*
|
||||
*/
|
||||
|
||||
/**\defgroup H5ES Event Set Interface (H5ES)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user