From a50dfefbc33a8c0b0c7189058f4f7f521707a8fc Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Thu, 11 Dec 2008 15:00:22 +0000 Subject: [PATCH] Fix documentation issues Provide a description for the ClutterText section, and fix some misnamed arguments inside the header file. --- clutter/clutter-text.c | 16 ++++++++++++++++ clutter/clutter-text.h | 4 ++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/clutter/clutter-text.c b/clutter/clutter-text.c index d746279aa..c0d51543e 100644 --- a/clutter/clutter-text.c +++ b/clutter/clutter-text.c @@ -22,6 +22,22 @@ * License along with this library. If not, see . */ +/** + * SECTION:clutter-text + * @short_description: An actor for displaying and editing text + * + * #ClutterText is an actor that displays custom text using Pango + * as the text rendering engine. + * + * #ClutterText also allows inline editing of the text if the + * actor is set editable using clutter_text_set_editable(). + * + * Selection using keyboard or pointers can be enabled using + * clutter_text_set_selectable(). + * + * #ClutterText is available since Clutter 1.0 + */ + /* TODO: undo/redo hooks? */ diff --git a/clutter/clutter-text.h b/clutter/clutter-text.h index 87f103486..56595b794 100644 --- a/clutter/clutter-text.h +++ b/clutter/clutter-text.h @@ -101,7 +101,7 @@ void clutter_text_set_ellipsize (ClutterText *self PangoEllipsizeMode mode); PangoEllipsizeMode clutter_text_get_ellipsize (ClutterText *self); void clutter_text_set_line_wrap (ClutterText *self, - gboolean wrap); + gboolean line_wrap); gboolean clutter_text_get_line_wrap (ClutterText *self); void clutter_text_set_line_wrap_mode (ClutterText *self, PangoWrapMode wrap_mode); @@ -123,7 +123,7 @@ gboolean clutter_text_get_justify (ClutterText *self void clutter_text_insert_unichar (ClutterText *self, gunichar wc); void clutter_text_delete_chars (ClutterText *self, - guint len); + guint n_chars); void clutter_text_insert_text (ClutterText *self, const gchar *text, gssize position);