+ * Navigate back: \ref index "Main" / \ref TN + * */ diff --git a/doxygen/dox/Cookbook.dox b/doxygen/dox/Cookbook.dox index f0f72dd5c73..34ca9ebed69 100644 --- a/doxygen/dox/Cookbook.dox +++ b/doxygen/dox/Cookbook.dox @@ -1,5 +1,8 @@ /** \page Cookbook Cookbook +Navigate back: \ref index "Main" +
+ 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 +
+Navigate back: \ref index "Main" + */ diff --git a/doxygen/dox/CopyingCommited.dox b/doxygen/dox/CopyingCommited.dox index c005a2cd333..1ccce9f8354 100644 --- a/doxygen/dox/CopyingCommited.dox +++ b/doxygen/dox/CopyingCommited.dox @@ -1,4 +1,7 @@ /** \page copying_committed Copying Committed Datatypes with H5Ocopy + * + * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + *
* 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 * * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + * */ \ No newline at end of file diff --git a/doxygen/dox/DDLBNF110.dox b/doxygen/dox/DDLBNF110.dox index b392526417a..37456fbd91d 100644 --- a/doxygen/dox/DDLBNF110.dox +++ b/doxygen/dox/DDLBNF110.dox @@ -1,5 +1,8 @@ /** \page DDLBNF110 DDL in BNF through HDF5 1.10 +Navigate back: \ref index "Main" / \ref SPEC +
+ \section intro110 Introduction This document contains the data description language (DDL) for an HDF5 file. The @@ -645,4 +648,7 @@ GROUP "/" { } \endcode +
+Navigate back: \ref index "Main" / \ref SPEC + */ \ No newline at end of file diff --git a/doxygen/dox/DDLBNF112.dox b/doxygen/dox/DDLBNF112.dox index c6463c23d5c..9b9080d47f1 100644 --- a/doxygen/dox/DDLBNF112.dox +++ b/doxygen/dox/DDLBNF112.dox @@ -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 +
+ \section intro112 Introduction This document contains the data description language (DDL) for an HDF5 file. The @@ -648,4 +651,7 @@ GROUP "/" { } \endcode +
+Navigate back: \ref index "Main" / \ref SPEC + */ \ No newline at end of file diff --git a/doxygen/dox/DDLBNF114.dox b/doxygen/dox/DDLBNF114.dox index baa7a57fea6..d155241f258 100644 --- a/doxygen/dox/DDLBNF114.dox +++ b/doxygen/dox/DDLBNF114.dox @@ -1,5 +1,8 @@ /** \page DDLBNF114 DDL in BNF for HDF5 1.14.4 and above +Navigate back: \ref index "Main" / \ref SPEC +
+ \section intro114 Introduction This document contains the data description language (DDL) for an HDF5 file. The @@ -649,4 +652,7 @@ GROUP "/" { } \endcode +
+Navigate back: \ref index "Main" / \ref SPEC + */ \ No newline at end of file diff --git a/doxygen/dox/DDLBNF200.dox b/doxygen/dox/DDLBNF200.dox index 8ce4c89df9f..9f4722db6a4 100644 --- a/doxygen/dox/DDLBNF200.dox +++ b/doxygen/dox/DDLBNF200.dox @@ -1,5 +1,8 @@ /** \page DDLBNF200 DDL in BNF for HDF5 2.0.0 and above +Navigate back: \ref index "Main" / \ref SPEC +
+ \todo Revise this & break it up! \section intro200 Introduction @@ -664,4 +667,7 @@ GROUP "/" { } \endcode +
+Navigate back: \ref index "Main" / \ref SPEC + */ \ No newline at end of file diff --git a/doxygen/dox/ExamplesAPI.dox b/doxygen/dox/ExamplesAPI.dox index cf44405db11..4e4f945cfbf 100644 --- a/doxygen/dox/ExamplesAPI.dox +++ b/doxygen/dox/ExamplesAPI.dox @@ -1,4 +1,4 @@ -/** @page ExAPI Examples by API +/** \page ExAPI Examples by API Navigate back: \ref index "Main" / \ref GettingStarted
diff --git a/doxygen/dox/FTS.dox b/doxygen/dox/FTS.dox index 513786a19ac..e327012ed47 100644 --- a/doxygen/dox/FTS.dox +++ b/doxygen/dox/FTS.dox @@ -1,8 +1,14 @@ /** \page FTS Full-Text Search +Navigate back: \ref index "Main" +
+ \htmlonly \endhtmlonly +
+Navigate back: \ref index "Main" + */ diff --git a/doxygen/dox/FileFormatDisc.dox b/doxygen/dox/FileFormatDisc.dox index 8075840b97e..50251eb1590 100644 --- a/doxygen/dox/FileFormatDisc.dox +++ b/doxygen/dox/FileFormatDisc.dox @@ -1,6 +1,9 @@ /** \page FMTDISC HDF5 File Format Discussion +Navigate back: \ref index "Main" / \ref TN +
+
- Document's Audience: @@ -1110,5 +1113,8 @@ Message 5...
- @ref sec_fmt1_intro
- @ref sec_fmt1_boot @@ -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. +
- @ref sec_fmt11_intro
- @ref sec_fmt11_meta
@@ -3884,4 +3888,7 @@ i.e.
0xffff...ff. \anchor FMT11UnlimitedDim The "unlimited size" for a size is a value with all bits set, i.e.0xffff...ff. +
+Navigate back: \ref index "Main" / \ref SPEC + */ diff --git a/doxygen/dox/H5.format.2.0.dox b/doxygen/dox/H5.format.2.0.dox index daf20e63c91..c936a14cdae 100644 --- a/doxygen/dox/H5.format.2.0.dox +++ b/doxygen/dox/H5.format.2.0.dox @@ -1,5 +1,9 @@ /** \page FMT2 HDF5 File Format Specification Version 2.0 + +Navigate back: \ref index "Main" / \ref SPEC +
+- @ref sec_fmt2_intro
-
@@ -9282,4 +9286,7 @@ Allocation types that are mapped to basic allocation types are described below:
+
- @ref sec_fmt3_intro
-
@@ -12588,4 +12592,7 @@ raw data in the file. The global heap ID is used to locate the reference encodin
+
+Navigate back: \ref index "Main" / \ref SPEC + */ diff --git a/doxygen/dox/HDF5CompressionTroubleshooting.dox b/doxygen/dox/HDF5CompressionTroubleshooting.dox index be7cb89fe3c..ccb7ee4d43b 100644 --- a/doxygen/dox/HDF5CompressionTroubleshooting.dox +++ b/doxygen/dox/HDF5CompressionTroubleshooting.dox @@ -1,4 +1,8 @@ /** \page CompTS HDF5 Compression Troubleshooting + +Navigate back: \ref index "Main" / \ref TN +
+ 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. +
+Navigate back: \ref index "Main" / \ref TN + */ \ No newline at end of file diff --git a/doxygen/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox b/doxygen/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox index 706f80c542a..8d94184d292 100644 --- a/doxygen/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox +++ b/doxygen/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox @@ -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 + *
+ * * 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. * + *
+ * Navigate back: \ref index "Main" / \ref TN + * */ diff --git a/doxygen/dox/IOFlow.dox b/doxygen/dox/IOFlow.dox index 0a2771005fc..caa10cc8b9d 100644 --- a/doxygen/dox/IOFlow.dox +++ b/doxygen/dox/IOFlow.dox @@ -1,4 +1,8 @@ /** \page IOFLOW HDF5 Raw I/O Flow Notes + +Navigate back: \ref index "Main" / \ref TN +
+ \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
+Navigate back: \ref index "Main" / \ref SPEC + */ diff --git a/doxygen/dox/H5.format.3.0.dox b/doxygen/dox/H5.format.3.0.dox index 95df6095c95..5183f53f3c2 100644 --- a/doxygen/dox/H5.format.3.0.dox +++ b/doxygen/dox/H5.format.3.0.dox @@ -1,5 +1,9 @@ /** \page FMT3 HDF5 File Format Specification Version 3.0 + +Navigate back: \ref index "Main" / \ref SPEC +
+
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/ImageSpec.dox b/doxygen/dox/ImageSpec.dox index 86dd51afedd..1e88b93008a 100644 --- a/doxygen/dox/ImageSpec.dox +++ b/doxygen/dox/ImageSpec.dox @@ -1,6 +1,8 @@ /** \page IMG HDF5 Image and Palette Specification Version 1.2 +Navigate back: \ref index "Main" / \ref SPEC +
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 PALETTE 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. +
+Navigate back: \ref index "Main" / \ref SPEC + */ diff --git a/doxygen/dox/IntroHDF5.dox b/doxygen/dox/IntroHDF5.dox index 7c35681f95b..c80c2e242ac 100644 --- a/doxygen/dox/IntroHDF5.dox +++ b/doxygen/dox/IntroHDF5.dox @@ -1,4 +1,4 @@ -/** @page IntroHDF5 Introduction to HDF5 +/** \page IntroHDF5 Introduction to HDF5 Navigate back: \ref index "Main" / \ref GettingStarted
@@ -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 +
+ Example programs of how to use HDF5 are provided below. For HDF-EOS specific examples, see the examples 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 Using Special Values These examples show how to create special values in an HDF5 application. +
+Navigate back: \ref index "Main" / \ref GettingStarted + */ diff --git a/doxygen/dox/IntroParExamples.dox b/doxygen/dox/IntroParExamples.dox index 77a865bc683..6d75ce29b93 100644 --- a/doxygen/dox/IntroParExamples.dox +++ b/doxygen/dox/IntroParExamples.dox @@ -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
@@ -217,7 +217,7 @@ displayed in columns if it was printed using Fortran 90 code.
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
@@ -357,7 +357,7 @@ because \ref sec_cltools_h5dump is written in C. The data would be displayed in
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
@@ -468,7 +468,7 @@ The \ref sec_cltools_h5dump utility is written in C so the output is in C order.
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
diff --git a/doxygen/dox/IntroParHDF5.dox b/doxygen/dox/IntroParHDF5.dox index a02cbbb5253..84456ba9c6e 100644 --- a/doxygen/dox/IntroParHDF5.dox +++ b/doxygen/dox/IntroParHDF5.dox @@ -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
diff --git a/doxygen/dox/LearnBasics.dox b/doxygen/dox/LearnBasics.dox index 33426cf1311..15b4a09e4d1 100644 --- a/doxygen/dox/LearnBasics.dox +++ b/doxygen/dox/LearnBasics.dox @@ -1,4 +1,4 @@ -/** @page LearnBasics Learning the Basics +/** \page LearnBasics Learning the Basics Navigate back: \ref index "Main" / \ref GettingStarted
@@ -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
diff --git a/doxygen/dox/LearnBasics1.dox b/doxygen/dox/LearnBasics1.dox index 2287239fccc..1933c692d36 100644 --- a/doxygen/dox/LearnBasics1.dox +++ b/doxygen/dox/LearnBasics1.dox @@ -1,4 +1,4 @@ -/** @page LBFileOrg HDF5 File Organization +/** \page LBFileOrg HDF5 File Organization Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/doxygen/dox/LearnBasics2.dox b/doxygen/dox/LearnBasics2.dox index e350bf9c66e..8d21c3b1c14 100644 --- a/doxygen/dox/LearnBasics2.dox +++ b/doxygen/dox/LearnBasics2.dox @@ -1,4 +1,4 @@ -/** @page LBGrpCreate Creating an Group +/** \page LBGrpCreate Creating an Group Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox index c86ad413a18..59711407a77 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/doxygen/dox/LearnBasics3.dox @@ -1,4 +1,4 @@ -/** @page LBPropsList Property Lists Basics +/** \page LBPropsList Property Lists Basics Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/doxygen/dox/LearnHDFView.dox b/doxygen/dox/LearnHDFView.dox index 298ae52ca4c..0d57a92daf1 100644 --- a/doxygen/dox/LearnHDFView.dox +++ b/doxygen/dox/LearnHDFView.dox @@ -1,4 +1,4 @@ -/** @page LearnHDFView Learning HDF5 with HDFView +/** \page LearnHDFView Learning HDF5 with HDFView Navigate back: \ref index "Main" / \ref GettingStarted
diff --git a/doxygen/dox/MetadataCachingInHDF5.dox b/doxygen/dox/MetadataCachingInHDF5.dox index 81c7b0bffc3..36085b9b2ff 100644 --- a/doxygen/dox/MetadataCachingInHDF5.dox +++ b/doxygen/dox/MetadataCachingInHDF5.dox @@ -1,5 +1,8 @@ /** \page TNMDC Metadata Caching in HDF5 +Navigate back: \ref index "Main" / \ref TN +
+ \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. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/ModifiedRegionWrites.dox b/doxygen/dox/ModifiedRegionWrites.dox index fa9c745d054..bf8007ee91a 100644 --- a/doxygen/dox/ModifiedRegionWrites.dox +++ b/doxygen/dox/ModifiedRegionWrites.dox @@ -1,4 +1,7 @@ /** \page mod_region_writes Modified Region Writes + * + * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + *
* * 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. * * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + * */ \ No newline at end of file diff --git a/doxygen/dox/PredefinedDatatypeTables.dox b/doxygen/dox/PredefinedDatatypeTables.dox index 7b3795016b3..7664e8bea04 100644 --- a/doxygen/dox/PredefinedDatatypeTables.dox +++ b/doxygen/dox/PredefinedDatatypeTables.dox @@ -1,5 +1,8 @@ /** \page predefined_datatypes_tables HDF5 Predefined Datatypes - * + * + * Navigate back: \ref index "Main" / \ref RM + *
+ * * \section sec_predefined_datatypes_tables HDF5 Predefined Datatypes * * The following datatypes are predefined in HDF5. @@ -10,36 +13,40 @@ ** \snippet{doc} tables/predefinedDatatypes.dox predefined_complex_datatypes_table *- * + * ** \snippet{doc} tables/predefinedDatatypes.dox predefined_std_datatypes_table *- * + * ** \snippet{doc} tables/predefinedDatatypes.dox predefined_unix_datatypes_table *- * + * ** \snippet{doc} tables/predefinedDatatypes.dox predefined_string_datatypes_table *- * + * ** \snippet{doc} tables/predefinedDatatypes.dox predefined_intel_datatypes_table *- * + * ** \snippet{doc} tables/predefinedDatatypes.dox predefined_dec_datatypes_table *- * + * ** \snippet{doc} tables/predefinedDatatypes.dox predefined_mips_datatypes_table *- * + * ** \snippet{doc} tables/predefinedDatatypes.dox predefined_native_datatypes_table *- * + * ** \snippet{doc} tables/predefinedDatatypes.dox predefined_c9x_datatypes_table *+ * + *
+ * Navigate back: \ref index "Main" / \ref SPEC + * */ diff --git a/doxygen/dox/RFC.dox b/doxygen/dox/RFC.dox index 6f916ebc6ab..2237b94be07 100644 --- a/doxygen/dox/RFC.dox +++ b/doxygen/dox/RFC.dox @@ -1,5 +1,8 @@ /** \page RFC RFCs +Navigate back: \ref index "Main" +
+
+RFC ID Title 2022-08-19 \ref_rfc20220819 2004-08-11 \ref_rfc20040811
+Navigate back: \ref index "Main" + */ diff --git a/doxygen/dox/ReferenceManual.dox b/doxygen/dox/ReferenceManual.dox index beb8d9d055b..58078aa3008 100644 --- a/doxygen/dox/ReferenceManual.dox +++ b/doxygen/dox/ReferenceManual.dox @@ -1,5 +1,8 @@ /** \page RM HDF5 Reference Manual +Navigate back: \ref index "Main" +
+ 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: pull request !\n See the \ref RMT for general guidance. +
+Navigate back: \ref index "Main" + */ diff --git a/doxygen/dox/RelVersion.dox b/doxygen/dox/RelVersion.dox index 0bc7ab17409..6f0c2684b11 100644 --- a/doxygen/dox/RelVersion.dox +++ b/doxygen/dox/RelVersion.dox @@ -1,6 +1,9 @@ /** \page RELVERSION HDF5 Library Release Version Numbers +Navigate back: \ref index "Main" / \ref TN +
+ \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 + +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/SWMRTechNote.dox b/doxygen/dox/SWMRTechNote.dox index 1aba87e2ac7..9bc25d43b5e 100644 --- a/doxygen/dox/SWMRTechNote.dox +++ b/doxygen/dox/SWMRTechNote.dox @@ -1,6 +1,9 @@ /** \page SWMRTN Introduction to Single-Writer/Multiple-Reader (SWMR) +Navigate back: \ref index "Main" / \ref TN +
+ \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. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/Specifications.dox b/doxygen/dox/Specifications.dox index d305b7f604b..6ee13e9ca23 100644 --- a/doxygen/dox/Specifications.dox +++ b/doxygen/dox/Specifications.dox @@ -1,5 +1,8 @@ /** \page SPEC Specifications +Navigate back: \ref index "Main" +
+ \section sec_spec_ddl DDL \li \ref DDLBNF110 @@ -20,4 +23,7 @@ \li \ref TBLSPEC \li \ref sec_dim_scales_spec +
+Navigate back: \ref index "Main" + */ diff --git a/doxygen/dox/TableSpec.dox b/doxygen/dox/TableSpec.dox index dcc8a342a13..83ed439a745 100644 --- a/doxygen/dox/TableSpec.dox +++ b/doxygen/dox/TableSpec.dox @@ -1,5 +1,9 @@ /** \page TBLSPEC HDF5 Table Specification Version 1.0 + +Navigate back: \ref index "Main" / \ref SPEC +
+ 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. +
+Navigate back: \ref index "Main" / \ref SPEC */ diff --git a/doxygen/dox/TechnicalNotes.dox b/doxygen/dox/TechnicalNotes.dox index fa272193f68..1aec43f8eab 100644 --- a/doxygen/dox/TechnicalNotes.dox +++ b/doxygen/dox/TechnicalNotes.dox @@ -1,5 +1,8 @@ /** \page TN Technical Notes +Navigate back: \ref index "Main" +
+ \li \ref api-compat-macros \li \ref APPDBG \li \ref FMTDISC @@ -26,5 +29,8 @@ \li \ref VOL_Connector \li \ref CMakeVols +
+Navigate back: \ref index "Main" + */ diff --git a/doxygen/dox/ThreadSafe.dox b/doxygen/dox/ThreadSafe.dox index 73365120527..8b041153d30 100644 --- a/doxygen/dox/ThreadSafe.dox +++ b/doxygen/dox/ThreadSafe.dox @@ -1,5 +1,8 @@ /** \page thread-safe-lib Thread Safe Library +Navigate back: \ref index "Main" / \ref TN +
+ \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 +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/Tools.dox b/doxygen/dox/Tools.dox index 12d2ca1e205..bcb305da440 100644 --- a/doxygen/dox/Tools.dox +++ b/doxygen/dox/Tools.dox @@ -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
-\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.
-Navigate back: \ref index "Main" +Navigate back: \ref index "Main" / \ref UG */ diff --git a/doxygen/dox/TrainingVideos.dox b/doxygen/dox/TrainingVideos.dox index 8e15176f9f4..9cf50f42523 100644 --- a/doxygen/dox/TrainingVideos.dox +++ b/doxygen/dox/TrainingVideos.dox @@ -1,4 +1,4 @@ -/** @page LBTraining Training Videos +/** \page LBTraining Training Videos Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
diff --git a/doxygen/dox/Unicode.dox b/doxygen/dox/Unicode.dox index 8195ccf4caa..24bbb9b5ebe 100644 --- a/doxygen/dox/Unicode.dox +++ b/doxygen/dox/Unicode.dox @@ -1,6 +1,9 @@ /** \page UNICODE Using UTF-8 Encoding in HDF5 Applications +Navigate back: \ref index "Main" / \ref TN +
+ \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 wNOTES
1. UTF-8 is the only Unicode standard encoding supported in HDF5. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/UsersGuide.dox b/doxygen/dox/UsersGuide.dox index 29eb8489af3..f871ee77d77 100644 --- a/doxygen/dox/UsersGuide.dox +++ b/doxygen/dox/UsersGuide.dox @@ -1,5 +1,8 @@ /** \page UG HDF5 User Guide +Navigate back: \ref index "Main" +
+ \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-
@@ -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
+
+Navigate back: \ref index "Main" + \page AR_UG Additional Resources +Navigate back: \ref index "Main" / \ref UG +
+ \section sec_addition Additional Resources These documents provide additional information for the use and tuning of specific HDF5 features.@@ -484,12 +497,13 @@ These documents provide additional information for the use and tuning of specifi
-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 HDF5 repo, make changes, and create a pull request !\n +
+Navigate back: \ref index "Main" / \ref UG + */ diff --git a/doxygen/dox/UsingIdentifiers.dox b/doxygen/dox/UsingIdentifiers.dox index 7fe1923990c..71bd0d2285d 100644 --- a/doxygen/dox/UsingIdentifiers.dox +++ b/doxygen/dox/UsingIdentifiers.dox @@ -1,4 +1,7 @@ /** \page UsingIdentifiers Using Identifiers + * + * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + *
* * \section sec_using_identifiers Using Identifiers * @@ -94,4 +97,7 @@ * \li #H5Tget_member_type * \li #H5Tget_super * \li #H5Topen + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG */ diff --git a/doxygen/dox/VDSTechNote.dox b/doxygen/dox/VDSTechNote.dox index ac9330aa4e0..dcba0280150 100644 --- a/doxygen/dox/VDSTechNote.dox +++ b/doxygen/dox/VDSTechNote.dox @@ -1,6 +1,9 @@ /** \page VDSTN Introduction to the Virtual Dataset - VDS +Navigate back: \ref index "Main" / \ref TN +
+ \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
+
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/VFLTechNote.dox b/doxygen/dox/VFLTechNote.dox index 535001a2eb5..acca189b12d 100644 --- a/doxygen/dox/VFLTechNote.dox +++ b/doxygen/dox/VFLTechNote.dox @@ -1,6 +1,9 @@ /** \page VFLTN HDF5 Virtual File Layer +Navigate back: \ref index "Main" / \ref TN +
+ \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. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/VOLConnGuide.dox b/doxygen/dox/VOLConnGuide.dox index 00dd18e82f7..398b6c3f873 100644 --- a/doxygen/dox/VOLConnGuide.dox +++ b/doxygen/dox/VOLConnGuide.dox @@ -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
\section secVOLIntro Introduction @@ -4876,5 +4876,5 @@ H5_DLL herr_t H5VLoptional(void *obj, hid_t connector_id, H5VL_optional_args_t * \endcode
-Navigate back: \ref index "Main" / \ref VOL_Connector +Navigate back: \ref index "Main" / \ref TN */ diff --git a/doxygen/dox/ViewTools.dox b/doxygen/dox/ViewTools.dox index c428a087c34..e5462bb8f26 100644 --- a/doxygen/dox/ViewTools.dox +++ b/doxygen/dox/ViewTools.dox @@ -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
@@ -42,7 +42,7 @@ The following are basic facts about HDF5 files to keep in mind while completing
Navigate back: \ref index "Main" / \ref GettingStarted -@page ViewToolsCommand Command-line Tools +\page ViewToolsCommand Command-line Tools Navigate back: \ref index "Main" / \ref GettingStarted
@@ -158,7 +158,7 @@ does not cover all of the HDF5 tools.
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
diff --git a/doxygen/dox/ViewTools2.dox b/doxygen/dox/ViewTools2.dox index c3372935e2d..92f0ba2b564 100644 --- a/doxygen/dox/ViewTools2.dox +++ b/doxygen/dox/ViewTools2.dox @@ -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
@@ -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
diff --git a/doxygen/dox/ViewToolsJPSS.dox b/doxygen/dox/ViewToolsJPSS.dox index cf042806fc1..4b3d0c03f87 100644 --- a/doxygen/dox/ViewToolsJPSS.dox +++ b/doxygen/dox/ViewToolsJPSS.dox @@ -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
diff --git a/doxygen/dox/api-compat-macros.dox b/doxygen/dox/api-compat-macros.dox index a899ef1165d..01ac81c55e3 100644 --- a/doxygen/dox/api-compat-macros.dox +++ b/doxygen/dox/api-compat-macros.dox @@ -1,5 +1,8 @@ /** \page api-compat-macros API Compatibility Macros +Navigate back: \ref index "Main" / \ref TN +
+ \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. - @ref sec_fmt3_intro
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/branches-explained.dox b/doxygen/dox/branches-explained.dox index 7aeafeec2ef..a94ec4464a5 100644 --- a/doxygen/dox/branches-explained.dox +++ b/doxygen/dox/branches-explained.dox @@ -1,5 +1,8 @@ /** \page BRANCHEXPL HDF5 Git Branching Model Explained +Navigate back: \ref index "Main" / \ref TN +
+ 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. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/chunking_in_hdf5.dox b/doxygen/dox/chunking_in_hdf5.dox index b46662a3a5b..3327e698fdd 100644 --- a/doxygen/dox/chunking_in_hdf5.dox +++ b/doxygen/dox/chunking_in_hdf5.dox @@ -1,4 +1,7 @@ /** \page hdf5_chunking Chunking in HDF5 + * + * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + *
* * \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. * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + * */ diff --git a/doxygen/dox/cmake-vols-fetchcontent.dox b/doxygen/dox/cmake-vols-fetchcontent.dox index 2d1d9420469..809f9a7824d 100644 --- a/doxygen/dox/cmake-vols-fetchcontent.dox +++ b/doxygen/dox/cmake-vols-fetchcontent.dox @@ -1,5 +1,8 @@ /** \page CMakeVols HDF5 Building and testing HDF5 VOL connectors with CMake FetchContent +Navigate back: \ref index "Main" / \ref TN +
+ \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. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/code-conventions.dox b/doxygen/dox/code-conventions.dox index 54aa5155160..ad86ca2c7f0 100644 --- a/doxygen/dox/code-conventions.dox +++ b/doxygen/dox/code-conventions.dox @@ -1,5 +1,8 @@ /** \page CODECONV HDF5 Library Code Conventions +Navigate back: \ref index "Main" / \ref TN +
+ 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. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/cookbook/Accessibility.dox b/doxygen/dox/cookbook/Accessibility.dox index 28009be71d2..fa2f7a83cb2 100644 --- a/doxygen/dox/cookbook/Accessibility.dox +++ b/doxygen/dox/cookbook/Accessibility.dox @@ -1,5 +1,8 @@ /** \page Accessibility +Navigate back: \ref index "Main" / \ref Cookbook +
+ \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. +
+Navigate back: \ref index "Main" / \ref Cookbook + */ \ No newline at end of file diff --git a/doxygen/dox/cookbook/Attributes.dox b/doxygen/dox/cookbook/Attributes.dox index 59149099579..cd3fc077feb 100644 --- a/doxygen/dox/cookbook/Attributes.dox +++ b/doxygen/dox/cookbook/Attributes.dox @@ -1,5 +1,8 @@ /** \page Attributes +Navigate back: \ref index "Main" / \ref Cookbook +
+ \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. +
+Navigate back: \ref index "Main" / \ref Cookbook + */ \ No newline at end of file diff --git a/doxygen/dox/cookbook/Files.dox b/doxygen/dox/cookbook/Files.dox index 4b133a615cb..298f69b7b74 100644 --- a/doxygen/dox/cookbook/Files.dox +++ b/doxygen/dox/cookbook/Files.dox @@ -1,5 +1,8 @@ /** \page Files +Navigate back: \ref index "Main" / \ref Cookbook +
+ \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 +
+Navigate back: \ref index "Main" / \ref Cookbook + */ diff --git a/doxygen/dox/cookbook/Performance.dox b/doxygen/dox/cookbook/Performance.dox index 5e945b232c4..610b5b15d03 100644 --- a/doxygen/dox/cookbook/Performance.dox +++ b/doxygen/dox/cookbook/Performance.dox @@ -1,5 +1,8 @@ /** \page Performance +Navigate back: \ref index "Main" / \ref Cookbook +
+ \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 +
+Navigate back: \ref index "Main" / \ref Cookbook + */ \ No newline at end of file diff --git a/doxygen/dox/cookbook/Presets.dox b/doxygen/dox/cookbook/Presets.dox index af045aadf94..ecae0d3ee9f 100644 --- a/doxygen/dox/cookbook/Presets.dox +++ b/doxygen/dox/cookbook/Presets.dox @@ -1,5 +1,8 @@ /** \page cmake-presets Building with CMake Presets +Navigate back: \ref index "Main" / \ref Cookbook +
+ \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}" +
+Navigate back: \ref index "Main" / \ref Cookbook + */ diff --git a/doxygen/dox/file-locking.dox b/doxygen/dox/file-locking.dox index 5af369e840c..c4509616910 100644 --- a/doxygen/dox/file-locking.dox +++ b/doxygen/dox/file-locking.dox @@ -1,5 +1,8 @@ /** \page FileLock HDF5 File Locking in HDF5 +Navigate back: \ref index "Main" / \ref TN +
+ \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. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/hdf5_1_10.dox b/doxygen/dox/hdf5_1_10.dox index f156f3f8855..8e9d8ac3db2 100644 --- a/doxygen/dox/hdf5_1_10.dox +++ b/doxygen/dox/hdf5_1_10.dox @@ -1,4 +1,7 @@ /** \page rel_spec_110 Release Specific Information for HDF5 1.10 + * + * Navigate back: \ref index "Main" / \ref release_specific_info + *
\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 - + * + *
+ * Navigate back: \ref index "Main" / \ref release_specific_info + * */ diff --git a/doxygen/dox/hdf5_1_12.dox b/doxygen/dox/hdf5_1_12.dox index 356eefd05ca..0c0a08d8bb5 100644 --- a/doxygen/dox/hdf5_1_12.dox +++ b/doxygen/dox/hdf5_1_12.dox @@ -1,4 +1,7 @@ /** \page rel_spec_112 Release Specific Information for HDF5 1.12 + * + * Navigate back: \ref index "Main" / \ref release_specific_info + *
\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 - + * + *
+ * Navigate back: \ref index "Main" / \ref release_specific_info + * */ diff --git a/doxygen/dox/hdf5_1_14.dox b/doxygen/dox/hdf5_1_14.dox index a8eddd28004..dbf57e351b9 100644 --- a/doxygen/dox/hdf5_1_14.dox +++ b/doxygen/dox/hdf5_1_14.dox @@ -1,4 +1,7 @@ /** \page rel_spec_114 Release Specific Information for HDF5 1.14 + * + * Navigate back: \ref index "Main" / \ref release_specific_info + *
\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 + * + *
+ * Navigate back: \ref index "Main" / \ref release_specific_info + * */ diff --git a/doxygen/dox/hdf5_1_8.dox b/doxygen/dox/hdf5_1_8.dox index 523177c8856..5f4fc80c5bd 100644 --- a/doxygen/dox/hdf5_1_8.dox +++ b/doxygen/dox/hdf5_1_8.dox @@ -1,4 +1,7 @@ /** \page rel_spec_18 Release Specific Information for HDF5 1.8 + * + * Navigate back: \ref index "Main" / \ref release_specific_info + *
\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 + * + *
+ * Navigate back: \ref index "Main" / \ref release_specific_info + * */ diff --git a/doxygen/dox/high_level/extension.dox b/doxygen/dox/high_level/extension.dox index 456692ed868..4d395793052 100644 --- a/doxygen/dox/high_level/extension.dox +++ b/doxygen/dox/high_level/extension.dox @@ -1,4 +1,7 @@ /** \defgroup H5LR Extensions + * + * Navigate back: \ref index "Main" / \ref RM + *
* * Working with region references, hyperslab selections, * and bit-fields (H5LR, H5LT) @@ -607,6 +610,9 @@ H5_HLRDLL herr_t H5LTread_region(const char *file, * * \since 1.0 * + *
+ * 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); diff --git a/doxygen/dox/library-init-shutdown.dox b/doxygen/dox/library-init-shutdown.dox index 0c48ee49d53..6064e0aa589 100644 --- a/doxygen/dox/library-init-shutdown.dox +++ b/doxygen/dox/library-init-shutdown.dox @@ -1,5 +1,8 @@ /** \page InitShut HDF5 Library initialization and shutdown +Navigate back: \ref index "Main" / \ref TN +
+ \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 strictly after the preceding modules, then it should be marked as a barrier. See the comments inH5_term_libraryfor more information. +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/parallel-compression.dox b/doxygen/dox/parallel-compression.dox index 962b9907857..db69d7a8b42 100644 --- a/doxygen/dox/parallel-compression.dox +++ b/doxygen/dox/parallel-compression.dox @@ -1,5 +1,8 @@ /** \page ParCompr HDF5 Parallel Compression +Navigate back: \ref index "Main" / \ref TN +
+ \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 +
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/release_specific_info.dox b/doxygen/dox/release_specific_info.dox index 70d9151d703..bd127597998 100644 --- a/doxygen/dox/release_specific_info.dox +++ b/doxygen/dox/release_specific_info.dox @@ -1,4 +1,7 @@ /** \page release_specific_info Release Specific Information + * + * Navigate back: \ref index "Main" + *
\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 - + * + *
+ * Navigate back: \ref index "Main" + * */ diff --git a/doxygen/dox/rm-template.dox b/doxygen/dox/rm-template.dox index ad5e8387c19..35ccb77d6ca 100644 --- a/doxygen/dox/rm-template.dox +++ b/doxygen/dox/rm-template.dox @@ -1,5 +1,8 @@ /** \page RMT Reference Manual (RM) Page Template +Navigate back: \ref index "Main" / \ref RM +
+ We treat documentation like code and use Doxygen to markup @@ -96,4 +99,7 @@ the \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. + * + *
+ * Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_110 */ diff --git a/doxygen/dox/sw_changes_1.12.dox b/doxygen/dox/sw_changes_1.12.dox index 6a59c0d8dff..d25ce7d6769 100644 --- a/doxygen/dox/sw_changes_1.12.dox +++ b/doxygen/dox/sw_changes_1.12.dox @@ -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 + *
\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]() + * + *
+ * Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_112 */ diff --git a/doxygen/dox/sw_changes_1.14.dox b/doxygen/dox/sw_changes_1.14.dox index 104dcbb43b9..56442aaa48e 100644 --- a/doxygen/dox/sw_changes_1.14.dox +++ b/doxygen/dox/sw_changes_1.14.dox @@ -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 + *
\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 + * + *
+ * Navigate back: \ref index "Main" / \ref release_specific_info / \ref rel_spec_114 */ diff --git a/doxygen/dox/threadsafety-warning.dox b/doxygen/dox/threadsafety-warning.dox index 16194f22a96..6b04295a536 100644 --- a/doxygen/dox/threadsafety-warning.dox +++ b/doxygen/dox/threadsafety-warning.dox @@ -1,4 +1,8 @@ /** \page ThrdSafe HDF5 Threadsafety Warning + +Navigate back: \ref index "Main" / \ref TN +
+ 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. - + +
+Navigate back: \ref index "Main" / \ref TN + */ \ No newline at end of file diff --git a/hl/src/H5DOpublic.h b/hl/src/H5DOpublic.h index ab6ad2ed96b..de2a28b9309 100644 --- a/hl/src/H5DOpublic.h +++ b/hl/src/H5DOpublic.h @@ -18,6 +18,10 @@ extern "C" { #endif /** \page H5DO_UG HDF5 High Level Optimizations + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * * 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 + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /**\defgroup H5DO HDF5 Optimizations APIs (H5DO) diff --git a/hl/src/H5DSpublic.h b/hl/src/H5DSpublic.h index 28d70831bec..fbd74a9cd67 100644 --- a/hl/src/H5DSpublic.h +++ b/hl/src/H5DSpublic.h @@ -31,6 +31,9 @@ extern "C" { #endif /** \page H5DS_UG HDF5 High Level Dimension Scales + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \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 + * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /**\defgroup H5DS HDF5 Dimension Scales APIs (H5DS) diff --git a/hl/src/H5IMpublic.h b/hl/src/H5IMpublic.h index 4171ebcf18c..252431fdd25 100644 --- a/hl/src/H5IMpublic.h +++ b/hl/src/H5IMpublic.h @@ -18,7 +18,18 @@ extern "C" { #endif /** \page H5IM_UG HDF5 High Level Images + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * + * \section sec_hl_images HDF5 Images + * * @todo Under Construction + * + * Previous Chapter \ref sec_dim_scales_stand - Next Chapter \ref sec_hl_lite_api + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /**\defgroup H5IM HDF5 Images API (H5IM) diff --git a/hl/src/H5LTpublic.h b/hl/src/H5LTpublic.h index ac2e2b50861..1a4b109ad60 100644 --- a/hl/src/H5LTpublic.h +++ b/hl/src/H5LTpublic.h @@ -35,7 +35,18 @@ extern "C" { #endif /** \page H5LT_UG HDF5 High Level Lite + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * + * \section sec_hl_lite_api HDF5 Lite APIs + * * @todo Under Construction + * + * Previous Chapter \ref sec_hl_images - Next Chapter \ref sec_hl_table_api + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /**\defgroup H5LT HDF5 Lite APIs (H5LT,H5LD) diff --git a/hl/src/H5PTpublic.h b/hl/src/H5PTpublic.h index babf3152b84..40d873d4c50 100644 --- a/hl/src/H5PTpublic.h +++ b/hl/src/H5PTpublic.h @@ -18,7 +18,18 @@ extern "C" { #endif /** \page H5PT_UG HDF5 High Level Packet Table + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * + * \section sec_hl_packet_table_api HDF5 Table APIs + * * @todo Under Construction + * + * Previous Chapter \ref sec_hl_table_api + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /**\defgroup H5PT HDF5 Packet Table APIs (H5PT) diff --git a/hl/src/H5TBpublic.h b/hl/src/H5TBpublic.h index 1dfee515b34..7158af2efbb 100644 --- a/hl/src/H5TBpublic.h +++ b/hl/src/H5TBpublic.h @@ -18,7 +18,18 @@ extern "C" { #endif /** \page H5TB_UG HDF5 High Level Table + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * + * \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 + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /**\defgroup H5TB HDF5 Table APIs (H5TB) diff --git a/hl/tools/h5watch/h5watch.h b/hl/tools/h5watch/h5watch.h index a7c625af65e..31cb9ddc113 100644 --- a/hl/tools/h5watch/h5watch.h +++ b/hl/tools/h5watch/h5watch.h @@ -13,6 +13,9 @@ #define H5WATCH_H /** \page H5TOOL_WH_UG The HDF5 h5watch Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5watch h5watch * @@ -57,6 +60,11 @@ * \li \
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5WATCH_H */ diff --git a/java/src/hdf/hdf5lib/H5.java b/java/src/hdf/hdf5lib/H5.java index d8b778e6ad2..28ea577d69d 100644 --- a/java/src/hdf/hdf5lib/H5.java +++ b/java/src/hdf/hdf5lib/H5.java @@ -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. ** This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps diff --git a/java/src/hdf/hdf5lib/HDF5Constants.java b/java/src/hdf/hdf5lib/HDF5Constants.java index 57f653865da..05ed9b5a3ca 100644 --- a/java/src/hdf/hdf5lib/HDF5Constants.java +++ b/java/src/hdf/hdf5lib/HDF5Constants.java @@ -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 diff --git a/java/src/hdf/hdf5lib/HDFArray.java b/java/src/hdf/hdf5lib/HDFArray.java index 15072cabdda..888e0641fc5 100644 --- a/java/src/hdf/hdf5lib/HDFArray.java +++ b/java/src/hdf/hdf5lib/HDFArray.java @@ -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. *
* The purpose is to allow the storage and retrieval of arbitrary array types containing scientific data. diff --git a/java/src/hdf/hdf5lib/HDFNativeData.java b/java/src/hdf/hdf5lib/HDFNativeData.java index a6155ca2a65..9a4b8395c3b 100644 --- a/java/src/hdf/hdf5lib/HDFNativeData.java +++ b/java/src/hdf/hdf5lib/HDFNativeData.java @@ -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. *
diff --git a/java/src/hdf/hdf5lib/callbacks/H5Callbacks.java b/java/src/hdf/hdf5lib/callbacks/H5Callbacks.java index d0af5c81e32..8f3748ead3f 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5Callbacks.java +++ b/java/src/hdf/hdf5lib/callbacks/H5Callbacks.java @@ -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) diff --git a/java/src/hdf/hdf5lib/callbacks/package-info.java b/java/src/hdf/hdf5lib/callbacks/package-info.java index f0cefdfca78..a0013abcc24 100644 --- a/java/src/hdf/hdf5lib/callbacks/package-info.java +++ b/java/src/hdf/hdf5lib/callbacks/package-info.java @@ -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) diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java b/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java index 403c7684ac6..9a22ee8d6f5 100644 --- a/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java +++ b/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java @@ -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: diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java b/java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java index 65f4667249e..2d0b3a33582 100644 --- a/java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java +++ b/java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java @@ -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. *
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java b/java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java index 31d29b2ca2b..442867c09c8 100644 --- a/java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java +++ b/java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java @@ -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 diff --git a/java/src/hdf/hdf5lib/exceptions/package-info.java b/java/src/hdf/hdf5lib/exceptions/package-info.java index f7e229444e5..1a3cbddcb81 100644 --- a/java/src/hdf/hdf5lib/exceptions/package-info.java +++ b/java/src/hdf/hdf5lib/exceptions/package-info.java @@ -11,7 +11,7 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /** - * @page ERRORS_UG Errors and Exceptions + * \page ERRORS_UG Errors and Exceptions *
* The package exceptions contains error classes for the Java HDF5 Interface. *
diff --git a/java/src/hdf/hdf5lib/package-info.java b/java/src/hdf/hdf5lib/package-info.java index 34efe584fde..bf0a8137bd4 100644 --- a/java/src/hdf/hdf5lib/package-info.java +++ b/java/src/hdf/hdf5lib/package-info.java @@ -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. *
* This code is the called by Java programs to access the entry points of the HDF5 library. diff --git a/src/H5Amodule.h b/src/H5Amodule.h index 7e0e2bb76e7..c95964bb63c 100644 --- a/src/H5Amodule.h +++ b/src/H5Amodule.h @@ -27,6 +27,9 @@ #define H5_MY_PKG_INIT YES /** \page H5A_UG HDF5 Attributes + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_attribute HDF5 Attributes * @@ -352,6 +355,9 @@ * * Previous Chapter \ref sec_dataspace - Next Chapter \ref sec_error * + *
+ * 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 diff --git a/src/H5Dmodule.h b/src/H5Dmodule.h index bd0985b72e6..123579908ab 100644 --- a/src/H5Dmodule.h +++ b/src/H5Dmodule.h @@ -27,6 +27,9 @@ #define H5_MY_PKG_INIT YES /** \page H5D_UG HDF5 Datasets + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_dataset HDF5 Datasets * @@ -2868,6 +2871,9 @@ * * Previous Chapter \ref sec_group - Next Chapter \ref sec_datatype * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** diff --git a/src/H5ESmodule.h b/src/H5ESmodule.h index 5d05e2f82ce..59b5c424d7f 100644 --- a/src/H5ESmodule.h +++ b/src/H5ESmodule.h @@ -27,6 +27,10 @@ #define H5_MY_PKG_INIT YES /** \page H5ES_UG HDF5 Event Set + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * * @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 * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /**\defgroup H5ES Event Set Interface (H5ES) diff --git a/src/H5Emodule.h b/src/H5Emodule.h index 7243655cc03..21ec0441d60 100644 --- a/src/H5Emodule.h +++ b/src/H5Emodule.h @@ -27,6 +27,9 @@ #define H5_MY_PKG_INIT YES /** \page H5E_UG HDF5 Error Handling + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_error HDF5 Error Handling * @@ -514,6 +517,9 @@ * * Previous Chapter \ref sec_attribute - Next Chapter \ref sec_plist * + *
+ * Navigate back: \ref index "Main" / \ref UG + * * \defgroup H5E Error Handling (H5E) * * \internal The \c FUNC_ENTER macro clears the error stack whenever an diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h index 81717f3971f..82749ada447 100644 --- a/src/H5Fmodule.h +++ b/src/H5Fmodule.h @@ -27,6 +27,9 @@ #define H5_MY_PKG_INIT YES /** \page H5F_UG HDF5 File + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_file The HDF5 File * \subsection subsec_file_intro Introduction @@ -1191,8 +1194,14 @@ * * Previous Chapter \ref sec_program - Next Chapter \ref sec_group * + *
+ * Navigate back: \ref index "Main" / \ref UG + * * \page H5FIM_UG HDF5 File Image * + * Navigate back: \ref index "Main" / \ref UG + *
+ * * \section sec_file_image HDF5 File Image * \subsection subsec_file_image_intro Introduction to HDF5 File Image Operations * File image operations allow users to work with HDF5 files in memory in the same ways that users currently @@ -2617,6 +2626,9 @@ * * Previous Chapter \ref sec_vol - Next Chapter \ref sec_async * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** diff --git a/src/H5Gmodule.h b/src/H5Gmodule.h index e25c851980a..7c6e2fe7da5 100644 --- a/src/H5Gmodule.h +++ b/src/H5Gmodule.h @@ -27,6 +27,9 @@ #define H5_MY_PKG_INIT YES /** \page H5G_UG HDF5 Groups + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_group HDF5 Groups * \subsection subsec_group_intro Introduction @@ -850,6 +853,9 @@ * * Previous Chapter \ref sec_file - Next Chapter \ref sec_dataset * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** diff --git a/src/H5Imodule.h b/src/H5Imodule.h index 45631409862..741bebcb4ba 100644 --- a/src/H5Imodule.h +++ b/src/H5Imodule.h @@ -27,7 +27,14 @@ #define H5_MY_PKG_INIT NO /** \page H5I_UG HDF5 Identifiers + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * * @todo Under Construction + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /** diff --git a/src/H5Lmodule.h b/src/H5Lmodule.h index 963005ab34e..33f4e331bb9 100644 --- a/src/H5Lmodule.h +++ b/src/H5Lmodule.h @@ -27,7 +27,14 @@ #define H5_MY_PKG_INIT YES /** \page H5L_UG HDF5 Links + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * * @todo Under Construction + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /** diff --git a/src/H5Mmodule.h b/src/H5Mmodule.h index a143fe3f1a5..24936b44729 100644 --- a/src/H5Mmodule.h +++ b/src/H5Mmodule.h @@ -28,6 +28,10 @@ /** * \page H5M_UG HDF5 VOL Data Mapping + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * * \Bold{The HDF5 Data Mapping can only be used with the HDF5 VOL connectors that * implement map objects.} The native HDF5 library does not support this feature. * @@ -37,7 +41,10 @@ * * \todo How does MAPL fit into \ref subsubsec_plist_class. * - * Previous Chapter \ref sec_async - Next Chapter \ref sec_addition + * Previous Chapter \ref sec_async - Next Chapter \ref sec_reference + * + *
+ * Navigate back: \ref index "Main" / \ref UG * */ diff --git a/src/H5Omodule.h b/src/H5Omodule.h index 4cd06fe3b0a..baaa3c67a15 100644 --- a/src/H5Omodule.h +++ b/src/H5Omodule.h @@ -27,7 +27,14 @@ #define H5_MY_PKG_INIT YES /** \page H5O_UG HDF5 Objects + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * * @todo Under Construction + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /** diff --git a/src/H5PLmodule.h b/src/H5PLmodule.h index 2d9564a0478..1d6a6fe1104 100644 --- a/src/H5PLmodule.h +++ b/src/H5PLmodule.h @@ -28,6 +28,9 @@ #define H5_MY_PKG_INIT YES /** \page H5PL_UG HDF5 Plugins + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_filter_plugins HDF5 Filter Plugins * @@ -369,6 +372,11 @@ * href="https://\PLURL/docs/INSTALL_With_CMake.txt">INSTALL_With_CMake * USING_HDF5_AND_CMake + * + * Previous Chapter \ref sec_reference - Next Chapter \ref sec_addition + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /** diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h index cd747b5a8f9..12eb11047ca 100644 --- a/src/H5Pmodule.h +++ b/src/H5Pmodule.h @@ -27,6 +27,9 @@ #define H5_MY_PKG_INIT YES /** \page H5P_UG Properties and Property Lists in HDF5 + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_plist Properties and Property Lists in HDF5 * @@ -879,6 +882,11 @@ * * Previous Chapter \ref sec_error - Next Chapter \ref sec_vol * + *
+ * Navigate back: \ref index "Main" / \ref UG + */ + +/** * \defgroup H5P Property Lists (H5P) * * Use the functions in this module to manage HDF5 property lists and property @@ -1051,7 +1059,7 @@ * created. ** \snippet{doc} tables/propertyLists.dox fcpl_table - *+ * * * \defgroup GAPL Group Access Properties * \ingroup LAPL diff --git a/src/H5Rmodule.h b/src/H5Rmodule.h index 78328effab5..8c78a511286 100644 --- a/src/H5Rmodule.h +++ b/src/H5Rmodule.h @@ -26,6 +26,9 @@ #define H5_MY_PKG_INIT YES /** \page H5R_UG HDF5 References + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_reference HDF5 References * HDF5 references allow users to reference existing HDF5 objects (file, group, dataset, named datatype, or @@ -391,6 +394,11 @@ * \endcode * * + * Previous Chapter \ref sec_map - Next Chapter \ref sec_filter_plugins + * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** diff --git a/src/H5Smodule.h b/src/H5Smodule.h index 44282a8794d..1af32771d8d 100644 --- a/src/H5Smodule.h +++ b/src/H5Smodule.h @@ -28,6 +28,8 @@ /** \page H5S_UG Dataspaces and Partial I/O * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_dataspace HDF5 Dataspaces and Partial I/O * @@ -1388,7 +1390,7 @@ * * This section contains the full programs from which several of the code examples in this chapter were * derived. The \ref sec_cltools_h5dump output from the program's output file immediately follows each - program. + * program. * * h5_write.c * \code @@ -1676,6 +1678,9 @@ * * Previous Chapter \ref sec_datatype - Next Chapter \ref sec_attribute * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** diff --git a/src/H5Tmodule.h b/src/H5Tmodule.h index 3f36fe3e40b..dee04c5169e 100644 --- a/src/H5Tmodule.h +++ b/src/H5Tmodule.h @@ -27,6 +27,9 @@ #define H5_MY_PKG_INIT YES /** \page H5T_UG HDF5 Datatypes + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_datatype HDF5 Datatypes * HDF5 datatypes describe the element type of HDF5 datasets and attributes. @@ -4118,6 +4121,9 @@ filled according to the value of this property. The padding can be: * * Previous Chapter \ref sec_dataset - Next Chapter \ref sec_dataspace * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** diff --git a/src/H5VLmodule.h b/src/H5VLmodule.h index 2bd6138229e..24c5968074b 100644 --- a/src/H5VLmodule.h +++ b/src/H5VLmodule.h @@ -28,6 +28,9 @@ #define H5_MY_PKG_INIT YES /** \page H5VL_UG HDF5 Virtual Object Layer (VOL) + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_vol The HDF5 Virtual Object Layer (VOL) * @@ -631,6 +634,9 @@ * * Previous Chapter \ref sec_plist - Next Chapter \ref sec_async * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** diff --git a/src/H5Zmodule.h b/src/H5Zmodule.h index 360af0911d8..9e483020bcc 100644 --- a/src/H5Zmodule.h +++ b/src/H5Zmodule.h @@ -27,7 +27,14 @@ #define H5_MY_PKG_INIT YES /** \page H5Z_UG HDF5 Filters + * + * Navigate back: \ref index "Main" / \ref UG + *
+ * * @todo Under Construction + * + *
+ * Navigate back: \ref index "Main" / \ref UG */ /** diff --git a/src/H5module.h b/src/H5module.h index cc63f6aec42..1248ba17fb4 100644 --- a/src/H5module.h +++ b/src/H5module.h @@ -27,6 +27,9 @@ #define H5_MY_PKG_INIT YES /** \page H5DM_UG HDF5 Data Model and File Structure + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_data_model The HDF5 Data Model and File Structure * @@ -606,9 +609,15 @@ * * Next Chapter \ref sec_program * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** \page H5_UG HDF5 Library and Programming Model + * + * Navigate back: \ref index "Main" / \ref UG + *
* * \section sec_program The HDF5 Library and Programming Model * \subsection subsec_program_intro Introduction @@ -1426,6 +1435,9 @@ * * Previous Chapter \ref sec_data_model - Next Chapter \ref sec_file * + *
+ * Navigate back: \ref index "Main" / \ref UG + * */ /** diff --git a/tools/src/h5copy/h5copy.h b/tools/src/h5copy/h5copy.h index db06efbc34e..b167f29a29c 100644 --- a/tools/src/h5copy/h5copy.h +++ b/tools/src/h5copy/h5copy.h @@ -14,6 +14,9 @@ #define H5COPY_H /** \page H5TOOL_CP_UG The HDF5 h5copy Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5copy h5copy * @@ -67,6 +70,11 @@ * \li #H5O_COPY_WITHOUT_ATTR_FLAG * \li #H5O_COPY_ALL * + * Next Chapter \ref sec_cltools_h5diff + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5COPY_H */ diff --git a/tools/src/h5diff/h5diff_main.h b/tools/src/h5diff/h5diff_main.h index 3efde6337ef..494bf553080 100644 --- a/tools/src/h5diff/h5diff_main.h +++ b/tools/src/h5diff/h5diff_main.h @@ -14,6 +14,9 @@ #define H5DIFF_H /** \page H5TOOL_DF_UG The HDF5 h5diff Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5diff h5diff * @@ -209,6 +212,11 @@ * file1 and file2 can be the same file. * Use h5diff file1 file1 /g1/dset1 /g1/dset2 to compare '/g1/dset1' and '/g1/dset2' in the same file * + * Previous Chapter \ref sec_cltools_h5copy - Next Chapter \ref sec_cltools_h5dump + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5DIFF_H */ diff --git a/tools/src/h5dump/h5dump.h b/tools/src/h5dump/h5dump.h index 57afd218684..f77c3af8964 100644 --- a/tools/src/h5dump/h5dump.h +++ b/tools/src/h5dump/h5dump.h @@ -13,6 +13,9 @@ #define H5DUMP_H /** \page H5TOOL_DP_UG The HDF5 h5dump Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5dump h5dump * @@ -193,6 +196,11 @@ * * h5dump --dataset=/foo --filedriver=family fam%05d.h5 * + * Previous Chapter \ref sec_cltools_h5diff - Next Chapter \ref sec_cltools_h5format_convert + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * * \subsubsection subsubsec_cltools_h5dump_xml XML Deprecated * The XML option for h5dump has been deprecated. The methods for displaying XML output * has not been updated since 1.10.0 was released. Many new features introduced into the diff --git a/tools/src/h5format_convert/h5format_convert.h b/tools/src/h5format_convert/h5format_convert.h index a08e8b3cec0..f7952ec233a 100644 --- a/tools/src/h5format_convert/h5format_convert.h +++ b/tools/src/h5format_convert/h5format_convert.h @@ -13,6 +13,9 @@ #define H5FORMAT_CONVERT_H /** \page H5TOOL_FC_UG The HDF5 h5format_convert Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5format_convert h5format_convert * @@ -53,6 +56,11 @@ * Go through all the steps except the actual conversion when * converting the dataset in the HDF5 file. * + * Previous Chapter \ref sec_cltools_h5dump - Next Chapter \ref sec_cltools_h5import + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5FORMAT_CONVERT_H */ diff --git a/tools/src/h5import/h5import.h b/tools/src/h5import/h5import.h index ac770928a87..dbd3972c57a 100644 --- a/tools/src/h5import/h5import.h +++ b/tools/src/h5import/h5import.h @@ -20,6 +20,9 @@ #define H5IMPORT_H /** \page H5TOOL_IM_UG The HDF5 h5import Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5import h5import * @@ -305,6 +308,11 @@ * The dataset will be stored at \code /Second-set \endcode * * + * Previous Chapter \ref sec_cltools_h5format_convert - Next Chapter \ref sec_cltools_h5jam + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ /* diff --git a/tools/src/h5jam/h5jam.h b/tools/src/h5jam/h5jam.h index fc0eca5279b..c4d7be3f76f 100644 --- a/tools/src/h5jam/h5jam.h +++ b/tools/src/h5jam/h5jam.h @@ -13,6 +13,9 @@ #define H5JAM_H /** \page H5TOOL_JAM_UG The HDF5 h5jam/h5unjam Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5jam h5jam * @@ -61,6 +64,11 @@ * If neither --delete nor -u is specified, the user block from the input * file will be displayed to stdout stream. * + * Previous Chapter \ref sec_cltools_h5import - Next Chapter \ref sec_cltools_h5ls + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5JAM_H */ diff --git a/tools/src/h5ls/h5ls.h b/tools/src/h5ls/h5ls.h index 6aee044cac9..a59d4b1d5b1 100644 --- a/tools/src/h5ls/h5ls.h +++ b/tools/src/h5ls/h5ls.h @@ -13,6 +13,9 @@ #define H5LS_H /** \page H5TOOL_LS_UG The HDF5 h5ls Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5ls h5ls * @@ -103,6 +106,11 @@ * \li --errors Show all HDF5 error reporting
* Replaced by --enable-error-stack. * + * Previous Chapter \ref sec_cltools_h5jam - Next Chapter \ref sec_cltools_h5repack + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5LS_H */ diff --git a/tools/src/h5repack/h5repack.h b/tools/src/h5repack/h5repack.h index 313dc411ef0..7a08f5e6418 100644 --- a/tools/src/h5repack/h5repack.h +++ b/tools/src/h5repack/h5repack.h @@ -14,6 +14,9 @@ #define H5REPACK_H /** \page H5TOOL_RP_UG The HDF5 h5repack Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5repack h5repack * @@ -236,6 +239,11 @@ * H5Pset_libver_bounds() when creating the repacked file, file2 * * + * Previous Chapter \ref sec_cltools_h5ls - Next Chapter \ref sec_cltools_h5stat + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #include "H5private.h" diff --git a/tools/src/h5stat/h5stat.h b/tools/src/h5stat/h5stat.h index 6d1bf184d62..66b15ecdff0 100644 --- a/tools/src/h5stat/h5stat.h +++ b/tools/src/h5stat/h5stat.h @@ -13,6 +13,9 @@ #define H5STAT_H /** \page H5TOOL_ST_UG The HDF5 h5stat Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5stat h5stat * @@ -60,6 +63,11 @@ * Has no effect if vfd flag is not 'hdfs'.
* If an attribute is empty, a default value will be used. * + * Previous Chapter \ref sec_cltools_h5repack - Next Chapter \ref sec_cltools_h5clear + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5STAT_H */ diff --git a/tools/src/misc/h5clear.h b/tools/src/misc/h5clear.h index e313424848c..1bdcde084ad 100644 --- a/tools/src/misc/h5clear.h +++ b/tools/src/misc/h5clear.h @@ -13,6 +13,9 @@ #define H5CLEAR_H /** \page H5TOOL_CR_UG The HDF5 h5clear Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5clear h5clear * @@ -62,6 +65,11 @@ * * Set the EOA to the maximum of (EOA, EOF) + 512 for the file\. * + * Previous Chapter \ref sec_cltools_h5stat - Next Chapter \ref sec_cltools_h5debug + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5CLEAR_H */ diff --git a/tools/src/misc/h5debug.h b/tools/src/misc/h5debug.h index 1a19a0b910c..bb7d59a5acd 100644 --- a/tools/src/misc/h5debug.h +++ b/tools/src/misc/h5debug.h @@ -13,6 +13,9 @@ #define H5DEBUG_H /** \page H5TOOL_DG_UG The HDF5 h5debug Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5debug h5debug * @@ -26,6 +29,11 @@ * \li signature-addr Primary data structure to dump * \li extra Extra arguments for primary data structure * + * Previous Chapter \ref sec_cltools_h5clear - Next Chapter \ref sec_cltools_h5delete + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5DEBUG_H */ diff --git a/tools/src/misc/h5delete.h b/tools/src/misc/h5delete.h index 2751b9b9425..d9dace5edd9 100644 --- a/tools/src/misc/h5delete.h +++ b/tools/src/misc/h5delete.h @@ -13,6 +13,9 @@ #define H5DELETE_H /** \page H5TOOL_DT_UG The HDF5 h5delete Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5delete h5delete * @@ -25,6 +28,11 @@ * \subsection subsec_cltools_h5delete_options Options * \li -f Suppress output * + * Previous Chapter \ref sec_cltools_h5debug - Next Chapter \ref sec_cltools_h5mkgrp + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5DELETE_H */ diff --git a/tools/src/misc/h5mkgrp.h b/tools/src/misc/h5mkgrp.h index d57a16a5970..305c3e13394 100644 --- a/tools/src/misc/h5mkgrp.h +++ b/tools/src/misc/h5mkgrp.h @@ -13,6 +13,9 @@ #define H5MKGRP_H /** \page H5TOOL_MG_UG The HDF5 h5mkgrp Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5mkgrp h5mkgrp * @@ -48,6 +51,11 @@ * \li --vfd-info VFD-specific info to pass to the VFL driver used for * opening the HDF5 file specified * + * Previous Chapter \ref sec_cltools_h5delete - Next Chapter \ref sec_cltools_h5repart + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5MKGRP_H */ diff --git a/tools/src/misc/h5repart.h b/tools/src/misc/h5repart.h index 655b210b0af..e2ba5672778 100644 --- a/tools/src/misc/h5repart.h +++ b/tools/src/misc/h5repart.h @@ -13,6 +13,9 @@ #define H5REPART_H /** \page H5TOOL_RT_UG The HDF5 h5repart Tool + * + * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + *
* * \section sec_cltools_h5repart h5repart * @@ -42,6 +45,11 @@ * Sizes may be suffixed with 'g' for GB, 'm' for MB or 'k' for kB. * File family names include an integer printf format such as '%%d' * + * Previous Chapter \ref sec_cltools_h5mkgrp - Next Chapter \ref sec_cltools_h5watch + * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref CommandTools + * */ #endif /* H5REPART_H */ - @ref sec_fmt2_intro
+Navigate back: \ref index "Main" / \ref TN + */ diff --git a/doxygen/dox/FreeingMemoryAllocatedByTheHdf5Library.dox b/doxygen/dox/FreeingMemoryAllocatedByTheHdf5Library.dox index bec5abe5df5..7af869c7cd5 100644 --- a/doxygen/dox/FreeingMemoryAllocatedByTheHdf5Library.dox +++ b/doxygen/dox/FreeingMemoryAllocatedByTheHdf5Library.dox @@ -1,4 +1,8 @@ /** \page freeing_memory Freeing Memory Allocated by the HDF5 Library + * + * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + *
+ * * 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. * + *
+ * Navigate back: \ref index "Main" / \ref UG / \ref AR_UG + * */ \ No newline at end of file diff --git a/doxygen/dox/GettingStarted.dox b/doxygen/dox/GettingStarted.dox index a37b197afea..52ad2c199bb 100644 --- a/doxygen/dox/GettingStarted.dox +++ b/doxygen/dox/GettingStarted.dox @@ -1,4 +1,4 @@ -/** @page GettingStarted Getting Started with HDF5 +/** \page GettingStarted Getting Started with HDF5 Navigate back: \ref index "Main"
diff --git a/doxygen/dox/Glossary.dox b/doxygen/dox/Glossary.dox index 6822cc9bbd7..f449e58d0a9 100644 --- a/doxygen/dox/Glossary.dox +++ b/doxygen/dox/Glossary.dox @@ -1,5 +1,8 @@ /** \page GLS Glossary +Navigate back: \ref index "Main" +
+ \section GLS_A A
-
@@ -571,4 +574,7 @@ and an HDF5 path name in that file.
+Navigate back: \ref index "Main" + */ diff --git a/doxygen/dox/H5.format.1.0.dox b/doxygen/dox/H5.format.1.0.dox index a5606b09a13..ad14f861ef6 100644 --- a/doxygen/dox/H5.format.1.0.dox +++ b/doxygen/dox/H5.format.1.0.dox @@ -1,5 +1,9 @@ /** \page FMT1 HDF5 File Format Specification Version 1.0 + +Navigate back: \ref index "Main" / \ref SPEC +
+
+Navigate back: \ref index "Main" / \ref SPEC + */ diff --git a/doxygen/dox/H5.format.1.1.dox b/doxygen/dox/H5.format.1.1.dox index 136aab3dbd6..2ddceece987 100644 --- a/doxygen/dox/H5.format.1.1.dox +++ b/doxygen/dox/H5.format.1.1.dox @@ -1,5 +1,9 @@ /** \page FMT11 HDF5 File Format Specification Version 1.1 + +Navigate back: \ref index "Main" / \ref SPEC +
+