Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Doxygen to API calls in H5VLnative.h #4173

Merged
merged 1 commit into from
Mar 18, 2024
Merged

Add Doxygen to API calls in H5VLnative.h #4173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion src/H5VLnative.h
View file
Open in desktop
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
Loading