diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2022-12-21 14:10:24 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-21 14:10:24 (GMT) |
commit | 04bd873d77d64b3a2475e8fe63db51e03c13cb07 (patch) | |
tree | 0a86beec626b292d90ee0f2229c2b6ba4b000e6e /src | |
parent | 83c7f928f97b56a7a83f7f81b207cbe082136b1f (diff) | |
download | hdf5-04bd873d77d64b3a2475e8fe63db51e03c13cb07.zip hdf5-04bd873d77d64b3a2475e8fe63db51e03c13cb07.tar.gz hdf5-04bd873d77d64b3a2475e8fe63db51e03c13cb07.tar.bz2 |
1.14 Fix some doxygen warnings (#2323)
* Fix some doxygen warnings
* Remove javadocs
* Fix spelling
* Fix section format
* Correct doxygen function name
* Remove duplicate
Co-authored-by: Dana Robinson <43805+derobins@users.noreply.github.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/H5Amodule.h | 2 | ||||
-rw-r--r-- | src/H5Gmodule.h | 2 | ||||
-rw-r--r-- | src/H5Lpublic.h | 4 | ||||
-rw-r--r-- | src/H5Tpublic.h | 2 | ||||
-rw-r--r-- | src/H5VLconnector_passthru.h | 2 |
5 files changed, 6 insertions, 6 deletions
diff --git a/src/H5Amodule.h b/src/H5Amodule.h index 7f88a22..4823d0d 100644 --- a/src/H5Amodule.h +++ b/src/H5Amodule.h @@ -363,7 +363,7 @@ * will be ignored by HDF5. * * The use of ASCII or UTF-8 characters is determined by the character encoding property. See - * #H5Pset_char_encodingĀ in the \ref RM. + * #H5Pset_char_encoding in the \ref RM. * * <h4>No Special I/O or Storage</h4> * diff --git a/src/H5Gmodule.h b/src/H5Gmodule.h index 4b58ee6..d4738f6 100644 --- a/src/H5Gmodule.h +++ b/src/H5Gmodule.h @@ -923,7 +923,7 @@ * containing thousands to millions of members. Links are stored in * a fractal heap and indexed with an improved B-tree. * \li The new implementation also enables the use of link names consisting of - * non-ASCII character sets (see H5Pset_char_encoding()) and is + * non-ASCII character sets (see #H5Pset_char_encoding) and is * required for all link types other than hard or soft links, e.g., * external and user-defined links (see the \ref H5L APIs). * diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h index 60e83f2..d2d9e9d 100644 --- a/src/H5Lpublic.h +++ b/src/H5Lpublic.h @@ -729,7 +729,7 @@ H5_DLL herr_t H5Lexists_async(hid_t loc_id, const char *name, hbool_t *exists, h * \p cset specifies the character set in which the link name is * encoded. Valid values include the following: * \csets - * This value is set with H5Pset_char_encoding(). + * This value is set with #H5Pset_char_encoding. * * \c token is the location that a hard link points to, and * \c val_size is the size of a soft link or user defined link value. @@ -1525,7 +1525,7 @@ typedef herr_t (*H5L_iterate1_t)(hid_t group, const char *name, const H5L_info1_ * \c cset specifies the character set in which the link name is * encoded. Valid values include the following: * \csets - * This value is set with H5Pset_char_encoding(). + * This value is set with #H5Pset_char_encoding. * * \c address and \c val_size are returned for hard and symbolic * links, respectively. Symbolic links include soft and external links diff --git a/src/H5Tpublic.h b/src/H5Tpublic.h index dcaffd8..16172a8 100644 --- a/src/H5Tpublic.h +++ b/src/H5Tpublic.h @@ -1035,7 +1035,7 @@ H5_DLLVAR hid_t H5T_NATIVE_UINT_FAST64_g; * When creating a fixed-length string datatype, \p size will * be the length of the string in bytes. The length of the * string in characters will depend on i the encoding used; see - * H5Pset_char_encoding(). + * #H5Pset_char_encoding. * * ENUMs created with this function have a signed native integer * base datatype. Use H5Tenum_create() if a different integer base diff --git a/src/H5VLconnector_passthru.h b/src/H5VLconnector_passthru.h index 68dd33a..d10bac4 100644 --- a/src/H5VLconnector_passthru.h +++ b/src/H5VLconnector_passthru.h @@ -71,7 +71,7 @@ H5_DLL herr_t H5VLcmp_connector_cls(int *cmp, hid_t connector_id1, hid_t connect * - #H5I_MAP * - #H5I_ATTR * - * \return \hid_t + * \return \hid_t{VOL connector} * * \note This routine is mainly targeted toward wrapping objects for * iteration routine callbacks (i.e. the callbacks from H5Aiterate*, |