diff --git a/clutter/clutter-backend.c b/clutter/clutter-backend.c index 06b5058cf..becf9972f 100644 --- a/clutter/clutter-backend.c +++ b/clutter/clutter-backend.c @@ -375,7 +375,7 @@ _clutter_backend_get_units_per_em (ClutterBackend *backend) } /** - * clutter_get_default_backend1: + * clutter_get_default_backend: * * Retrieves the default #ClutterBackend used by Clutter. The * #ClutterBackend holds backend-specific configuration options. diff --git a/clutter/clutter-behaviour-depth.h b/clutter/clutter-behaviour-depth.h index 859c90a61..bb1c743e0 100644 --- a/clutter/clutter-behaviour-depth.h +++ b/clutter/clutter-behaviour-depth.h @@ -46,6 +46,14 @@ typedef struct _ClutterBehaviourDepth ClutterBehaviourDepth; typedef struct _ClutterBehaviourDepthPrivate ClutterBehaviourDepthPrivate; typedef struct _ClutterBehaviourDepthClass ClutterBehaviourDepthClass; +/** + * ClutterBehaviourDepth: + * + * The #ClutterBehaviourDepth structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.2 + */ struct _ClutterBehaviourDepth { /*< private >*/ @@ -54,8 +62,16 @@ struct _ClutterBehaviourDepth ClutterBehaviourDepthPrivate *priv; }; +/** + * ClutterBehaviourDepthClass: + * + * The #ClutterBehaviourDepthClass structure contains only private data + * + * Since: 0.2 + */ struct _ClutterBehaviourDepthClass { + /*< private >*/ ClutterBehaviourClass parent_class; }; diff --git a/clutter/clutter-behaviour-opacity.h b/clutter/clutter-behaviour-opacity.h index 51d675e45..83fae7890 100644 --- a/clutter/clutter-behaviour-opacity.h +++ b/clutter/clutter-behaviour-opacity.h @@ -60,7 +60,15 @@ G_BEGIN_DECLS typedef struct _ClutterBehaviourOpacity ClutterBehaviourOpacity; typedef struct _ClutterBehaviourOpacityPrivate ClutterBehaviourOpacityPrivate; typedef struct _ClutterBehaviourOpacityClass ClutterBehaviourOpacityClass; - + +/** + * ClutterBehaviourOpacity: + * + * The #ClutterBehaviourOpacity structure contains only private data and + * should be accessed using the provided API + * + * Since: 0.2 + */ struct _ClutterBehaviourOpacity { /*< private >*/ @@ -68,8 +76,16 @@ struct _ClutterBehaviourOpacity ClutterBehaviourOpacityPrivate *priv; }; +/** + * ClutterBehaviourOpacityClass: + * + * The #ClutterBehaviourOpacityClas structure contains only private data + * + * Since: 0.2 + */ struct _ClutterBehaviourOpacityClass { + /*< private >*/ ClutterBehaviourClass parent_class; }; diff --git a/clutter/clutter-behaviour-path.h b/clutter/clutter-behaviour-path.h index eab16efeb..d2ce1d6ed 100644 --- a/clutter/clutter-behaviour-path.h +++ b/clutter/clutter-behaviour-path.h @@ -61,7 +61,15 @@ G_BEGIN_DECLS typedef struct _ClutterBehaviourPath ClutterBehaviourPath; typedef struct _ClutterBehaviourPathPrivate ClutterBehaviourPathPrivate; typedef struct _ClutterBehaviourPathClass ClutterBehaviourPathClass; - + +/** + * ClutterBehaviourPath: + * + * The #ClutterBehaviourPath structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.2 + */ struct _ClutterBehaviourPath { /*< private >*/ @@ -74,6 +82,8 @@ struct _ClutterBehaviourPath * @knot_reached: signal class handler for the * ClutterBehaviourPath::knot_reached signal * + * The #ClutterBehaviourPathClass struct contains only private data + * * Since 0.2 */ struct _ClutterBehaviourPathClass diff --git a/clutter/clutter-child-meta.h b/clutter/clutter-child-meta.h index 2efee32a4..d093c1a5e 100644 --- a/clutter/clutter-child-meta.h +++ b/clutter/clutter-child-meta.h @@ -96,6 +96,13 @@ struct _ClutterChildMeta ClutterActor *actor; }; +/** + * ClutterChildMetaClass: + * + * The #ClutterChildMetaClass contains only private data + * + * Since: 0.8 + */ struct _ClutterChildMetaClass { /*< private >*/ diff --git a/clutter/clutter-clone.c b/clutter/clutter-clone.c index 4a37ebfbc..8cb9b2b87 100644 --- a/clutter/clutter-clone.c +++ b/clutter/clutter-clone.c @@ -22,7 +22,7 @@ */ /** - * SECTION:clutterclone + * SECTION:clutter-clone * @short_description: An actor that displays a clone of a source actor * * #ClutterClone is a #ClutterActor which draws with the paint diff --git a/clutter/clutter-clone.h b/clutter/clutter-clone.h index bafcbde91..470a20503 100644 --- a/clutter/clutter-clone.h +++ b/clutter/clutter-clone.h @@ -43,6 +43,14 @@ typedef struct _ClutterClone ClutterClone; typedef struct _ClutterCloneClass ClutterCloneClass; typedef struct _ClutterClonePrivate ClutterClonePrivate; +/** + * ClutterClone: + * + * The #ClutterClone structure contains only private data + * and should be accessed using the provided API + * + * Since: 1.0 + */ struct _ClutterClone { /*< private >*/ @@ -51,6 +59,13 @@ struct _ClutterClone ClutterClonePrivate *priv; }; +/** + * ClutterCloneClass: + * + * The #ClutterCloneClass structure contains only private data + * + * Since: 1.0 + */ struct _ClutterCloneClass { /*< private >*/ diff --git a/clutter/clutter-group.h b/clutter/clutter-group.h index ac4d37bdd..da777c2ed 100644 --- a/clutter/clutter-group.h +++ b/clutter/clutter-group.h @@ -59,15 +59,30 @@ G_BEGIN_DECLS typedef struct _ClutterGroup ClutterGroup; typedef struct _ClutterGroupClass ClutterGroupClass; typedef struct _ClutterGroupPrivate ClutterGroupPrivate; - + +/** + * ClutterGroup: + * + * The #ClutterGroup structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.1 + */ struct _ClutterGroup { + /*< private >*/ ClutterActor parent_instance; - /*< private >*/ ClutterGroupPrivate *priv; }; +/** + * ClutterGroupClass: + * + * The #ClutterGroupClass structure contains only private data + * + * Since: 0.1 + */ struct _ClutterGroupClass { /*< private >*/ diff --git a/clutter/clutter-media.h b/clutter/clutter-media.h index be2cee4c9..2ad164441 100644 --- a/clutter/clutter-media.h +++ b/clutter/clutter-media.h @@ -42,6 +42,15 @@ G_BEGIN_DECLS typedef struct _ClutterMedia ClutterMedia; /* dummy typedef */ typedef struct _ClutterMediaIface ClutterMediaIface; +/** + * ClutterMediaIface: + * @eos: handler for the #ClutterMedia::eos signal + * @error: handler for the #ClutterMedia::error signal + * + * Interface vtable for #ClutterMedia implementations + * + * Since: 0.2 + */ struct _ClutterMediaIface { /*< private >*/ diff --git a/clutter/clutter-rectangle.h b/clutter/clutter-rectangle.h index 4d79e3087..488880e65 100644 --- a/clutter/clutter-rectangle.h +++ b/clutter/clutter-rectangle.h @@ -45,6 +45,14 @@ typedef struct _ClutterRectangle ClutterRectangle; typedef struct _ClutterRectangleClass ClutterRectangleClass; typedef struct _ClutterRectanglePrivate ClutterRectanglePrivate; +/** + * ClutterRectangle: + * + * The #ClutterRectangle structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.1 + */ struct _ClutterRectangle { /*< private >*/ @@ -53,6 +61,13 @@ struct _ClutterRectangle ClutterRectanglePrivate *priv; }; +/** + * ClutterRectangleClass: + * + * The #ClutterRectangleClass structure contains only private data + * + * Since: 0.1 + */ struct _ClutterRectangleClass { /*< private >*/ diff --git a/clutter/clutter-score.h b/clutter/clutter-score.h index 1bd648c3c..82cd28297 100644 --- a/clutter/clutter-score.h +++ b/clutter/clutter-score.h @@ -44,6 +44,14 @@ typedef struct _ClutterScore ClutterScore; typedef struct _ClutterScorePrivate ClutterScorePrivate; typedef struct _ClutterScoreClass ClutterScoreClass; +/** + * ClutterScore: + * + * The #ClutterScore structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.6 + */ struct _ClutterScore { /*< private >*/ @@ -51,6 +59,19 @@ struct _ClutterScore ClutterScorePrivate *priv; }; +/** + * ClutterScoreClass: + * @timeline_started: handler for the #ClutterScore::timeline-started signal + * @timeline_completed: handler for the #ClutterScore::timeline-completed + * signal + * @started: handler for the #ClutterScore::started signal + * @completed: handler for the #ClutterScore::completed signal + * @paused: handler for the #ClutterScore::paused signal + * + * The #ClutterScoreClass structure contains only private data + * + * Since: 0.6 + */ struct _ClutterScoreClass { /*< private >*/ diff --git a/clutter/clutter-script.h b/clutter/clutter-script.h index ad94c623e..2b9fe799e 100644 --- a/clutter/clutter-script.h +++ b/clutter/clutter-script.h @@ -85,9 +85,24 @@ typedef enum { CLUTTER_SCRIPT_ERROR_INVALID_VALUE } ClutterScriptError; +/** + * CLUTTER_SCRIPT_ERROR: + * + * Error domain for the #ClutterScript errors + * + * Since: 0.6 + */ #define CLUTTER_SCRIPT_ERROR (clutter_script_error_quark ()) GQuark clutter_script_error_quark (void); +/** + * ClutterScript: + * + * The #ClutterScript structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.6 + */ struct _ClutterScript { /*< private >*/ @@ -96,6 +111,17 @@ struct _ClutterScript ClutterScriptPrivate *priv; }; +/** + * ClutterScriptClass: + * @get_type_from_name: virtual function used to map a type name + * to a #GType. This function should only be overridden by + * language bindings in order to map native types to #GType. + * The default implementation is equivalent to g_type_from_name() + * + * The #ClutterScriptClass structure contains only private data + * + * Since: 0.6 + */ struct _ClutterScriptClass { /*< private >*/ diff --git a/clutter/clutter-shader.h b/clutter/clutter-shader.h index 347c19151..bd18a3a02 100644 --- a/clutter/clutter-shader.h +++ b/clutter/clutter-shader.h @@ -40,6 +40,13 @@ G_BEGIN_DECLS #define CLUTTER_IS_SHADER_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), CLUTTER_TYPE_SHADER)) #define CLUTTER_SHADER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), CLUTTER_TYPE_SHADER, ClutterShaderClass)) +/** + * CLUTTER_SHADER_ERROR: + * + * Error domain for #ClutterShader errors + * + * Since: 0.6 + */ #define CLUTTER_SHADER_ERROR (clutter_shader_error_quark ()) /** @@ -62,6 +69,14 @@ typedef struct _ClutterShader ClutterShader; typedef struct _ClutterShaderPrivate ClutterShaderPrivate; typedef struct _ClutterShaderClass ClutterShaderClass; +/** + * ClutterShader: + * + * The #ClutterShader structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.6 + */ struct _ClutterShader { /*< private >*/ @@ -69,6 +84,13 @@ struct _ClutterShader ClutterShaderPrivate *priv; }; +/** + * ClutterShaderClass: + * + * The #ClutterShaderClass structure contains only private data + * + * Since: 0.6 + */ struct _ClutterShaderClass { /*< private >*/ diff --git a/clutter/clutter-stage.h b/clutter/clutter-stage.h index 2f020c0d4..d2001a9db 100644 --- a/clutter/clutter-stage.h +++ b/clutter/clutter-stage.h @@ -82,10 +82,17 @@ G_BEGIN_DECLS typedef struct _ClutterPerspective ClutterPerspective; typedef struct _ClutterFog ClutterFog; - typedef struct _ClutterStageClass ClutterStageClass; typedef struct _ClutterStagePrivate ClutterStagePrivate; +/** + * ClutterStage: + * + * The #ClutterStage structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.1 + */ struct _ClutterStage { /*< private >*/ @@ -93,6 +100,17 @@ struct _ClutterStage ClutterStagePrivate *priv; }; +/** + * ClutterStageClass: + * @fullscreen: handler for the #ClutterStage::fullscreen signal + * @unfullscreen: handler for the #ClutterStage::unfullscreen signal + * @activate: handler for the #ClutterStage::activate signal + * @deactivate: handler for the #ClutterStage::deactive signal + * + * The #ClutterStageClass structure contains only private data + * + * Since: 0.1 + */ struct _ClutterStageClass { diff --git a/clutter/clutter-texture.h b/clutter/clutter-texture.h index ed79f131d..466e5f8c6 100644 --- a/clutter/clutter-texture.h +++ b/clutter/clutter-texture.h @@ -59,6 +59,13 @@ typedef enum { CLUTTER_TEXTURE_ERROR_BAD_FORMAT } ClutterTextureError; +/** + * CLUTTER_TEXTURE_ERROR: + * + * Error domain for #ClutterTexture errors + * + * Since: 0.4 + */ #define CLUTTER_TEXTURE_ERROR (clutter_texture_error_quark ()) GQuark clutter_texture_error_quark (void); @@ -66,6 +73,14 @@ typedef struct _ClutterTexture ClutterTexture; typedef struct _ClutterTextureClass ClutterTextureClass; typedef struct _ClutterTexturePrivate ClutterTexturePrivate; +/** + * ClutterTexture: + * + * The #ClutterTexture structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.1 + */ struct _ClutterTexture { /*< private >*/ @@ -74,10 +89,22 @@ struct _ClutterTexture ClutterTexturePrivate *priv; }; +/** + * ClutterTextureClass: + * @size_change: handler for the #ClutterTexture::size-change signal + * @pixbuf_change: handler for the #ClutterTexture::pixbuf-change signal + * @load_finished: handler for the #ClutterTexture::load-finished signal + * + * The #ClutterTextureClass structure contains only private data + * + * Since: 0.1 + */ struct _ClutterTextureClass { + /*< private >*/ ClutterActorClass parent_class; + /*< public >*/ void (*size_change) (ClutterTexture *texture, gint width, gint height); diff --git a/clutter/clutter-timeline.h b/clutter/clutter-timeline.h index 6483d7b57..bd8a90151 100644 --- a/clutter/clutter-timeline.h +++ b/clutter/clutter-timeline.h @@ -58,6 +58,14 @@ typedef struct _ClutterTimeline ClutterTimeline; typedef struct _ClutterTimelineClass ClutterTimelineClass; typedef struct _ClutterTimelinePrivate ClutterTimelinePrivate; +/** + * ClutterTimeline: + * + * The #ClutterTimeline structure contains only private data + * and should be accessed using the provided API + * + * Since: 0.2 + */ struct _ClutterTimeline { /*< private >*/ @@ -65,6 +73,18 @@ struct _ClutterTimeline ClutterTimelinePrivate *priv; }; +/** + * ClutterTimelineClass: + * @started: handler for the #ClutterTimeline::started signal + * @completed: handler for the #ClutterTimeline::completed signal + * @paused: handler for the #ClutterTimeline::paused signal + * @new_frame: handler for the #ClutterTimeline::new-frame signal + * @marker_reached: handler for the #ClutterTimeline::marker-reached signal + * + * The #ClutterTimelineClass structure contains only private data + * + * Since: 0.2 + */ struct _ClutterTimelineClass { /*< private >*/ diff --git a/clutter/clutter-units.h b/clutter/clutter-units.h index 00a1e0dc2..c2db312eb 100644 --- a/clutter/clutter-units.h +++ b/clutter/clutter-units.h @@ -40,19 +40,70 @@ G_BEGIN_DECLS * ClutterUnit: * * Device independent unit used by Clutter. The value held can be - * transformed into other units, likes pixels. + * transformed into other units, likes pixels * * Since: 0.4 */ typedef float ClutterUnit; +/** + * CLUTTER_UNITS_FROM_INT: + * @x: integer value + * + * Converts @x from an integer value to #ClutterUnits + * + * Since: 0.6 + */ #define CLUTTER_UNITS_FROM_INT(x) ((float)(x)) + +/** + * CLUTTER_UNITS_TO_INT: + * @x: value in #ClutterUnits + * + * Converts @x from a #ClutterUnit value into an integer + * + * Since: 0.6 + */ #define CLUTTER_UNITS_TO_INT(x) ((int)(x)) +/** + * CLUTTER_UNITS_FROM_FLOAT: + * @x: float value + * + * Converts @x from a floating point value to #ClutterUnits + * + * Since: 0.6 + */ #define CLUTTER_UNITS_FROM_FLOAT(x) (x) + +/** + * CLUTTER_UNITS_TO_FLOAT: + * @x: value in #ClutterUnits + * + * Converts @x from a #ClutterUnit value into a float + * + * Since: 0.6 + */ #define CLUTTER_UNITS_TO_FLOAT(x) (x) +/** + * CLUTTER_UNITS_FROM_FIXED: + * @x: #CoglFixed value + * + * Converts @x from a fixed point value to #ClutterUnits + * + * Since: 0.6 + */ #define CLUTTER_UNITS_FROM_FIXED(x) (COGL_FIXED_TO_FLOAT (x)) + +/** + * CLUTTER_UNITS_TO_FIXED: + * @x: value in #ClutterUnits + * + * Converts @x from a #ClutterUnit value into a #CoglFixed + * + * Since: 0.6 + */ #define CLUTTER_UNITS_TO_FIXED(x) (COGL_FIXED_FROM_FLOAT (x)) /** diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt index 62716ef6d..da8e25ee1 100644 --- a/doc/reference/clutter/clutter-sections.txt +++ b/doc/reference/clutter/clutter-sections.txt @@ -1359,15 +1359,12 @@ clutter_shader_get_cogl_vertex_shader clutter_shader_set_uniform_1f -ClutterShaderFloat CLUTTER_VALUE_HOLDS_SHADER_FLOAT clutter_value_set_shader_float clutter_value_get_shader_float -ClutterShaderInt CLUTTER_VALUE_HOLDS_SHADER_INT clutter_value_set_shader_int clutter_value_get_shader_int -ClutterShaderMatrix CLUTTER_VALUE_HOLDS_SHADER_MATRIX clutter_value_set_shader_matrix clutter_value_get_shader_matrix @@ -1387,8 +1384,11 @@ CLUTTER_TYPE_SHADER_MATRIX ClutterShaderPrivate clutter_shader_get_type +ClutterShaderFloat clutter_shader_float_get_type +ClutterShaderInt clutter_shader_int_get_type +ClutterShaderMatrix clutter_shader_matrix_get_type clutter_shader_error_quark