summaryrefslogtreecommitdiffstats
path: root/hl/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 /hl/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 'hl/src')
-rw-r--r--hl/src/H5DSpublic.h4
-rw-r--r--hl/src/H5IMpublic.h4
-rw-r--r--hl/src/H5LDpublic.h2
-rw-r--r--hl/src/H5LTpublic.h4
-rw-r--r--hl/src/H5PTpublic.h4
-rw-r--r--hl/src/H5TBpublic.h6
6 files changed, 21 insertions, 3 deletions
diff --git a/hl/src/H5DSpublic.h b/hl/src/H5DSpublic.h
index 8449a0d..9d403a9 100644
--- a/hl/src/H5DSpublic.h
+++ b/hl/src/H5DSpublic.h
@@ -31,6 +31,10 @@ typedef herr_t (*H5DS_iterate_t)(hid_t dset, unsigned dim, hid_t scale, void *vi
extern "C" {
#endif
+/** \page H5DS_UG The HDF5 High Level Dimension Scales
+ * @todo Under Construction
+ */
+
/**\defgroup H5DS Dimension Scales
*
* <em>Creating and manipulating HDF5 datasets that are associated with
diff --git a/hl/src/H5IMpublic.h b/hl/src/H5IMpublic.h
index b5426d6..93f0569 100644
--- a/hl/src/H5IMpublic.h
+++ b/hl/src/H5IMpublic.h
@@ -18,6 +18,10 @@
extern "C" {
#endif
+/** \page H5IM_UG The HDF5 High Level Images
+ * @todo Under Construction
+ */
+
/**\defgroup H5IM Images
*
* <em>Creating and manipulating HDF5 datasets intended to be
diff --git a/hl/src/H5LDpublic.h b/hl/src/H5LDpublic.h
index 611fcc5..363b59c 100644
--- a/hl/src/H5LDpublic.h
+++ b/hl/src/H5LDpublic.h
@@ -107,7 +107,7 @@ H5_HLDLL size_t H5LDget_dset_type_size(hid_t did, const char *fields);
* selected from the dataset. Note that \p cur_dims must have
* at least one dimension whose size is greater than the
* corresponding dimension in \p prev_dims. Users can
- * determine the size of buf by multipling the datatype
+ * determine the size of buf by multiplying the datatype
* size of the dataset by the number of selected elements.
*
* If the parameter \p fields is NULL, this routine returns
diff --git a/hl/src/H5LTpublic.h b/hl/src/H5LTpublic.h
index 56cebc1..ba9d3af 100644
--- a/hl/src/H5LTpublic.h
+++ b/hl/src/H5LTpublic.h
@@ -35,6 +35,10 @@ typedef enum H5LT_lang_t {
extern "C" {
#endif
+/** \page H5LT_UG The HDF5 High Level Lite
+ * @todo Under Construction
+ */
+
/**\defgroup H5LT Lite
* <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 185e4a4..bae10a5 100644
--- a/hl/src/H5PTpublic.h
+++ b/hl/src/H5PTpublic.h
@@ -18,6 +18,10 @@
extern "C" {
#endif
+/** \page H5PT_UG The HDF5 High Level Packet Table
+ * @todo Under Construction
+ */
+
/**\defgroup H5PT Packet Table
*
* <em>Creating and manipulating HDF5 datasets to support append-
diff --git a/hl/src/H5TBpublic.h b/hl/src/H5TBpublic.h
index 9ad8e08..9cb92a1 100644
--- a/hl/src/H5TBpublic.h
+++ b/hl/src/H5TBpublic.h
@@ -18,6 +18,10 @@
extern "C" {
#endif
+/** \page H5TB_UG The HDF5 High Level Table
+ * @todo Under Construction
+ */
+
/**\defgroup H5TB Table
*
* <em>Creating and manipulating HDF5 datasets intended to be
@@ -656,12 +660,10 @@ H5_HLDLL herr_t H5TBAget_title(hid_t loc_id, char *table_title);
* \return A return value of 0 indicates a fill value is not present.
* \return A return value <0 indicates an error.
*
- *
* \details H5TBget_fill() reads the table attribute fill values into
* the buffer \p dst_buf for the table specified by \p dset_id
* and \p dset_name located in \p loc_id.
*
- *
* \par Example
* \include H5TBAget_fill.c
*