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/H5FDmirror.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/H5FDmirror.h')
| -rw-r--r-- | src/H5FDmirror.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/src/H5FDmirror.h b/src/H5FDmirror.h index b196b2b..6c98e1a 100644 --- a/src/H5FDmirror.h +++ b/src/H5FDmirror.h @@ -11,7 +11,7 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* - * Purpose: Public, shared definitions for Mirror VFD & remote Writer. + * Purpose: The public header file for the mirror virtual file driver (VFD) */ #ifndef H5FDmirror_H @@ -19,7 +19,10 @@ #ifdef H5_HAVE_MIRROR_VFD -#define H5FD_MIRROR (H5FDperform_init(H5FD_mirror_init)) +/** Initializer for the mirror VFD */ +#define H5FD_MIRROR (H5FDperform_init(H5FD_mirror_init)) + +/** Identifier for the mirror VFD */ #define H5FD_MIRROR_VALUE H5_VFD_MIRROR #ifdef __cplusplus @@ -62,6 +65,10 @@ typedef struct H5FD_mirror_fapl_t { char remote_ip[H5FD_MIRROR_MAX_IP_LEN + 1]; } H5FD_mirror_fapl_t; +/** @private + * + * \brief Private initializer for the mirror VFD + */ H5_DLL hid_t H5FD_mirror_init(void); /** |