summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDana Robinson <43805+derobins@users.noreply.github.com>2022-12-28 21:07:16 (GMT)
committerGitHub <noreply@github.com>2022-12-28 21:07:16 (GMT)
commit78ded4f1061d024d7306532a31d02233d4ffe668 (patch)
treed12404e6ab055be53fb930cb40796305fd895eda /src
parente985e8d7fa9c74c4e50c0f836fc2f70478792779 (diff)
downloadhdf5-78ded4f1061d024d7306532a31d02233d4ffe668.zip
hdf5-78ded4f1061d024d7306532a31d02233d4ffe668.tar.gz
hdf5-78ded4f1061d024d7306532a31d02233d4ffe668.tar.bz2
Adds Doxygen markup for H5FDdriver_query() (#2375)
Diffstat (limited to 'src')
-rw-r--r--src/H5FDpublic.h22
-rw-r--r--src/H5VLpublic.h5
2 files changed, 23 insertions, 4 deletions
diff --git a/src/H5FDpublic.h b/src/H5FDpublic.h
index 3b956de..422cd18 100644
--- a/src/H5FDpublic.h
+++ b/src/H5FDpublic.h
@@ -397,7 +397,27 @@ extern "C" {
#endif
/* Function prototypes */
-/* Allows querying a VFD ID for features before the file is opened */
+
+/**
+ * \ingroup H5FD
+ *
+ * \brief Allows querying a VFD ID for features before the file is opened
+ *
+ * \param[in] driver_id Virtual File Driver (VFD) ID
+ * \param[out] flags VFD flags supported
+ *
+ * \return \herr_t
+ *
+ * \details Queries a virtual file driver (VFD) for feature flags. Takes a
+ * VFD hid_t so it can be used before the file is opened. For example,
+ * this could be used to check if a VFD supports SWMR.
+ *
+ * \note The flags obtained here are just those of the base driver and
+ * do not take any configuration options (e.g., set via a fapl
+ * call) into consideration.
+ *
+ * \since 1.10.2
+ */
H5_DLL herr_t H5FDdriver_query(hid_t driver_id, unsigned long *flags /*out*/);
#ifdef __cplusplus
diff --git a/src/H5VLpublic.h b/src/H5VLpublic.h
index f32abda..c0a0e68 100644
--- a/src/H5VLpublic.h
+++ b/src/H5VLpublic.h
@@ -409,9 +409,8 @@ H5_DLL herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_t
* \brief Determines whether an object ID represents a native
* VOL connector object.
*
- * \param[in] obj_id Object identifier
- * \param[in] is_native Boolean determining whether object is a native
- * VOL connector object
+ * \obj_id
+ * \param[out] is_native Boolean determining whether object is a native VOL connector object
* \return \herr_t
*
* \since 1.14.0