summaryrefslogtreecommitdiffstats
path: root/doxygen/examples
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-09-13 03:37:01 (GMT)
committerGitHub <noreply@github.com>2022-09-13 03:37:01 (GMT)
commit9348ba920eecacd35adde6c4573cc85c6033dc65 (patch)
tree9e23eb5142b4bbed1385c88d7409cd3c5586e5d3 /doxygen/examples
parent033b7ace5aff35cced7561921789176fb3831cdb (diff)
downloadhdf5-9348ba920eecacd35adde6c4573cc85c6033dc65.zip
hdf5-9348ba920eecacd35adde6c4573cc85c6033dc65.tar.gz
hdf5-9348ba920eecacd35adde6c4573cc85c6033dc65.tar.bz2
1 12 doxygen merge from 1.10 (#2094)
Diffstat (limited to 'doxygen/examples')
-rw-r--r--doxygen/examples/fortran_menu.md46
-rw-r--r--doxygen/examples/high_level_menu.md12
2 files changed, 35 insertions, 23 deletions
diff --git a/doxygen/examples/fortran_menu.md b/doxygen/examples/fortran_menu.md
index 335a21a..8ef4ead 100644
--- a/doxygen/examples/fortran_menu.md
+++ b/doxygen/examples/fortran_menu.md
@@ -1,61 +1,73 @@
<b>Fortran Library</b>
-- H5A "Attributes (H5A)"
+- @ref FH5A "Attributes (H5A)"
<br />
HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object.
-- H5D "Datasets (H5D)"
+- @ref FH5D "Datasets (H5D)"
<br />
Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties.
-- H5S "Dataspaces (H5S)"
+- @ref FH5S "Dataspaces (H5S)"
<br />
HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files.
-- H5T "Datatypes (H5T)"
+- @ref FH5T "Datatypes (H5T)"
<br />
HDF5 datatypes describe the element type of HDF5 datasets and attributes.
-- H5E "Error Handling (H5E)"
+- @ref FH5E "Error Handling (H5E)"
<br />
HDF5 library error reporting.
-- H5F "Files (H5F)"
+- @ref FH5F "Files (H5F)"
<br />
Manage HDF5 files.
-- H5Z "Filters (H5Z)"
+- @ref FH5Z "Filters (H5Z)"
<br />
Manage HDF5 user-defined filters
-- H5G "Groups (H5G)"
+- @ref FH5G "Groups (H5G)"
<br />
Manage HDF5 groups.
-- H5I "Identifiers (H5I)"
+- @ref FH5I "Identifiers (H5I)"
<br />
Manage identifiers defined by the HDF5 library.
-- H5 "Library General (H5)"
+- @ref FH5 "Library General (H5)"
<br />
Manage the life cycle of HDF5 library instances.
-- H5L "Links (H5L)"
+- @ref FH5L "Links (H5L)"
<br />
Manage HDF5 links and link types.
-- H5O "Objects (H5O)"
+- @ref FH5O "Objects (H5O)"
<br />
Manage HDF5 objects (groups, datasets, datatype objects).
-- H5P "Property Lists (H5P)"
+- @ref FH5P "Property Lists (H5P)"
<br />
HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions.
-- H5PL "Dynamically-loaded Plugins (H5PL)"
+- @ref FH5R "References (H5R)"
<br />
-Manage the loading behavior of HDF5 plugins.
+Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions).
-- H5R "References (H5R)"
+- @ref FH5LT "High Level Lite (H5LT)"
<br />
-Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions).
+Functions to simplify creating and manipulating datasets, attributes and other features
+
+- @ref FH5IM "High Level Image (H5IM)"
+<br />
+Creating and manipulating HDF5 datasets intended to be interpreted as images
+
+- @ref FH5TB "High Level Table (H5TB)"
+<br />
+Creating and manipulating HDF5 datasets intended to be interpreted as tables
+
+- @ref FH5DS "High Level Dimension Scale (H5DS)"
+<br />
+Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset
diff --git a/doxygen/examples/high_level_menu.md b/doxygen/examples/high_level_menu.md
index 9e6f696..d209bf4 100644
--- a/doxygen/examples/high_level_menu.md
+++ b/doxygen/examples/high_level_menu.md
@@ -3,27 +3,27 @@
The high-level HDF5 library includes several sets of convenience and standard-use APIs to
facilitate common HDF5 operations.
-- @ref H5LT "Lite (H5LT, H5LD)"
+- @ref H5LT
<br />
Functions to simplify creating and manipulating datasets, attributes and other features
-- @ref H5IM "Image (H5IM)"
+- @ref H5IM
<br />
Creating and manipulating HDF5 datasets intended to be interpreted as images
-- @ref H5TB "Table (H5TB)"
+- @ref H5TB
<br />
Creating and manipulating HDF5 datasets intended to be interpreted as tables
-- @ref H5PT "Packet Table (H5PT)"
+- @ref H5PT
<br />
Creating and manipulating HDF5 datasets to support append- and read-only operations on table data
-- @ref H5DS "Dimension Scale (H5DS)"
+- @ref H5DS
<br />
Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset
-- @ref H5DO "Optimizations (H5DO)"
+- @ref H5DO
<br />
Bypassing default HDF5 behavior in order to optimize for specific use cases