Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up Subfiling VFD header doxygen formatting #3601

Merged
merged 1 commit into from
Sep 26, 2023
Merged

Clean up Subfiling VFD header doxygen formatting #3601

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 26 additions & 16 deletions src/H5FDsubfiling/H5FDsubfiling.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
*
Expand Down