summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-09-09 01:33:47 (GMT)
committerGitHub <noreply@github.com>2022-09-09 01:33:47 (GMT)
commitc28fb80cf600c0cb84f78ab75f51515d916091f7 (patch)
tree4aa78f3d0575a4e1c68705f269c1a5b47df07faa /src
parent32a0ed93dc75fb9cfe6f2e4d59233f4c600d746f (diff)
downloadhdf5-c28fb80cf600c0cb84f78ab75f51515d916091f7.zip
hdf5-c28fb80cf600c0cb84f78ab75f51515d916091f7.tar.gz
hdf5-c28fb80cf600c0cb84f78ab75f51515d916091f7.tar.bz2
Main Getting Started page and the three HDF Resources have pages. (#2092)
HDFView is still under construction, but mostly there. Merge the Fortran doxygen changes from develop PR, updated RM index. Adjusted references to UG and created some TODOs for missing UG modules Some may just need a reference back to a section of the user guide. Made some Fortran doxygen changes for overall consistency.
Diffstat (limited to 'src')
-rw-r--r--src/H5Dpublic.h12
-rw-r--r--src/H5Imodule.h4
-rw-r--r--src/H5Lmodule.h4
-rw-r--r--src/H5Omodule.h4
-rw-r--r--src/H5PLmodule.h4
-rw-r--r--src/H5Rmodule.h4
-rw-r--r--src/H5Zmodule.h4
7 files changed, 30 insertions, 6 deletions
diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h
index 9709289..d9596ac 100644
--- a/src/H5Dpublic.h
+++ b/src/H5Dpublic.h
@@ -588,10 +588,10 @@ H5_DLL herr_t H5Dget_num_chunks(hid_t dset_id, hid_t fspace_id, hsize_t *nchunks
* \brief Retrieves information about a chunk specified by its coordinates
*
* \dset_id
- * \param[in] offset Logical position of the chunk’s first element
- * \param[out] filter_mask Indicating filters used with the chunk when written
+ * \param[in] offset Logical position of the chunk’s first element in units of dataset elements
+ * \param[out] filter_mask Bitmask indicating the filters used when the chunk was written
* \param[out] addr Chunk address in the file
- * \param[out] size Chunk size in bytes, 0 if chunk doesn’t exist
+ * \param[out] size Chunk size in bytes, 0 if the chunk does not exist
*
* \return \herr_t
*
@@ -622,10 +622,10 @@ H5_DLL herr_t H5Dget_chunk_info_by_coord(hid_t dset_id, const hsize_t *offset, u
* \dset_id
* \param[in] fspace_id File dataspace selection identifier (See Note below)
* \param[in] chk_idx Index of the chunk
- * \param[out] offset Logical position of the chunk’s first element
- * \param[out] filter_mask Indicating filters used with the chunk when written
+ * \param[out] offset Logical position of the chunk’s first element in units of dataset elements
+ * \param[out] filter_mask Bitmask indicating the filters used when the chunk was written
* \param[out] addr Chunk address in the file
- * \param[out] size Chunk size in bytes, 0 if chunk doesn’t exist
+ * \param[out] size Chunk size in bytes, 0 if the chunk does not exist
*
* \return \herr_t
*
diff --git a/src/H5Imodule.h b/src/H5Imodule.h
index 1ad9f1b..71b8f7d 100644
--- a/src/H5Imodule.h
+++ b/src/H5Imodule.h
@@ -29,6 +29,10 @@
#define H5_MY_PKG_ERR H5E_ATOM
#define H5_MY_PKG_INIT NO
+/** \page H5I_UG The HDF5 Identifiers
+ * @todo Under Construction
+ */
+
/**
* \defgroup H5I Identifiers (H5I)
*
diff --git a/src/H5Lmodule.h b/src/H5Lmodule.h
index f61b891..f373ba1 100644
--- a/src/H5Lmodule.h
+++ b/src/H5Lmodule.h
@@ -29,6 +29,10 @@
#define H5_MY_PKG_ERR H5E_LINK
#define H5_MY_PKG_INIT YES
+/** \page H5L_UG The HDF5 Links
+ * @todo Under Construction
+ */
+
/**
* \defgroup H5L Links (H5L)
*
diff --git a/src/H5Omodule.h b/src/H5Omodule.h
index 977861b..0c482c5 100644
--- a/src/H5Omodule.h
+++ b/src/H5Omodule.h
@@ -29,6 +29,10 @@
#define H5_MY_PKG_ERR H5E_OHDR
#define H5_MY_PKG_INIT YES
+/** \page H5O_UG The HDF5 Objects
+ * @todo Under Construction
+ */
+
/**
* \defgroup H5O Objects (H5O)
*
diff --git a/src/H5PLmodule.h b/src/H5PLmodule.h
index 84d3583..66a24fd 100644
--- a/src/H5PLmodule.h
+++ b/src/H5PLmodule.h
@@ -27,6 +27,10 @@
#define H5_MY_PKG_ERR H5E_PLUGIN
#define H5_MY_PKG_INIT YES
+/** \page H5PL_UG The HDF5 Plugins
+ * @todo Under Construction
+ */
+
/**
* \defgroup H5PL Dynamically-loaded Plugins (H5PL)
*
diff --git a/src/H5Rmodule.h b/src/H5Rmodule.h
index c561058..eb69466 100644
--- a/src/H5Rmodule.h
+++ b/src/H5Rmodule.h
@@ -25,6 +25,10 @@
#define H5_MY_PKG_ERR H5E_REFERENCE
#define H5_MY_PKG_INIT YES
+/** \page H5R_UG The HDF5 References
+ * @todo Under Construction
+ */
+
/**
* \defgroup H5R References (H5R)
*
diff --git a/src/H5Zmodule.h b/src/H5Zmodule.h
index b3a52fd..fddfd7f 100644
--- a/src/H5Zmodule.h
+++ b/src/H5Zmodule.h
@@ -29,6 +29,10 @@
#define H5_MY_PKG_ERR H5E_PLINE
#define H5_MY_PKG_INIT YES
+/** \page H5Z_UG The HDF5 Filters
+ * @todo Under Construction
+ */
+
/**
* \defgroup H5Z Filters (H5Z)
*