* clutter/clutter-entry.c:

* clutter/clutter-group.c:
        * clutter/clutter-label.c:
        * clutter/clutter-rectangle.c:
        * clutter/clutter-texture.c:
        More documentation fixes
This commit is contained in:
Chris Lord 2008-02-15 17:11:50 +00:00
parent ecd62417d2
commit 9b780c2716
6 changed files with 19 additions and 10 deletions

View File

@ -1,3 +1,12 @@
2008-02-15 Chris Lord <chris@openedhand.com>
* 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 <chris@openedhand.com>
* clutter/clutter-entry.c: (clutter_entry_class_init):

View File

@ -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

View File

@ -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.

View File

@ -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

View File

@ -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"

View File

@ -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