summaryrefslogtreecommitdiffstats
path: root/hl
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-09-09 23:07:02 (GMT)
committerGitHub <noreply@github.com>2022-09-09 23:07:02 (GMT)
commit31f9f84a937d2ec89b7aab02a6672c0ea01994f5 (patch)
tree0235c0452ff10c94b2a1a00981f349c194382e73 /hl
parentc28fb80cf600c0cb84f78ab75f51515d916091f7 (diff)
downloadhdf5-31f9f84a937d2ec89b7aab02a6672c0ea01994f5.zip
hdf5-31f9f84a937d2ec89b7aab02a6672c0ea01994f5.tar.gz
hdf5-31f9f84a937d2ec89b7aab02a6672c0ea01994f5.tar.bz2
1.10 Port "learn HDF5" tutorial to doxygen (#2093)
Diffstat (limited to 'hl')
-rw-r--r--hl/src/H5DOpublic.h6
-rw-r--r--hl/src/H5DSpublic.h2
-rw-r--r--hl/src/H5IMpublic.h4
-rw-r--r--hl/src/H5LTpublic.h2
-rw-r--r--hl/src/H5PTpublic.h2
-rw-r--r--hl/src/H5TBpublic.h2
6 files changed, 11 insertions, 7 deletions
diff --git a/hl/src/H5DOpublic.h b/hl/src/H5DOpublic.h
index 13b2422..20f4c98 100644
--- a/hl/src/H5DOpublic.h
+++ b/hl/src/H5DOpublic.h
@@ -18,7 +18,11 @@
extern "C" {
#endif
-/**\defgroup H5DO Optimizations
+/** \page H5DO_UG The HDF5 High Level Optimizations
+ * @todo Under Construction
+ */
+
+/**\defgroup H5DO HDF5 Optimizations APIs (H5DO)
*
* <em>Bypassing default HDF5 behavior in order to optimize for specific
* use cases (H5DO)</em>
diff --git a/hl/src/H5DSpublic.h b/hl/src/H5DSpublic.h
index 9d403a9..1f187c3 100644
--- a/hl/src/H5DSpublic.h
+++ b/hl/src/H5DSpublic.h
@@ -35,7 +35,7 @@ extern "C" {
* @todo Under Construction
*/
-/**\defgroup H5DS Dimension Scales
+/**\defgroup H5DS HDF5 Dimension Scales APIs (H5DS)
*
* <em>Creating and manipulating HDF5 datasets that are associated with
* the dimension of another HDF5 dataset (H5DS)</em>
diff --git a/hl/src/H5IMpublic.h b/hl/src/H5IMpublic.h
index 93f0569..bccf3c4 100644
--- a/hl/src/H5IMpublic.h
+++ b/hl/src/H5IMpublic.h
@@ -22,7 +22,7 @@ extern "C" {
* @todo Under Construction
*/
-/**\defgroup H5IM Images
+/**\defgroup H5IM HDF5 Images API (H5IM)
*
* <em>Creating and manipulating HDF5 datasets intended to be
* interpreted as images (H5IM)</em>
@@ -31,7 +31,7 @@ extern "C" {
* document: \ref IMG
* This version of the API is primarily concerned with two dimensional raster
* data similar to HDF4 Raster Images.
- * The HDF5 Images API uses the \ref H5LT HDF5 API.
+ * The HDF5 Images API uses the \ref H5LT.
*
* \note \Bold{Programming hints:}
* \note To use any of these functions or subroutines,
diff --git a/hl/src/H5LTpublic.h b/hl/src/H5LTpublic.h
index ba9d3af..0004d6d 100644
--- a/hl/src/H5LTpublic.h
+++ b/hl/src/H5LTpublic.h
@@ -39,7 +39,7 @@ extern "C" {
* @todo Under Construction
*/
-/**\defgroup H5LT Lite
+/**\defgroup H5LT HDF5 Lite APIs (H5LT,H5LD)
* <em>Functions used to simplify creating and manipulating datasets,
* attributes and other features (H5LT, H5LD)</em>
*
diff --git a/hl/src/H5PTpublic.h b/hl/src/H5PTpublic.h
index bae10a5..6552aa9 100644
--- a/hl/src/H5PTpublic.h
+++ b/hl/src/H5PTpublic.h
@@ -22,7 +22,7 @@ extern "C" {
* @todo Under Construction
*/
-/**\defgroup H5PT Packet Table
+/**\defgroup H5PT HDF5 Packet Table APIs (H5PT)
*
* <em>Creating and manipulating HDF5 datasets to support append-
* and read-only operations on table data (H5PT)</em>
diff --git a/hl/src/H5TBpublic.h b/hl/src/H5TBpublic.h
index 9cb92a1..44b122c 100644
--- a/hl/src/H5TBpublic.h
+++ b/hl/src/H5TBpublic.h
@@ -22,7 +22,7 @@ extern "C" {
* @todo Under Construction
*/
-/**\defgroup H5TB Table
+/**\defgroup H5TB HDF5 Table APIs (H5TB)
*
* <em>Creating and manipulating HDF5 datasets intended to be
* interpreted as tables (H5TB)</em>