From 8ff6cec829179c68b664848c7dedd020aaceabc3 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Thu, 12 Jun 2008 11:43:25 +0000 Subject: [PATCH] 2008-06-12 Emmanuele Bassi * clutter/clutter-actor.[ch]: Documentation fixes. * clutter/clutter-backend.c: Documentation fixes. * clutter/clutter-container.h: Documentation fixes. * clutter/clutter-fixed.c (clutter_qdivx): Fix the return value to be after the description. * clutter/clutter-texture.[ch]: Documentation fixes. * clutter/clutter-timeline.c: Documentation fixes. --- ChangeLog | 15 ++++++ clutter/clutter-actor.c | 6 +-- clutter/clutter-actor.h | 26 +++++----- clutter/clutter-backend.c | 24 ++++++++++ clutter/clutter-container.h | 7 +-- clutter/clutter-fixed.c | 9 ++-- clutter/clutter-texture.c | 19 ++++---- clutter/clutter-texture.h | 94 ++++++++++++++++++------------------- clutter/clutter-timeline.c | 2 +- 9 files changed, 120 insertions(+), 82 deletions(-) diff --git a/ChangeLog b/ChangeLog index 5e332086c..02d21d4be 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,18 @@ +2008-06-12 Emmanuele Bassi + + * clutter/clutter-actor.[ch]: Documentation fixes. + + * clutter/clutter-backend.c: Documentation fixes. + + * clutter/clutter-container.h: Documentation fixes. + + * clutter/clutter-fixed.c (clutter_qdivx): Fix the return + value to be after the description. + + * clutter/clutter-texture.[ch]: Documentation fixes. + + * clutter/clutter-timeline.c: Documentation fixes. + 2008-06-11 Emmanuele Bassi * tests/test-layout.c: Take into account the origin of the diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c index 4bc247270..189749ec9 100644 --- a/clutter/clutter-actor.c +++ b/clutter/clutter-actor.c @@ -3085,8 +3085,8 @@ clutter_actor_get_preferred_size (ClutterActor *self, * @self: A #ClutterActor * @for_height: available height when computing the preferred width, * or a negative value to indicate that no height is defined - * @min_width_p: return location for min width, or %NULL - * @natural_width_p: return location for min width, or %NULL + * @min_width_p: return location for minimum width, or %NULL + * @natural_width_p: return location for the natural width, or %NULL * * Computes the requested minimum and natural widths for an actor, * optionally depending on the specified height, or if they are @@ -3156,7 +3156,7 @@ clutter_actor_get_preferred_width (ClutterActor *self, * @self: A #ClutterActor * @for_width: available width to assume in computing desired height, * or a negative value to indicate that no width is defined - * @min_height_p: return location for min height, or %NULL + * @min_height_p: return location for minimum height, or %NULL * @natural_height_p: return location for natural height, or %NULL * * Computes the requested minimum and natural heights for an actor, diff --git a/clutter/clutter-actor.h b/clutter/clutter-actor.h index 5f6e93200..88b077890 100644 --- a/clutter/clutter-actor.h +++ b/clutter/clutter-actor.h @@ -174,23 +174,23 @@ struct _ClutterActor * @unrealize: virtual function, used to deallocate resources allocated * in ::realize; it should chain up to the parent's implementation * @paint: virtual function, used to paint the actor - * @get_preferred_width: virtual function, used when querying the minimum and - * natural widths of an actor - * @get_preferred_height: virtual function, used when querying the minimum and - * natural heights of an actor + * @get_preferred_width: virtual function, used when querying the minimum + * and natural widths of an actor for a given height; it is used by + * clutter_actor_get_preferred_width() + * @get_preferred_height: virtual function, used when querying the minimum + * and natural heights of an actor for a given width; it is used by + * clutter_actor_get_preferred_height() * @allocate: virtual function, used when settings the coordinates of an - * actor + * actor; it is used by clutter_actor_allocate() * @get_paint_area: virtual function, used when querying the untrasformed - * bounding box of an actor; it's used internally by - * clutter_actor_get_stage_area() - * @parent_set: signal class closure for the #ClutterActor::parent-set - * @destroy: signal class closure for #ClutterActor::destroy + * bounding box of an actor; it's used by clutter_actor_get_paint_area() + * @parent_set: signal class handler for the #ClutterActor::parent-set + * @destroy: signal class handler for #ClutterActor::destroy * @pick: virtual function, used to draw an outline of the actor with * the given color - * @event: signal class closure for #ClutterActor::event - * @button_press_event: signal class closure for - * #ClutterActor::button-press-event - * @button_release_event: signal class closure for + * @event: class handler for #ClutterActor::event + * @button_press_event: class handler for #ClutterActor::button-press-event + * @button_release_event: class handler for * #ClutterActor::button-release-event * @scroll_event: signal class closure for #ClutterActor::scroll-event * @key_press_event: signal class closure for #ClutterActor::key-press-event diff --git a/clutter/clutter-backend.c b/clutter/clutter-backend.c index e98b540bf..b3e016bd0 100644 --- a/clutter/clutter-backend.c +++ b/clutter/clutter-backend.c @@ -412,6 +412,20 @@ clutter_backend_get_resolution (ClutterBackend *backend) return CLUTTER_FIXED_TO_FLOAT (backend->priv->resolution); } +/** + * clutter_backend_set_font_options: + * @backend: a #ClutterBackend + * @options: Cairo font options for the backend, or %NULL + * + * Sets the new font options for @backend. If @options is %NULL, + * the first following call to clutter_backend_get_font_options() + * will return the default font options for @backend. + * + * This function is intended for actors creating a Pango layout + * using the PangoCairo API. + * + * Since: 0.8 + */ void clutter_backend_set_font_options (ClutterBackend *backend, cairo_font_options_t *options) @@ -434,6 +448,16 @@ clutter_backend_set_font_options (ClutterBackend *backend, } } +/** + * clutter_backend_get_font_options: + * @backend: a #ClutterBackend + * + * Retrieves the font options for @backend. + * + * Return value: the font options of the #ClutterBackend + * + * Since: 0.8 + */ cairo_font_options_t * clutter_backend_get_font_options (ClutterBackend *backend) { diff --git a/clutter/clutter-container.h b/clutter/clutter-container.h index 765e705cd..f67a4331c 100644 --- a/clutter/clutter-container.h +++ b/clutter/clutter-container.h @@ -61,9 +61,10 @@ typedef struct _ClutterContainerIface ClutterContainerIface; * @destroy_child_meta: virtual function that gets called when a child is * removed; it shuld release all resources held by the record * @get_child_meta: return the record for a container child - * @actor_added: signal class handler for #ClutterContainer::actor_added - * @actor_removed: signal class handler for #ClutterContainer::actor_removed - * + * @actor_added: class handler for #ClutterContainer::actor_added + * @actor_removed: class handler for #ClutterContainer::actor_removed + * @child_notify: class handler for #ClutterContainer::child-notify + * * Base interface for container actors. * * Since: 0.4 diff --git a/clutter/clutter-fixed.c b/clutter/clutter-fixed.c index 4558c534a..5ed765868 100644 --- a/clutter/clutter-fixed.c +++ b/clutter/clutter-fixed.c @@ -935,18 +935,19 @@ clutter_qmulx (ClutterFixed op1, ClutterFixed op2) * @op1: #ClutterFixed * @op2: #ClutterFixed * - * Return value: #ClutterFixed. - * * Divides two fixed values using 64bit arithmetic; this provides * significantly better precission than the #CLUTTER_FIXED_DIV macro, * but at performance cost. * + * Return value: #ClutterFixed + * * Since: 0.4 */ ClutterFixed -clutter_qdivx (ClutterFixed op1, ClutterFixed op2) +clutter_qdivx (ClutterFixed op1, + ClutterFixed op2) { - return (ClutterFixed)((((gint64)op1) << CFX_Q) / op2); + return (ClutterFixed) ((((gint64) op1) << CFX_Q) / op2); } /* diff --git a/clutter/clutter-texture.c b/clutter/clutter-texture.c index 73bd63d6a..63b0a90be 100644 --- a/clutter/clutter-texture.c +++ b/clutter/clutter-texture.c @@ -1208,18 +1208,18 @@ clutter_texture_set_from_file (ClutterTexture *texture, } /** - * clutter_texture_set_filter_quality - * @texture: A #ClutterTexture - * @filter_quality: New filter quality value + * clutter_texture_set_filter_quality: + * @texture: a #ClutterTexture + * @filter_quality: new filter quality value * * Sets the filter quality when scaling a texture. The quality is an * enumeration currently the following values are supported: - * CLUTTER_TEXTURE_QUALITY_LOW which is fast but only uses nearest neighbour - * interpolation. CLUTTER_TEXTURE_QUALITY_MEDIUM which is computationally a bit - * more expensive (bilinear interpolation), and CLUTTER_TEXTURE_QUALITY_HIGH - * which uses extra texture memory resources to improve scaled down rendering - * as well (it uses mipmaps). The default value is - * CLUTTER_TEXTURE_QUALITY_MEDIUM. + * %CLUTTER_TEXTURE_QUALITY_LOW which is fast but only uses nearest neighbour + * interpolation. %CLUTTER_TEXTURE_QUALITY_MEDIUM which is computationally a + * bit more expensive (bilinear interpolation), and + * %CLUTTER_TEXTURE_QUALITY_HIGH which uses extra texture memory resources to + * improve scaled down rendering as well (by using mipmaps). The default value + * is %CLUTTER_TEXTURE_QUALITY_MEDIUM. * * Since: 0.8 */ @@ -1243,6 +1243,7 @@ clutter_texture_set_filter_quality (ClutterTexture *texture, cogl_texture_set_filters (priv->texture, clutter_texture_quality_to_cogl_min_filter (priv->filter_quality), clutter_texture_quality_to_cogl_mag_filter (priv->filter_quality)); + if ((old_quality == CLUTTER_TEXTURE_QUALITY_HIGH || filter_quality == CLUTTER_TEXTURE_QUALITY_HIGH) && CLUTTER_ACTOR_IS_REALIZED (texture)) diff --git a/clutter/clutter-texture.h b/clutter/clutter-texture.h index d2330ba11..f1d5a9356 100644 --- a/clutter/clutter-texture.h +++ b/clutter/clutter-texture.h @@ -131,55 +131,51 @@ typedef enum { /*< prefix=CLUTTER_TEXTURE_QUALITY >*/ GType clutter_texture_get_type (void) G_GNUC_CONST; GType clutter_texture_handle_get_type (void) G_GNUC_CONST; -ClutterActor *clutter_texture_new (void); -ClutterActor *clutter_texture_new_from_file (const gchar *filename, - GError **error); -gboolean clutter_texture_set_from_file (ClutterTexture *texture, - const gchar *filename, - GError **error); -gboolean clutter_texture_set_from_rgb_data (ClutterTexture *texture, - const guchar *data, - gboolean has_alpha, - gint width, - gint height, - gint rowstride, - gint bpp, - ClutterTextureFlags flags, - GError **error); -ClutterActor *clutter_texture_new_from_actor (ClutterActor *actor); -gboolean clutter_texture_set_area_from_rgb_data (ClutterTexture *texture, - const guchar *data, - gboolean has_alpha, - gint x, - gint y, - gint width, - gint height, - gint rowstride, - gint bpp, - ClutterTextureFlags flags, - GError **error); - -gboolean clutter_texture_set_from_yuv_data (ClutterTexture *texture, - const guchar *data, - gint width, - gint height, - ClutterTextureFlags flags, - GError **error); -void clutter_texture_get_base_size (ClutterTexture *texture, - gint *width, - gint *height); -void clutter_texture_set_filter_quality (ClutterTexture *texture, - ClutterTextureQuality - filter_quality); -ClutterTextureQuality - clutter_texture_get_filter_quality (ClutterTexture *texture); -void clutter_texture_set_max_tile_waste (ClutterTexture *texture, - gint max_tile_waste); -gint clutter_texture_get_max_tile_waste (ClutterTexture *texture); - -CoglHandle clutter_texture_get_cogl_texture (ClutterTexture *texture); -void clutter_texture_set_cogl_texture (ClutterTexture *texture, - CoglHandle cogl_tex); +ClutterActor * clutter_texture_new (void); +ClutterActor * clutter_texture_new_from_file (const gchar *filename, + GError **error); +ClutterActor * clutter_texture_new_from_actor (ClutterActor *actor); +gboolean clutter_texture_set_from_file (ClutterTexture *texture, + const gchar *filename, + GError **error); +gboolean clutter_texture_set_from_rgb_data (ClutterTexture *texture, + const guchar *data, + gboolean has_alpha, + gint width, + gint height, + gint rowstride, + gint bpp, + ClutterTextureFlags flags, + GError **error); +gboolean clutter_texture_set_from_yuv_data (ClutterTexture *texture, + const guchar *data, + gint width, + gint height, + ClutterTextureFlags flags, + GError **error); +gboolean clutter_texture_set_area_from_rgb_data (ClutterTexture *texture, + const guchar *data, + gboolean has_alpha, + gint x, + gint y, + gint width, + gint height, + gint rowstride, + gint bpp, + ClutterTextureFlags flags, + GError **error); +void clutter_texture_get_base_size (ClutterTexture *texture, + gint *width, + gint *height); +void clutter_texture_set_filter_quality (ClutterTexture *texture, + ClutterTextureQuality filter_quality); +ClutterTextureQuality clutter_texture_get_filter_quality (ClutterTexture *texture); +void clutter_texture_set_max_tile_waste (ClutterTexture *texture, + gint max_tile_waste); +gint clutter_texture_get_max_tile_waste (ClutterTexture *texture); +CoglHandle clutter_texture_get_cogl_texture (ClutterTexture *texture); +void clutter_texture_set_cogl_texture (ClutterTexture *texture, + CoglHandle cogl_tex); G_END_DECLS diff --git a/clutter/clutter-timeline.c b/clutter/clutter-timeline.c index da6b020c3..dd58bb517 100644 --- a/clutter/clutter-timeline.c +++ b/clutter/clutter-timeline.c @@ -25,7 +25,7 @@ /** * SECTION:clutter-timeline - * @short_description: A class for based events + * @short_description: A class for time-based events * * #ClutterTimeline is a base class for managing time based events such * as animations.