[gtk+] Small API doc fixes
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Small API doc fixes
- Date: Sat, 16 Mar 2013 21:24:07 +0000 (UTC)
commit 66dfab0b0ac64aa0b7c390cbd990137df2a8cabe
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sat Mar 16 15:12:35 2013 +0100
Small API doc fixes
For gtk_text_iter_get_char(), due to the "Returns" at the beginning of
the description, the description was not visible. So the first sentence
has been reworded.
gtk/gtktextbuffer.c | 2 +-
gtk/gtktextiter.c | 8 ++++----
2 files changed, 5 insertions(+), 5 deletions(-)
---
diff --git a/gtk/gtktextbuffer.c b/gtk/gtktextbuffer.c
index a877e34..bebeb56 100644
--- a/gtk/gtktextbuffer.c
+++ b/gtk/gtktextbuffer.c
@@ -389,7 +389,7 @@ gtk_text_buffer_class_init (GtkTextBufferClass *klass)
* Note that if your handler runs before the default handler it must not
* invalidate the @start and @end iters (or has to revalidate them).
* The default signal handler revalidates the @start and @end iters to
- * both point point to the location where text was deleted. Handlers
+ * both point to the location where text was deleted. Handlers
* which run after the default handler (see g_signal_connect_after())
* do not have access to the deleted text.
*
diff --git a/gtk/gtktextiter.c b/gtk/gtktextiter.c
index 2b41c34..8a24ae8 100644
--- a/gtk/gtktextiter.c
+++ b/gtk/gtktextiter.c
@@ -844,16 +844,16 @@ gtk_text_iter_get_visible_line_index (const GtkTextIter *iter)
* gtk_text_iter_get_char:
* @iter: an iterator
*
- * Returns the Unicode character at this iterator. (Equivalent to
+ * The Unicode character at this iterator is returned. (Equivalent to
* operator* on a C++ iterator.) If the element at this iterator is a
* non-character element, such as an image embedded in the buffer, the
* Unicode "unknown" character 0xFFFC is returned. If invoked on
* the end iterator, zero is returned; zero is not a valid Unicode character.
- * So you can write a loop which ends when gtk_text_iter_get_char ()
+ * So you can write a loop which ends when gtk_text_iter_get_char()
* returns 0.
*
- * Return value: a Unicode character, or 0 if @iter is not dereferenceable
- **/
+ * Returns: a Unicode character, or 0 if @iter is not dereferenceable
+ */
gunichar
gtk_text_iter_get_char (const GtkTextIter *iter)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]