Improve docs of strvec
This commit is contained in:
@@ -38,7 +38,7 @@ void uc_strv_init(struct UCStrv *strv);
|
|||||||
int uc_strv_grow(struct UCStrv *strv, size_t cnt);
|
int uc_strv_grow(struct UCStrv *strv, size_t cnt);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Expand the UCStrv to hold attleast 1 more item if needed
|
* If needed, grow the UCStrv to hold atleast 1 more item.
|
||||||
*
|
*
|
||||||
* @param strv UCStrv to expand
|
* @param strv UCStrv to expand
|
||||||
* @return 0 on success, otherwise failure
|
* @return 0 on success, otherwise failure
|
||||||
@@ -46,7 +46,7 @@ int uc_strv_grow(struct UCStrv *strv, size_t cnt);
|
|||||||
int uc_strv_check_expand(struct UCStrv *strv);
|
int uc_strv_check_expand(struct UCStrv *strv);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Append a string to the UCStrv, the string will be copied in
|
* Append a string to the UCStrv, the string will be copied in.
|
||||||
*
|
*
|
||||||
* @param strv UCStrv to append to
|
* @param strv UCStrv to append to
|
||||||
* @param str String to append, the string will be copied.
|
* @param str String to append, the string will be copied.
|
||||||
@@ -55,7 +55,7 @@ int uc_strv_check_expand(struct UCStrv *strv);
|
|||||||
int uc_strv_append(struct UCStrv *strv, const char *restrict str);
|
int uc_strv_append(struct UCStrv *strv, const char *restrict str);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Append a string to the strvec, nocopy variang.
|
* Append a string to the strvec without making a copy of the string.
|
||||||
* The string shold be dynamically allocated, as
|
* The string shold be dynamically allocated, as
|
||||||
* destroying the UCStrv will free() all items.
|
* destroying the UCStrv will free() all items.
|
||||||
*
|
*
|
||||||
@@ -67,7 +67,7 @@ int uc_strv_append_nocopy(struct UCStrv *strv, char *restrict str);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Append a NULL pointer to the UCStrv, (cnt is not increased,
|
* Append a NULL pointer to the UCStrv, (cnt is not increased,
|
||||||
* so another _appended item will overwrite this NULL terminator)
|
* so another appended item will overwrite this NULL terminator)
|
||||||
*
|
*
|
||||||
* @param strv UCStrv to append to
|
* @param strv UCStrv to append to
|
||||||
* @return 0 on success, otherwise failure
|
* @return 0 on success, otherwise failure
|
||||||
|
|||||||
Reference in New Issue
Block a user