diff options
| author | jhendersonHDF <jhenderson@hdfgroup.org> | 2023-09-26 20:47:13 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-26 20:47:13 (GMT) |
| commit | 8e964d4622d655514d5494e9e45ebd06031099c8 (patch) | |
| tree | 7fcc1b222e6ef8782c16c126e4b1b89e20b43d9c /src/H5FDsubfiling | |
| parent | 1529ec0ab3a348e17aab0e0ec97bb80adc4decc2 (diff) | |
| download | hdf5-8e964d4622d655514d5494e9e45ebd06031099c8.zip hdf5-8e964d4622d655514d5494e9e45ebd06031099c8.tar.gz hdf5-8e964d4622d655514d5494e9e45ebd06031099c8.tar.bz2 | |
Clean up Subfiling VFD header doxygen formatting (#3601)
Diffstat (limited to 'src/H5FDsubfiling')
| -rw-r--r-- | src/H5FDsubfiling/H5FDsubfiling.h | 42 |
1 files changed, 26 insertions, 16 deletions
diff --git a/src/H5FDsubfiling/H5FDsubfiling.h b/src/H5FDsubfiling/H5FDsubfiling.h index 5a520ce..d6d2ffd 100644 --- a/src/H5FDsubfiling/H5FDsubfiling.h +++ b/src/H5FDsubfiling/H5FDsubfiling.h @@ -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: + * + * \par \%s + * base filename, e.g. "file.h5" * - * %s -> base filename, e.g. "file.h5" - * %PRIu64 -> file inode, e.g. 11273556 + * \par \%PRIu64 + * file inode, e.g. 11273556 * * yielding a filename such as: * |