From c8371caa6b9f25a173298ac18c857a1997df0fb9 Mon Sep 17 00:00:00 2001
From: bmribler <39579120+bmribler@users.noreply.github.com>
Date: Mon, 3 Jun 2024 08:46:41 -0400
Subject: [PATCH] Fix various mistakes in doxygen docs (#4541)
* Fix a dead link and example file names
* Add the missing content of a section
---
doxygen/dox/IntroParHDF5.dox | 15 ++++++++++-----
doxygen/dox/LearnBasics3.dox | 13 +++++++++++++
doxygen/img/tutr-lodset.png | Bin 0 -> 15071 bytes
3 files changed, 23 insertions(+), 5 deletions(-)
create mode 100755 doxygen/img/tutr-lodset.png
diff --git a/doxygen/dox/IntroParHDF5.dox b/doxygen/dox/IntroParHDF5.dox
index 884d9d254b2..b8785d43c9d 100644
--- a/doxygen/dox/IntroParHDF5.dox
+++ b/doxygen/dox/IntroParHDF5.dox
@@ -35,7 +35,8 @@ The following shows the Parallel HDF5 implementation layers:
This tutorial assumes that you are somewhat familiar with parallel programming with MPI (Message Passing Interface).
If you are not familiar with parallel programming, here is a tutorial that may be of interest:
-Tutorial on HDF5 I/O tuning at NERSC
+Tutorial on HDF5 I/O tuning at NERSC.
+(NOTE: As of 2024, the specific systems described in this tutorial are outdated.)
Some of the terms that you must understand in this tutorial are:
@@ -150,8 +151,10 @@ Following is example code for creating an access template in HDF5:
\endcode
The following example programs create an HDF5 file using Parallel HDF5:
-C: file_create.c
-F90: file_create.F90
+
+C: ph5_file_create.c
+
+F90: ph5_f90_file_create.F90
\subsection subsec_pintro_create_dset Creating and Accessing a Dataset with PHDF5
@@ -231,8 +234,10 @@ The following code demonstrates a collective write using Parallel HDF5:
\endcode
The following example programs create an HDF5 dataset using Parallel HDF5:
-C: dataset.c
-F90: dataset.F90
+
+C: ph5_dataset.c
+
+F90: ph5_f90_dataset.F90
\subsubsection subsec_pintro_hyperslabs Hyperslabs
diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox
index ca9ba8bdc4a..3e9dd8ea090 100644
--- a/doxygen/dox/LearnBasics3.dox
+++ b/doxygen/dox/LearnBasics3.dox
@@ -48,6 +48,19 @@ Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
\section secLBDsetLayoutDesc Description of a Dataset
+The Creating a Dataset tutorial topic defines a dataset as a multidimensional array of data elements together with supporting metadata, where:
+
+\li The array of elements consists of the raw data values that a user wishes to store in HDF5.
+\li The supporting metadata describes that data. The metadata is stored in the dataset (object) header of a dataset.
+
+Datatype, dataspace, attribute, and storage layout information were introduced as part of the metadata associated with a dataset:
+