Clarify g_strchomp and g_strchug docs

https://bugzilla.gnome.org/show_bug.cgi?id=583036
This commit is contained in:
Matthias Clasen 2014-01-20 00:34:29 -05:00
parent deb8a9325b
commit 2efc2ef775

View File

@ -2192,8 +2192,10 @@ g_strescape (const gchar *source,
* of the characters forward.
*
* This function doesn't allocate or reallocate any memory;
* it modifies @string in place. The pointer to @string is
* returned to allow the nesting of functions.
* it modifies @string in place. Therefore, it cannot be used on
* statically allocated strings.
*
* The pointer to @string is returned to allow the nesting of functions.
*
* Also see g_strchomp() and g_strstrip().
*
@ -2221,12 +2223,14 @@ g_strchug (gchar *string)
* Removes trailing whitespace from a string.
*
* This function doesn't allocate or reallocate any memory;
* it modifies @string in place. The pointer to @string is
* returned to allow the nesting of functions.
* it modifies @string in place. Therefore, it cannot be used
* on statically allocated strings.
*
* The pointer to @string is returned to allow the nesting of functions.
*
* Also see g_strchug() and g_strstrip().
*
* Returns: @string.
* Returns: @string
*/
gchar *
g_strchomp (gchar *string)