forked from enlightenment/efl
Eina: fix spelling in eina_tmpstr documentation
This commit is contained in:
parent
5e035d7a73
commit
cfe1817315
|
@ -167,7 +167,7 @@ EAPI Eina_Tmpstr *eina_tmpstr_add(const char *str) EINA_WARN_UNUSED_RESULT;
|
||||||
/**
|
/**
|
||||||
* @brief Add a new temporary string based on the input string and length.
|
* @brief Add a new temporary string based on the input string and length.
|
||||||
*
|
*
|
||||||
* @param str This is the input stringthat is copied into the temp string.
|
* @param str This is the input string that is copied into the temp string.
|
||||||
* @param length This is the maximum length and the allocated length of the temp string.
|
* @param length This is the maximum length and the allocated length of the temp string.
|
||||||
* @return A pointer to the tmp string that is a standard C string.
|
* @return A pointer to the tmp string that is a standard C string.
|
||||||
*
|
*
|
||||||
|
@ -182,11 +182,11 @@ EAPI Eina_Tmpstr *eina_tmpstr_add(const char *str) EINA_WARN_UNUSED_RESULT;
|
||||||
* NULL will be returned, otherwise a valid string pointer will be returned
|
* NULL will be returned, otherwise a valid string pointer will be returned
|
||||||
* that you can treat as any other C string (eg strdup(tmpstr) or
|
* that you can treat as any other C string (eg strdup(tmpstr) or
|
||||||
* printf("%s\n", tmpstr) etc.). This string should be considered read-only
|
* printf("%s\n", tmpstr) etc.). This string should be considered read-only
|
||||||
* and immutable, and when youa re done with the string yo should delete it
|
* and immutable, and when you are done with the string you should delete it
|
||||||
* with eina_tmpstr_del().
|
* with eina_tmpstr_del().
|
||||||
*
|
*
|
||||||
* @note If the length is greater than the actual string, but still '\0'
|
* @note If the length is greater than the actual string, but still '\0'
|
||||||
* terminateed. Their won't be any crash and the string will be correct,
|
* terminated, there won't be any crash and the string will be correct,
|
||||||
* but eina_tmpstr_len will return an erroneous length. So if you
|
* but eina_tmpstr_len will return an erroneous length. So if you
|
||||||
* want to have the correct length always call eina_tmpstr_add_length
|
* want to have the correct length always call eina_tmpstr_add_length
|
||||||
* with length == strlen(str).
|
* with length == strlen(str).
|
||||||
|
|
Loading…
Reference in New Issue