[glib] doc: small improvement and fixes
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] doc: small improvement and fixes
- Date: Fri, 4 Jul 2014 15:04:53 +0000 (UTC)
commit 97f34bacce1fa59c6b3ee05bdbc2ab96a8ad9a4e
Author: Sébastien Wilmet <swilmet gnome org>
Date: Thu Jul 3 19:53:51 2014 +0200
doc: small improvement and fixes
- Add an example to g_strsplit(), like it is done for g_strsplit_set().
- GTK-Doc generates a list if a "1." is at the beginning of a line.
https://bugzilla.gnome.org/show_bug.cgi?id=732704
glib/giochannel.c | 4 ++--
glib/gstrfuncs.c | 6 +++++-
2 files changed, 7 insertions(+), 3 deletions(-)
---
diff --git a/glib/giochannel.c b/glib/giochannel.c
index 1765233..19fc1d4 100644
--- a/glib/giochannel.c
+++ b/glib/giochannel.c
@@ -69,8 +69,8 @@
* events you are interested in on the #GIOChannel, and provide a
* function to be called whenever these events occur.
*
- * #GIOChannel instances are created with an initial reference count of
- * 1. g_io_channel_ref() and g_io_channel_unref() can be used to
+ * #GIOChannel instances are created with an initial reference count of 1.
+ * g_io_channel_ref() and g_io_channel_unref() can be used to
* increment or decrement the reference count respectively. When the
* reference count falls to 0, the #GIOChannel is freed. (Though it
* isn't closed automatically, unless it was created using
diff --git a/glib/gstrfuncs.c b/glib/gstrfuncs.c
index 7daee73..f33f84b 100644
--- a/glib/gstrfuncs.c
+++ b/glib/gstrfuncs.c
@@ -2246,6 +2246,10 @@ g_strchomp (gchar *string)
* @delimiter. If @max_tokens is reached, the remainder of @string is
* appended to the last token.
*
+ * As an example, the result of g_strsplit (":a:bc::d:", ":", -1) is a
+ * %NULL-terminated vector containing the six strings "", "a", "bc", "", "d"
+ * and "".
+ *
* As a special case, the result of splitting the empty string "" is an empty
* vector, not a vector containing a single string. The reason for this
* special case is that being able to represent a empty vector is typically
@@ -2325,7 +2329,7 @@ g_strsplit (const gchar *string,
* %NULL-terminated vector containing the three strings "abc", "def",
* and "ghi".
*
- * The result if g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated
+ * The result of g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated
* vector containing the four strings "", "def", "ghi", and "".
*
* As a special case, the result of splitting the empty string "" is an empty
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]