[glib] Clarify g_strchomp and g_strchug docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Clarify g_strchomp and g_strchug docs
- Date: Mon, 20 Jan 2014 05:35:09 +0000 (UTC)
commit 2efc2ef77526fb902f1d603875eaca833b47f0b5
Author: Matthias Clasen <mclasen redhat com>
Date: Mon Jan 20 00:34:29 2014 -0500
Clarify g_strchomp and g_strchug docs
https://bugzilla.gnome.org/show_bug.cgi?id=583036
glib/gstrfuncs.c | 14 +++++++++-----
1 files changed, 9 insertions(+), 5 deletions(-)
---
diff --git a/glib/gstrfuncs.c b/glib/gstrfuncs.c
index a0b9dff..76ed3a9 100644
--- a/glib/gstrfuncs.c
+++ b/glib/gstrfuncs.c
@@ -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)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]