mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-01-24 15:25:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clean up Subfiling VFD header doxygen formatting (#3601)

Browse Source
This commit is contained in:
jhendersonHDF 2023-09-26 15:47:13 -05:00 committed by GitHub
parent 1529ec0ab3
commit 8e964d4622
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
src/H5FDsubfiling/H5FDsubfiling.h
View File

@ -61,32 +61,42 @@
/**
* \def H5FD_SUBFILING_FILENAME_TEMPLATE
* The basic template for a subfile filename. The format specifiers
* correspond to:
* The basic printf-style template for a #H5FD_SUBFILING driver
* subfile filename. The format specifiers correspond to:
*
* %s -> base filename, e.g. "file.h5"
* %PRIu64 -> file inode, e.g. 11273556
* %0*d -> number (starting at 1) signifying the Nth (out of total
* number of subfiles) subfile. Zero-padded according
* to the number of digits in the number of subfiles
* (calculated by log10(num_subfiles) + 1)
* %d -> number of subfiles
* \par \%s
* base filename, e.g. "file.h5"
*
* \par \%PRIu64
* file inode, e.g. 11273556
*
* \par \%0*d
* number (starting at 1) signifying the Nth (out of
* total number of subfiles) subfile. Zero-padded
* according to the number of digits in the number of
* subfiles (calculated by <tt>log10(num_subfiles) + 1)</tt>
*
* \par \%d
* number of subfiles
*
* yielding filenames such as:
*
* file.h5.subfile_11273556_01_of_10
* file.h5.subfile_11273556_02_of_10
* file.h5.subfile_11273556_10_of_10
* file.h5.subfile_11273556_01_of_10 \n
* file.h5.subfile_11273556_02_of_10 \n
* file.h5.subfile_11273556_10_of_10 \n
*/
#define H5FD_SUBFILING_FILENAME_TEMPLATE "%s.subfile_%" PRIu64 "_%0*d_of_%d"
/**
* \def H5FD_SUBFILING_CONFIG_FILENAME_TEMPLATE
* The basic template for a #H5FD_SUBFILING driver configuration filename.
* The format specifiers correspond to:
* The basic printf-style template for a #H5FD_SUBFILING driver
* configuration filename. The format specifiers correspond to:
*
* %s -> base filename, e.g. "file.h5"
* %PRIu64 -> file inode, e.g. 11273556
* \par \%s
* base filename, e.g. "file.h5"
*
* \par \%PRIu64
* file inode, e.g. 11273556
*
* yielding a filename such as:
*