diff options
| author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2023-10-30 16:13:54 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-30 16:13:54 (GMT) |
| commit | 58ef7dcdc9bfbfc65fe69d782914671f66322d85 (patch) | |
| tree | 1944ce608aa8e78876cc59cd81a3eee8cbcff9dc /src/H5FDonion.h | |
| parent | 87636d685594e804c0bfb59933e3a56b2dabcd28 (diff) | |
| download | hdf5-58ef7dcdc9bfbfc65fe69d782914671f66322d85.zip hdf5-58ef7dcdc9bfbfc65fe69d782914671f66322d85.tar.gz hdf5-58ef7dcdc9bfbfc65fe69d782914671f66322d85.tar.bz2 | |
Update Doxygen initializers & identifiers in VFDs (#3795)
* Add Doxygen for all H5FD_<VFD> initializers
* Add Doxygen for all H5FD_<VFD>_VALUE values
* Mark H5FD_<vfd>_init() calls private in Doxygen
Diffstat (limited to 'src/H5FDonion.h')
| -rw-r--r-- | src/H5FDonion.h | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/src/H5FDonion.h b/src/H5FDonion.h index 09b290e..4aaab6d 100644 --- a/src/H5FDonion.h +++ b/src/H5FDonion.h @@ -11,19 +11,18 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* - * Onion Virtual File Driver (VFD) - * - * Purpose: The public header file for the Onion VFD. + * Purpose: The public header file for the onion virtual file driver (VFD) */ #ifndef H5FDonion_H #define H5FDonion_H -#define H5FD_ONION (H5FDperform_init(H5FD_onion_init)) +/** Initializer for the onion VFD */ +#define H5FD_ONION (H5FDperform_init(H5FD_onion_init)) + +/** Identifier for the onion VFD */ #define H5FD_ONION_VALUE H5_VFD_ONION -/** - * Current version of the onion VFD fapl info struct. - */ +/** Current version of the onion VFD fapl info struct */ #define H5FD_ONION_FAPL_INFO_VERSION_CURR 1 #define H5FD_ONION_FAPL_INFO_CREATE_FLAG_ENABLE_PAGE_ALIGNMENT \ @@ -114,6 +113,10 @@ typedef struct H5FD_onion_fapl_info_t { extern "C" { #endif +/** @private + * + * \brief Private initializer for the onion VFD + */ H5_DLL hid_t H5FD_onion_init(void); /** |