2
0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-12-15 07:40:23 +08:00

Adds Doxygen markup for H5FDdriver_query() ()

This commit is contained in:
Dana Robinson 2022-12-28 13:07:39 -08:00 committed by GitHub
parent d261272ffa
commit 3da2551adb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 4 deletions

View File

@ -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

View File

@ -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