ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

include/uuid.h: add comments for public APIs

Browse Source 
Change-Id: I96a0822fdf8fe9a83283ca71d391821855edb21f
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/406921
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Yanbo Zhou 2018-04-09 10:17:38 +08:00 committed by Daniel Verkamp
parent 2d192cf8fb
commit 2a3d7bf373
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/spdk/uuid.h
View File

@ -60,7 +60,8 @@ SPDK_STATIC_ASSERT(sizeof(struct spdk_uuid) == 16, "Incorrect size");
*
* \param uuid[output] User-provided UUID buffer.
* \param uuid_str UUID in textual format in C string.
* \return 0 on success, or negated errno on failure.
*
* \return 0 on success, or negative errno on failure.
*/
int spdk_uuid_parse(struct spdk_uuid *uuid, const char *uuid_str);
@ -68,15 +69,20 @@ int spdk_uuid_parse(struct spdk_uuid *uuid, const char *uuid_str);
* Convert UUID in spdk_uuid into lowercase textual format.
*
* \param uuid_str User-provided string buffer to write the textual format into.
* \param uuid_str_size Size of uuid_str buffer. Must be at least SPDK_UUID_STRING_LEN.
* \param uuid_str_size Size of uuid_str buffer. Must be at least SPDK_UUID_STRING_LEN.
* \param uuid UUID to convert to textual format.
*
* \return 0 on success, or negative errno on failure.
*/
int spdk_uuid_fmt_lower(char *uuid_str, size_t uuid_str_size, const struct spdk_uuid *uuid);
/**
* Compare two UUIDs.
*
* \return 0 if u1 == u2, less than 0 if u1 < u2, greater than 0 if u1 > u2
* \param u1 UUID 1.
* \param u2 UUID 2.
*
* \return 0 if u1 == u2, less than 0 if u1 < u2, greater than 0 if u1 > u2.
*/
int spdk_uuid_compare(const struct spdk_uuid *u1, const struct spdk_uuid *u2);