From 9b780c271665bd85d00814a076fa63cac927f592 Mon Sep 17 00:00:00 2001 From: Chris Lord Date: Fri, 15 Feb 2008 17:11:50 +0000 Subject: [PATCH] * clutter/clutter-entry.c: * clutter/clutter-group.c: * clutter/clutter-label.c: * clutter/clutter-rectangle.c: * clutter/clutter-texture.c: More documentation fixes --- ChangeLog | 9 +++++++++ clutter/clutter-entry.c | 2 +- clutter/clutter-group.c | 10 +++++----- clutter/clutter-label.c | 2 +- clutter/clutter-rectangle.c | 4 ++-- clutter/clutter-texture.c | 2 +- 6 files changed, 19 insertions(+), 10 deletions(-) diff --git a/ChangeLog b/ChangeLog index c4b79762e..51f946bcd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2008-02-15 Chris Lord + + * clutter/clutter-entry.c: + * clutter/clutter-group.c: + * clutter/clutter-label.c: + * clutter/clutter-rectangle.c: + * clutter/clutter-texture.c: + More documentation fixes + 2008-02-15 Chris Lord * clutter/clutter-entry.c: (clutter_entry_class_init): diff --git a/clutter/clutter-entry.c b/clutter/clutter-entry.c index fbd4b9e5e..a9671265f 100644 --- a/clutter/clutter-entry.c +++ b/clutter/clutter-entry.c @@ -848,7 +848,7 @@ clutter_entry_new_with_text (const gchar *font_name, * @text: the text to be displayed * @color: #ClutterColor for text * - * Creates a new #ClutterEntry displaying @text with color @color + * Creates a new #ClutterEntry displaying @text with @color * using @font_name. * * Return value: the newly created #ClutterEntry diff --git a/clutter/clutter-group.c b/clutter/clutter-group.c index 3bfe2bbdb..610e39adb 100644 --- a/clutter/clutter-group.c +++ b/clutter/clutter-group.c @@ -30,7 +30,7 @@ * * A #ClutterGroup is an Actor which contains multiple child actors positioned * relative to the #ClutterGroup position. Other operations such as scaling, - * rotating and clipping of the group will child actors. + * rotating and clipping of the group will apply to the child actors. * * A #ClutterGroup's size is defined by the size and position of it * it children. Resize requests via parent #ClutterActor API will be @@ -545,7 +545,7 @@ clutter_group_add_many_valist (ClutterGroup *group, * @first_actor: the #ClutterActor actor to add to the group * @Varargs: additional actors to add to the group * - * Adds a NULL-terminated list of actors to a group. This function is + * Adds a %NULL-terminated list of actors to a group. This function is * equivalent to calling clutter_group_add() for each member of the list. * * @Deprecated: 0.4: This function is obsolete, use clutter_container_add() @@ -665,7 +665,7 @@ clutter_group_get_nth_child (ClutterGroup *self, * @actor: a #ClutterActor * @sibling: a #ClutterActor * - * FIXME + * Raises @actor to @sibling level in the depth ordering. * * Deprecated: 0.6: Use clutter_container_raise_child() instead. */ @@ -690,7 +690,7 @@ clutter_group_raise (ClutterGroup *self, * @actor: a #ClutterActor * @sibling: a #ClutterActor * - * FIXME + * Lowers @actor to @sibling level in the depth ordering. * * Deprecated: 0.6: Use clutter_container_lower_child() instead */ @@ -713,7 +713,7 @@ clutter_group_lower (ClutterGroup *self, * clutter_group_sort_depth_order: * @self: A #ClutterGroup * - * Sorts a #ClutterGroup's children by there depth value. + * Sorts a #ClutterGroup's children by their depth value. * This function should not be used by applications. * * Deprecated: 0.6: Use clutter_container_sort_depth_order() instead. diff --git a/clutter/clutter-label.c b/clutter/clutter-label.c index 529eb4ab0..11de65aed 100644 --- a/clutter/clutter-label.c +++ b/clutter/clutter-label.c @@ -697,7 +697,7 @@ clutter_label_new_with_text (const gchar *font_name, * @text: the text to be displayed * @color: #ClutterColor for text * - * Creates a new #ClutterLabel displaying @text with color @color + * Creates a new #ClutterLabel displaying @text with @color * using @font_name. * * Return value: a #ClutterLabel diff --git a/clutter/clutter-rectangle.c b/clutter/clutter-rectangle.c index 866675a69..950dc1700 100644 --- a/clutter/clutter-rectangle.c +++ b/clutter/clutter-rectangle.c @@ -25,9 +25,9 @@ /** * SECTION:clutter-rectangle - * @short_description: An actor that displays simple rectangles. + * @short_description: An actor that displays a simple rectangle. * - * #ClutterRectangle is a #ClutterActor which draws simple filled rectangles. + * #ClutterRectangle is a #ClutterActor which draws a simple filled rectangle. */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/clutter/clutter-texture.c b/clutter/clutter-texture.c index 5511a00c6..f1c35d09e 100644 --- a/clutter/clutter-texture.c +++ b/clutter/clutter-texture.c @@ -1448,7 +1448,7 @@ texture_prepare_upload (gboolean initialize, /** * clutter_texture_set_from_rgb_data: * @texture: A #ClutterTexture - * @data: Image data in RGB type colorspace. + * @data: Image data in RGBA type colorspace. * @has_alpha: Set to TRUE if image data has an alpha channel. * @width: Width in pixels of image data. * @height: Height in pixels of image data