summaryrefslogtreecommitdiffstats
path: root/src/H5FDdirect.h
diff options
context:
space:
mode:
authorDana Robinson <43805+derobins@users.noreply.github.com>2023-10-30 16:13:54 (GMT)
committerGitHub <noreply@github.com>2023-10-30 16:13:54 (GMT)
commit58ef7dcdc9bfbfc65fe69d782914671f66322d85 (patch)
tree1944ce608aa8e78876cc59cd81a3eee8cbcff9dc /src/H5FDdirect.h
parent87636d685594e804c0bfb59933e3a56b2dabcd28 (diff)
downloadhdf5-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/H5FDdirect.h')
-rw-r--r--src/H5FDdirect.h33
1 files changed, 25 insertions, 8 deletions
diff --git a/src/H5FDdirect.h b/src/H5FDdirect.h
index e47ac37..1e60bb0 100644
--- a/src/H5FDdirect.h
+++ b/src/H5FDdirect.h
@@ -11,30 +11,47 @@
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
- * Purpose: The public header file for the direct driver.
+ * Purpose: The public header file for the direct virtual file driver (VFD)
*/
#ifndef H5FDdirect_H
#define H5FDdirect_H
#ifdef H5_HAVE_DIRECT
-#define H5FD_DIRECT (H5FDperform_init(H5FD_direct_init))
+
+/** Initializer for the direct VFD */
+#define H5FD_DIRECT (H5FDperform_init(H5FD_direct_init))
+
+/** Identifier for the direct VFD */
#define H5FD_DIRECT_VALUE H5_VFD_DIRECT
+
#else
+
+/** Initializer for the direct VFD (disabled) */
#define H5FD_DIRECT (H5I_INVALID_HID)
+
+/** Identifier for the direct VFD (disabled) */
#define H5FD_DIRECT_VALUE H5_VFD_INVALID
+
#endif /* H5_HAVE_DIRECT */
+/** Default value for memory boundary */
+#define MBOUNDARY_DEF 4096
+
+/** Default value for file block size */
+#define FBSIZE_DEF 4096
+
+/** Default value for maximum copy buffer size */
+#define CBSIZE_DEF (16 * 1024 * 1024)
+
#ifdef H5_HAVE_DIRECT
#ifdef __cplusplus
extern "C" {
#endif
-/* Default values for memory boundary, file block size, and maximal copy buffer size.
- * Application can set these values through the function H5Pset_fapl_direct. */
-#define MBOUNDARY_DEF 4096
-#define FBSIZE_DEF 4096
-#define CBSIZE_DEF 16 * 1024 * 1024
-
+/** @private
+ *
+ * \brief Private initializer for the direct VFD
+ */
H5_DLL hid_t H5FD_direct_init(void);
/**