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/H5FDsec2.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/H5FDsec2.h')
| -rw-r--r-- | src/H5FDsec2.h | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/src/H5FDsec2.h b/src/H5FDsec2.h index a2590ae..dd0a4d8 100644 --- a/src/H5FDsec2.h +++ b/src/H5FDsec2.h @@ -11,18 +11,26 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* - * Purpose: The public header file for the sec2 driver + * Purpose: The public header file for the POSOX I/O (sec2 - "POSIX section 2") + * virtual file driver (VFD) */ #ifndef H5FDsec2_H #define H5FDsec2_H -#define H5FD_SEC2 (H5FDperform_init(H5FD_sec2_init)) +/** Initializer for the sec2 VFD */ +#define H5FD_SEC2 (H5FDperform_init(H5FD_sec2_init)) + +/** Identifier for the sec2 VFD */ #define H5FD_SEC2_VALUE H5_VFD_SEC2 #ifdef __cplusplus extern "C" { #endif +/** @private + * + * \brief Private initializer for the sec2 VFD + */ H5_DLL hid_t H5FD_sec2_init(void); /** @@ -38,7 +46,6 @@ H5_DLL hid_t H5FD_sec2_init(void); * #H5FD_SEC2 driver. * * \since 1.4.0 - * */ H5_DLL herr_t H5Pset_fapl_sec2(hid_t fapl_id); |