mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-02-05 15:42:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add Doxygen to API calls in H5VLnative.h (#4173)

Browse Source
This commit is contained in:
Dana Robinson 2024-03-18 06:06:07 -07:00 committed by GitHub
parent eb0351efff
commit 51fab96f4e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/H5VLnative.h
View File

@ -515,16 +515,46 @@ extern "C" {
#endif
/* Token <--> address converters */
/**
* \ingroup H5VLNAT
*
* \brief Convert a haddr_t address to a native VOL connector token
*
* \fgdta_loc_obj_id{loc_id}
* \param[in] addr Object address
* \param[out] token Object token
*
* \return \herr_t
*
* \details This API call maps pre-VOL haddr_t native file format addresses
* to the more generic H5O_token_t tokens used by the VOL.
*
* \since 1.12.0
*/
H5_DLL herr_t H5VLnative_addr_to_token(hid_t loc_id, haddr_t addr, H5O_token_t *token);
/**
* \ingroup H5VLNAT
*
* \brief Convert a native VOL connector token to a haddr_t address
*
* \fgdta_loc_obj_id{loc_id}
* \param[in] token Object token
* \param[out] addr Object address
*
* \return \herr_t
*
* \details This API call maps generic H5O_token_t tokens used by the VOL to
* pre-VOL haddr_t native file format addresses.
*
* \since 1.12.0
*/
H5_DLL herr_t H5VLnative_token_to_addr(hid_t loc_id, H5O_token_t token, haddr_t *addr);
/* Not really public but must be included here */
/** @private
*
* \brief Register the native VOL connector and retrieve an ID for it
*/
H5_DLL hid_t H5VL_native_register(void);
#ifdef __cplusplus