forked from enlightenment/efl
super overclarify docs for eina_str_split_full
SVN revision: 71932
This commit is contained in:
parent
bc42fd3c1e
commit
1d855e8c14
|
@ -187,9 +187,11 @@ EAPI char **eina_str_split(const char *string, const char *delimiter, i
|
||||||
*
|
*
|
||||||
* @param string The string to split.
|
* @param string The string to split.
|
||||||
* @param delimiter The string which specifies the places at which to split the string.
|
* @param delimiter The string which specifies the places at which to split the string.
|
||||||
* @param max_tokens The maximum number of strings to split string into.
|
* @param max_tokens The maximum number of strings to split string into. This parameter
|
||||||
|
* IGNORES the added @c NULL terminator.
|
||||||
* @param elements Where to return the number of elements in returned
|
* @param elements Where to return the number of elements in returned
|
||||||
* array (not counting the terminating @c NULL). May be @c NULL.
|
* array. This array is guaranteed to be no greater than @p max_tokens, and
|
||||||
|
* it will NOT count the @c NULL terminator element.
|
||||||
* @return A newly-allocated NULL-terminated array of strings or @c NULL if it
|
* @return A newly-allocated NULL-terminated array of strings or @c NULL if it
|
||||||
* fails to allocate the array.
|
* fails to allocate the array.
|
||||||
*
|
*
|
||||||
|
@ -203,6 +205,11 @@ EAPI char **eina_str_split(const char *string, const char *delimiter, i
|
||||||
* allocate the array. To free it, free the first element of the array and the
|
* allocate the array. To free it, free the first element of the array and the
|
||||||
* array itself.
|
* array itself.
|
||||||
*
|
*
|
||||||
|
* @note The actual size of the returned array, when @p elements returns greater than zero,
|
||||||
|
* will always be @p elements + 1. This is due to the @c NULL terminator element that
|
||||||
|
* is added to the array for safety. If it returns @c 6, the number of split strings returned
|
||||||
|
* will be 6, but the size of the array (including the @c NULL element) will actually be 7.
|
||||||
|
*
|
||||||
* @see eina_str_split()
|
* @see eina_str_split()
|
||||||
*/
|
*/
|
||||||
EAPI char **eina_str_split_full(const char *string, const char *delimiter, int max_tokens, unsigned int *elements) EINA_ARG_NONNULL(1, 2, 4) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
|
EAPI char **eina_str_split_full(const char *string, const char *delimiter, int max_tokens, unsigned int *elements) EINA_ARG_NONNULL(1, 2, 4) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
|
||||||
|
|
Loading…
Reference in New Issue