summaryrefslogtreecommitdiffstats
path: root/src/H5Mmodule.h
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-08-09 23:11:14 (GMT)
committerGitHub <noreply@github.com>2022-08-09 23:11:14 (GMT)
commit4c66bf627ec4b963f026bbfa7101127271644f79 (patch)
tree4a4352a58dde0a80f7f72eab56484ddd94ec2294 /src/H5Mmodule.h
parentfc9f31ad8c8ff4122e8bb2997e0a2bfa89cb054b (diff)
downloadhdf5-4c66bf627ec4b963f026bbfa7101127271644f79.zip
hdf5-4c66bf627ec4b963f026bbfa7101127271644f79.tar.gz
hdf5-4c66bf627ec4b963f026bbfa7101127271644f79.tar.bz2
Merge UG from 1.10 and add prelim vol section (#1980)
* Merge UG from 1.10 and add prelim vol section * Spelling fixes * Merge format and autotools javadoc from 1.10
Diffstat (limited to 'src/H5Mmodule.h')
-rw-r--r--src/H5Mmodule.h16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/H5Mmodule.h b/src/H5Mmodule.h
index 848f63f..6c49a45 100644
--- a/src/H5Mmodule.h
+++ b/src/H5Mmodule.h
@@ -26,10 +26,24 @@
#define H5_MY_PKG_ERR H5E_MAP
#define H5_MY_PKG_INIT YES
-/**\defgroup H5M H5M
+/**
+ * \page H5M_UG The HDF5 VOL Data Mapping
+ * \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.
+ *
+ * \section sec_map The HDF5 Map Object
*
* \todo Describe the map life cycle.
*
+ * \todo How does MAPL fit into \ref subsubsec_plist_class.
+ *
+ * Previous Chapter \ref sec_vol - Next Chapter \ref sec_addition
+ *
+ */
+
+/**
+ * \defgroup H5M VOL Mapping (H5M)
+ *
* \details \Bold{The interface can only be used with the HDF5 VOL connectors that
* implement map objects.} The native HDF5 library does not support this
* feature.