Fix documentation issues

Provide a description for the ClutterText section, and fix some
misnamed arguments inside the header file.
This commit is contained in:
Emmanuele Bassi 2008-12-11 15:00:22 +00:00
parent 0ac1590378
commit a50dfefbc3
2 changed files with 18 additions and 2 deletions

View File

@ -22,6 +22,22 @@
* License along with this library. If not, see <http://www.gnu.org/licenses/>. * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/ */
/**
* 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? /* TODO: undo/redo hooks?
*/ */

View File

@ -101,7 +101,7 @@ void clutter_text_set_ellipsize (ClutterText *self
PangoEllipsizeMode mode); PangoEllipsizeMode mode);
PangoEllipsizeMode clutter_text_get_ellipsize (ClutterText *self); PangoEllipsizeMode clutter_text_get_ellipsize (ClutterText *self);
void clutter_text_set_line_wrap (ClutterText *self, void clutter_text_set_line_wrap (ClutterText *self,
gboolean wrap); gboolean line_wrap);
gboolean clutter_text_get_line_wrap (ClutterText *self); gboolean clutter_text_get_line_wrap (ClutterText *self);
void clutter_text_set_line_wrap_mode (ClutterText *self, void clutter_text_set_line_wrap_mode (ClutterText *self,
PangoWrapMode wrap_mode); PangoWrapMode wrap_mode);
@ -123,7 +123,7 @@ gboolean clutter_text_get_justify (ClutterText *self
void clutter_text_insert_unichar (ClutterText *self, void clutter_text_insert_unichar (ClutterText *self,
gunichar wc); gunichar wc);
void clutter_text_delete_chars (ClutterText *self, void clutter_text_delete_chars (ClutterText *self,
guint len); guint n_chars);
void clutter_text_insert_text (ClutterText *self, void clutter_text_insert_text (ClutterText *self,
const gchar *text, const gchar *text,
gssize position); gssize position);