kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Eina: fix spelling in eina_tmpstr documentation

This commit is contained in:
Vincent Torri 2015-10-14 09:12:32 +02:00 committed by Tom Hacohen
parent 5e035d7a73
commit cfe1817315
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib/eina/eina_tmpstr.h
View File

@ -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.
*
* @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.
* @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
* 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
* 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().
*
* @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
* want to have the correct length always call eina_tmpstr_add_length
* with length == strlen(str).