mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-12-09 07:32:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove superfluous dot from hl doxygen. (#1891)

Browse Source 
Co-authored-by: vchoi <vchoi@jelly.ad.hdfgroup.org>
This commit is contained in:
vchoi-hdfgroup 2022-07-14 11:32:09 -05:00 committed by GitHub
parent 385ae6ac5b
commit c835d16a59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doxygen/dox/high_level/extension.dox
View File

@ -57,7 +57,7 @@
* to the application provided buffer.
* - \ref H5LTread_region
* \n Reads selected data to an application buffer.
* .
*
*/
/*-------------------------------------------------------------------------
@ -311,7 +311,6 @@ H5_HLRDLL herr_t H5LRcopy_region(hid_t obj_id,
* Valid values include the following:
* - #H5_INDEX_NAME Alphanumeric index on name
* - #H5_INDEX_CRT_ORDER Index on creation order
* .
*
* \p order specifies the order in which objects are to be
* inspected along the index specified in \p index_type.
@ -319,7 +318,6 @@ H5_HLRDLL herr_t H5LRcopy_region(hid_t obj_id,
* - #H5_ITER_INC Increasing order
* - #H5_ITER_DEC Decreasing order
* - #H5_ITER_NATIVE Fastest available order
* .
*
* For more detailed information on these two parameters,
* see H5Lvisit().
@ -328,7 +326,6 @@ H5_HLRDLL herr_t H5LRcopy_region(hid_t obj_id,
* Valid values include the following:
* - #H5R_DATASET_REGION Dataset region reference
* - #H5R_OBJECT Object reference
* .
*
* \version 1.1 Fortran wrapper introduced in this release.
*

1
hl/src/H5DOpublic.h
View File

@ -37,7 +37,6 @@ extern "C" {
* \n Reads a raw data chunk directly from a dataset in a file into a buffer (DEPRECATED)
* - \ref H5DOwrite_chunk
* \n Writes a raw data chunk from a buffer directly to a dataset in a file (DEPRECATED)
* .
*
*/

9
hl/src/H5DSpublic.h
View File

@ -72,7 +72,6 @@ extern "C" {
* - \ref H5DSset_scale
* \n Convert dataset dsid to a dimension scale,
* with optional name, dimname.
* .
*
*/
@ -153,7 +152,6 @@ H5_HLDLL herr_t H5DSattach_scale(hid_t did, hid_t dsid, unsigned int idx);
* - The dataset \p did or \p dsid do not exist
* - The \p dsid is not a Dimension Scale
* - \p dsid is not attached to \p did
* .
*
* \note A scale may be associated with more than dimension of the
* same dataset. If so, the detach operation only deletes one
@ -190,7 +188,6 @@ H5_HLDLL herr_t H5DSdetach_scale(hid_t did, hid_t dsid, unsigned int idx);
* - Bad arguments
* - If \p dsid is already a scale
* - If \p dsid is a dataset which already has dimension scales
* .
*
* If the dataset was created with the Table, Image, or Palette interface [9],
* it is not recommended to convert to a Dimension Scale.
@ -240,7 +237,7 @@ H5_HLDLL int H5DSget_num_scales(hid_t did, unsigned int idx);
*
* Fails if:
* - Bad arguments
* .
*
*/
H5_HLDLL herr_t H5DSset_label(hid_t did, unsigned int idx, const char *label);
@ -270,7 +267,7 @@ H5_HLDLL herr_t H5DSset_label(hid_t did, unsigned int idx, const char *label);
*
* Fails if:
* - Bad arguments
* .
*
*/
H5_HLDLL ssize_t H5DSget_label(hid_t did, unsigned int idx, char *label, size_t size);
@ -372,7 +369,6 @@ H5_HLDLL htri_t H5DSis_scale(hid_t did);
* - Negative causes the iterator to immediately return
* that value, indicating failure. The iterator can be
* restarted at the next group member.
* .
*
* H5DSiterate_scales() assumes that the scales of the
* dimension identified by \p dim remain unchanged through
@ -403,7 +399,6 @@ H5_HLDLL herr_t H5DSiterate_scales(hid_t did, unsigned int dim, int *idx, H5DS_i
* - If \p dsid is not a Dimension Scale
* - The \p dsid is not a Dimension Scale
* - If \p did is a Dimension Scale (A Dimension Scale cannot have scales.)
* .
*
*/
H5_HLDLL htri_t H5DSis_attached(hid_t did, hid_t dsid, unsigned int idx);

1
hl/src/H5IMpublic.h
View File

@ -64,7 +64,6 @@ extern "C" {
* \n Reads image data from disk.
* - \ref H5IMunlink_palette
* \n Dettaches a palette from an image.
* .
*
*/

5
hl/src/H5LTpublic.h
View File

@ -1511,7 +1511,6 @@ H5_HLDLL herr_t H5LTfind_attribute(hid_t loc_id, const char *name);
* - A relative path with respect to \p loc_id
* - A dot (\c .), if \p loc_id is the object identifier for
* 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
@ -1591,14 +1590,14 @@ H5_HLDLL htri_t H5LTpath_valid(hid_t loc_id, const char *path, hbool_t check_obj
* - #H5LT_FILE_IMAGE_OPEN_RW
* - Specifies opening the file image in read/write mode.
* - Default without this flag: File image will be opened read-only.
* .
*
* - #H5LT_FILE_IMAGE_DONT_COPY
* - Specifies to not copy the provided file image buffer;
* the buffer will be used directly. HDF5 will release the
* file image when finished.
* - Default without this flag: Copy the file image buffer and
* open the copied file image.
* .
*
* - #H5LT_FILE_IMAGE_DONT_RELEASE
* - Specifies that HDF5 is not to release the buffer when
* the file opened with H5LTopen_file_image() is closed;

1
hl/src/H5PTpublic.h
View File

@ -83,7 +83,6 @@ extern "C" {
* \n Reads a number of packets from a packet table.
* - \ref H5PTset_index
* \n Sets a packet table's index.
* .
*
*/

8
hl/src/H5TBpublic.h
View File

@ -42,6 +42,9 @@ extern "C" {
* any HDF5 calls to initialize global variables and \ref H5close
* after all HDF5 calls to close the Fortran interface.
*
* <table>
* <tr valign="top"><td style="border: none;">
*
* - Creation
* - \ref H5TBmake_table
* - Storage
@ -58,6 +61,8 @@ extern "C" {
* - \ref H5TBinsert_field
* - \ref H5TBdelete_field
*
* </td><td style="border: none;">
*
* - Retrieval
* - \ref H5TBread_table
* - \ref H5TBread_records (No Fortran)
@ -72,6 +77,9 @@ extern "C" {
* - \ref H5TBAget_fill
* - \ref H5TBAget_title
*
* </td></tr>
* </table>
*
*/
/*-------------------------------------------------------------------------