Skip to content

Commit

Permalink
Add Doxygen to API calls in H5VLnative.h (HDFGroup#4173)
Browse files Browse the repository at this point in the history
  • Loading branch information
derobins authored and brtnfld committed Mar 18, 2024
1 parent 7fa730d commit 159027c
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion src/H5VLnative.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 159027c

Please sign in to comment.