summaryrefslogtreecommitdiffstats
path: root/hl/src
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 /hl/src
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 'hl/src')
-rw-r--r--hl/src/H5LDpublic.h6
-rw-r--r--hl/src/H5LTpublic.h117
2 files changed, 61 insertions, 62 deletions
diff --git a/hl/src/H5LDpublic.h b/hl/src/H5LDpublic.h
index e42c8d8..611fcc5 100644
--- a/hl/src/H5LDpublic.h
+++ b/hl/src/H5LDpublic.h
@@ -34,7 +34,7 @@ extern "C" {
* It will return failure if \p cur_dims is NULL.
*
* \note See Also:
- * \note Dataset Watch functions (used with \ref h5watch):
+ * \note Dataset Watch functions (used with h5watch):
* - H5LDget_dset_dims()
* - H5LDget_dset_elmts()
* - H5LDget_dset_type_size()
@@ -71,7 +71,7 @@ H5_HLDLL herr_t H5LDget_dset_dims(hid_t did, hsize_t *cur_dims);
* conflict with these two separators.
*
* \note See Also:
- * \note Dataset Watch functions (used with \ref h5watch):
+ * \note Dataset Watch functions (used with h5watch):
* - H5LDget_dset_dims()
* - H5LDget_dset_elmts()
* - H5LDget_dset_type_size()
@@ -123,7 +123,7 @@ H5_HLDLL size_t H5LDget_dset_type_size(hid_t did, const char *fields);
* two separators.
*
* \note See Also:
- * \note Dataset Watch functions (used with \ref h5watch):
+ * \note Dataset Watch functions (used with h5watch):
* - H5LDget_dset_dims()
* - H5LDget_dset_elmts()
* - H5LDget_dset_type_size()
diff --git a/hl/src/H5LTpublic.h b/hl/src/H5LTpublic.h
index 53cd38e..6e25afa 100644
--- a/hl/src/H5LTpublic.h
+++ b/hl/src/H5LTpublic.h
@@ -60,89 +60,89 @@ extern "C" {
*
* - Dataset Functions
* - Make dataset functions
- * - \ref H5LTmake_dataset
- * - \ref H5LTmake_dataset_char
- * - \ref H5LTmake_dataset_short
- * - \ref H5LTmake_dataset_int
- * - \ref H5LTmake_dataset_long
- * - \ref H5LTmake_dataset_float
- * - \ref H5LTmake_dataset_double
- * - \ref H5LTmake_dataset_string
+ * - \ref H5LTmake_dataset
+ * - \ref H5LTmake_dataset_char
+ * - \ref H5LTmake_dataset_short
+ * - \ref H5LTmake_dataset_int
+ * - \ref H5LTmake_dataset_long
+ * - \ref H5LTmake_dataset_float
+ * - \ref H5LTmake_dataset_double
+ * - \ref H5LTmake_dataset_string
*
* - Read dataset functions
- * - \ref H5LTread_dataset
- * - \ref H5LTread_dataset_char
- * - \ref H5LTread_dataset_short
- * - \ref H5LTread_dataset_int
- * - \ref H5LTread_dataset_long
- * - \ref H5LTread_dataset_float
- * - \ref H5LTread_dataset_double
- * - \ref H5LTread_dataset_string
+ * - \ref H5LTread_dataset
+ * - \ref H5LTread_dataset_char
+ * - \ref H5LTread_dataset_short
+ * - \ref H5LTread_dataset_int
+ * - \ref H5LTread_dataset_long
+ * - \ref H5LTread_dataset_float
+ * - \ref H5LTread_dataset_double
+ * - \ref H5LTread_dataset_string
*
* - Query dataset functions
- * - \ref H5LTfind_dataset
- * - \ref H5LTget_dataset_ndims
- * - \ref H5LTget_dataset_info
+ * - \ref H5LTfind_dataset
+ * - \ref H5LTget_dataset_ndims
+ * - \ref H5LTget_dataset_info
*
* - Dataset watch functions
- * - \ref H5LDget_dset_dims
- * - \ref H5LDget_dset_elmts
- * - \ref H5LDget_dset_type_size
+ * - \ref H5LDget_dset_dims
+ * - \ref H5LDget_dset_elmts
+ * - \ref H5LDget_dset_type_size
*
* </td><td style="border: none;">
*
* - Attribute Functions
* - Set attribute functions
- * - \ref H5LTset_attribute_string
- * - \ref H5LTset_attribute_char
- * - \ref H5LTset_attribute_uchar
- * - \ref H5LTset_attribute_short
- * - \ref H5LTset_attribute_ushort
- * - \ref H5LTset_attribute_int
- * - \ref H5LTset_attribute_uint
- * - \ref H5LTset_attribute_long
- * - \ref H5LTset_attribute_long_long
- * - \ref H5LTset_attribute_ulong
- * - \ref H5LTset_attribute_ullong
- * - \ref H5LTset_attribute_float
- * - \ref H5LTset_attribute_double
- * - <code>H5LTset_attribute_f</code> (fortran ONLY)
+ * - \ref H5LTset_attribute_string
+ * - \ref H5LTset_attribute_char
+ * - \ref H5LTset_attribute_uchar
+ * - \ref H5LTset_attribute_short
+ * - \ref H5LTset_attribute_ushort
+ * - \ref H5LTset_attribute_int
+ * - \ref H5LTset_attribute_uint
+ * - \ref H5LTset_attribute_long
+ * - \ref H5LTset_attribute_long_long
+ * - \ref H5LTset_attribute_ulong
+ * - \ref H5LTset_attribute_ullong
+ * - \ref H5LTset_attribute_float
+ * - \ref H5LTset_attribute_double
+ * - <code>H5LTset_attribute_f</code> (fortran ONLY)
*
* - Get attribute functions
- * - \ref H5LTget_attribute
- * - \ref H5LTget_attribute_string
- * - \ref H5LTget_attribute_char
- * - \ref H5LTget_attribute_uchar
- * - \ref H5LTget_attribute_short
- * - \ref H5LTget_attribute_ushort
- * - \ref H5LTget_attribute_int
- * - \ref H5LTget_attribute_uint
- * - \ref H5LTget_attribute_long
- * - \ref H5LTget_attribute_long_long
- * - \ref H5LTget_attribute_ulong
- * - \ref H5LTget_attribute_ullong
- * - \ref H5LTget_attribute_float
- * - \ref H5LTget_attribute_double
+ * - \ref H5LTget_attribute
+ * - \ref H5LTget_attribute_string
+ * - \ref H5LTget_attribute_char
+ * - \ref H5LTget_attribute_uchar
+ * - \ref H5LTget_attribute_short
+ * - \ref H5LTget_attribute_ushort
+ * - \ref H5LTget_attribute_int
+ * - \ref H5LTget_attribute_uint
+ * - \ref H5LTget_attribute_long
+ * - \ref H5LTget_attribute_long_long
+ * - \ref H5LTget_attribute_ulong
+ * - \ref H5LTget_attribute_ullong
+ * - \ref H5LTget_attribute_float
+ * - \ref H5LTget_attribute_double
*
* - Query attribute functions
- * - \ref H5LTfind_attribute
- * - \ref H5LTget_attribute_info
- * - \ref H5LTget_attribute_ndims
+ * - \ref H5LTfind_attribute
+ * - \ref H5LTget_attribute_info
+ * - \ref H5LTget_attribute_ndims
*
* </td><td style="border: none;">
*
* - Datatype Functions
* - Datatype translation functions
- * - \ref H5LTtext_to_dtype
- * - \ref H5LTdtype_to_text
+ * - \ref H5LTtext_to_dtype
+ * - \ref H5LTdtype_to_text
*
* - File image function
* - Open file image function
- * - \ref H5LTopen_file_image
+ * - \ref H5LTopen_file_image
*
* - Path and object function
* - Query path and object function
- * - \ref H5LTpath_valid
+ * - \ref H5LTpath_valid
*
* </td></tr>
* </table>
@@ -1516,8 +1516,7 @@ H5_HLDLL herr_t H5LTfind_attribute(hid_t loc_id, const char *name);
* indicating the file’s root group, followed by the members
* - A relative path with respect to \p loc_id
* - A dot (\c .), if \p loc_id is the object identifier for
- * the object itself
- * .
+ * the object itself.
*
* If \p path is an absolute path, then \p loc_id can be an
* identifier for any object in the file as it is used only to