sungmg/mutter-performance-source
1
0
Fork 0
Code Activity

clutter: Migrate to gi-docgen

Browse source 
- Drop all the private structs documentations
- Make use of gi-docgen items linking as much as possible
- Use markdown formatting for code snippets

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2441>
This commit is contained in:
Bilal Elmoussaoui 2022-05-25 18:41:48 +02:00
parent 4736f873f2
commit c8e63866f0
125 changed files with 1120 additions and 1593 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
clutter/clutter/clutter-action.c
View file

@ -23,22 +23,21 @@
*/
/**
* SECTION:clutter-action
* @Title: ClutterAction
* @Short_Description: Abstract class for event-related logic
* @See_Also: #ClutterConstraint
* ClutterAction:
*
* Abstract class for event-related logic
*
* #ClutterAction is an abstract base class for event-related actions that
* modify the user interaction of a #ClutterActor, just like
* #ClutterConstraint is an abstract class for modifiers of an actor's
* modify the user interaction of a [class@Actor], just like
* [class@Constraint] is an abstract class for modifiers of an actor's
* position or size.
*
* Implementations of #ClutterAction are associated to an actor and can
* provide behavioral changes when dealing with user input - for instance
* drag and drop capabilities, or scrolling, or panning - by using the
* various event-related signals provided by #ClutterActor itself.
* various event-related signals provided by [class@Actor] itself.
*
* #ClutterAction is available since Clutter 1.4
* Since: 1.4
*/
#include "clutter-build-config.h"

22
clutter/clutter/clutter-actor-box.c
View file

@ -14,19 +14,19 @@
* @x_2: X coordinate of the bottom right point
* @y_2: Y coordinate of the bottom right point
*
* Allocates a new #ClutterActorBox using the passed coordinates
* Allocates a new [struct@ActorBox] using the passed coordinates
* for the top left and bottom right points.
*
* This function is the logical equivalent of:
*
* |[
* ```c
* clutter_actor_box_init (clutter_actor_box_alloc (),
* x_1, y_1,
* x_2, y_2);
* ]|
* ```
*
* Return value: (transfer full): the newly allocated #ClutterActorBox.
* Use clutter_actor_box_free() to free the resources
* Use [method@ActorBox.free] to free the resources
*
* Since: 1.0
*/
@ -44,10 +44,10 @@ clutter_actor_box_new (gfloat x_1,
/**
* clutter_actor_box_alloc:
*
* Allocates a new #ClutterActorBox.
* Allocates a new [struct@ActorBox].
*
* Return value: (transfer full): the newly allocated #ClutterActorBox.
* Use clutter_actor_box_free() to free its resources
* Use [method@ActorBox.free] to free its resources
*
* Since: 1.12
*/
@ -122,7 +122,7 @@ clutter_actor_box_init_rect (ClutterActorBox *box,
* Copies @box
*
* Return value: a newly allocated copy of #ClutterActorBox. Use
* clutter_actor_box_free() to free the allocated resources
* [method@ActorBox.free] to free the allocated resources
*
* Since: 1.0
*/
@ -139,8 +139,8 @@ clutter_actor_box_copy (const ClutterActorBox *box)
* clutter_actor_box_free:
* @box: a #ClutterActorBox
*
* Frees a #ClutterActorBox allocated using clutter_actor_box_new()
* or clutter_actor_box_copy()
* Frees a #ClutterActorBox allocated using [ctor@ActorBox.new]
* or [method@ActorBox.copy].
*
* Since: 1.0
*/
@ -343,7 +343,7 @@ clutter_actor_box_contains (const ClutterActorBox *box,
* @verts: (array fixed-size=4): array of four #graphene_point3d_t
*
* Calculates the bounding box represented by the four vertices; for details
* of the vertex array see clutter_actor_get_abs_allocation_vertices().
* of the vertex array see [method@Actor.get_abs_allocation_vertices].
*
* Since: 1.0
*/
@ -412,7 +412,7 @@ clutter_actor_box_from_vertices (ClutterActorBox *box,
* @progress: the interpolation progress
* @result: (out): return location for the interpolation
*
* Interpolates between @initial and @final #ClutterActorBox<!-- -->es
* Interpolates between @initial and @final `ClutterActorBox`es
* using @progress
*
* Since: 1.2

19
clutter/clutter/clutter-actor-meta.c
View file

@ -23,22 +23,21 @@
*/
/**
* SECTION:clutter-actor-meta
* @Title: ClutterActorMeta
* @Short_Description: Base class of actor modifiers
* @See_Also: #ClutterAction, #ClutterConstraint
* ClutterActorMeta:
*
* Base class of actor modifiers
*
* #ClutterActorMeta is an abstract class providing a common API for
* modifiers of #ClutterActor behaviour, appearance or layout.
* modifiers of [class@Actor] behaviour, appearance or layout.
*
* A #ClutterActorMeta can only be owned by a single #ClutterActor at
* A #ClutterActorMeta can only be owned by a single [class@Actor] at
* any time.
*
* Every sub-class of #ClutterActorMeta should check if the
* #ClutterActorMeta:enabled property is set to %TRUE before applying
* [property@ActorMeta:enabled] property is set to %TRUE before applying
* any kind of modification.
*
* #ClutterActorMeta is available since Clutter 1.4
* Since: 1.4
*/
#include "clutter-build-config.h"
@ -298,7 +297,7 @@ clutter_actor_meta_set_name (ClutterActorMeta *meta,
* clutter_actor_meta_get_name:
* @meta: a #ClutterActorMeta
*
* Retrieves the name set using clutter_actor_meta_set_name()
* Retrieves the name set using [method@ActorMeta.set_name]
*
* Return value: (transfer none): the name of the #ClutterActorMeta
* instance, or %NULL if none was set. The returned string is owned
@ -391,7 +390,7 @@ _clutter_actor_meta_set_actor (ClutterActorMeta *meta,
* clutter_actor_meta_get_actor:
* @meta: a #ClutterActorMeta
*
* Retrieves a pointer to the #ClutterActor that owns @meta
* Retrieves a pointer to the [class@Actor] that owns @meta
*
* Return value: (transfer none): a pointer to a #ClutterActor or %NULL
*

216
clutter/clutter/clutter-actor.c
View file

@ -23,46 +23,47 @@
*/
/**
* SECTION:clutter-actor
* @short_description: The basic element of the scene graph
* ClutterActor:
*
* The basic element of the scene graph
*
* The ClutterActor class is the basic element of the scene graph in Clutter,
* and it encapsulates the position, size, and transformations of a node in
* the graph.
*
* ## Actor transformations ## {#clutter-actor-transformations}
* ## Actor transformations
*
* Each actor can be transformed using methods like clutter_actor_set_scale()
* or clutter_actor_set_rotation(). The order in which the transformations are
* Each actor can be transformed using methods like [method@Actor.set_scale]
* or [method@Actor.set_rotation_angle]. The order in which the transformations are
* applied is decided by Clutter and it is the following:
*
* 1. translation by the origin of the #ClutterActor:allocation property
* 2. translation by the actor's #ClutterActor:z-position property
* 3. translation by the actor's #ClutterActor:pivot-point property
* 4. scaling by the #ClutterActor:scale-x and #ClutterActor:scale-y factors
* 5. rotation around the #ClutterActor:rotation-angle-x and #ClutterActor:rotation-center-x
* 6. rotation around the #ClutterActor:rotation-angle-y and #ClutterActor:rotation-center-y
* 7. rotation around the #ClutterActor:rotation-angle-z and #ClutterActor:rotation-center-z
* 8. negative translation by the actor's #ClutterActor:pivot-point
* 1. translation by the origin of the [property@Actor:allocation] property
* 2. translation by the actor's [property@Actor:z-position] property
* 3. translation by the actor's [property@Actor:pivot-point] property
* 4. scaling by the [property@Actor:scale-x] and [property@Actor:scale-y] factors
* 5. rotation around the [property@Actor:rotation-angle-x]
* 6. rotation around the [property@Actor:rotation-angle-y]
* 7. rotation around the [property@Actor:rotation-angle-z]
* 8. negative translation by the actor's [property@Actor:pivot-point]
*
* ## Modifying an actor's geometry ## {#clutter-actor-geometry}
* ## Modifying an actor's geometry
*
* Each actor has a bounding box, called #ClutterActor:allocation
* Each actor has a bounding box, called [property@Actor:allocation]
* which is either set by its parent or explicitly through the
* clutter_actor_set_position() and clutter_actor_set_size() methods.
* [method@Actor.set_position] and [method@Actor.set_size] methods.
* Each actor also has an implicit preferred size.
*
* An actor’s preferred size can be defined by any subclass by
* overriding the #ClutterActorClass.get_preferred_width() and the
* #ClutterActorClass.get_preferred_height() virtual functions, or it can
* be explicitly set by using clutter_actor_set_width() and
* clutter_actor_set_height().
* overriding the [vfunc@Actor.get_preferred_width] and the
* [vfunc@Actor.get_preferred_height] virtual functions, or it can
* be explicitly set by using [method@Actor.set_width] and
* [method@Actor.set_height].
*
* An actor’s position can be set explicitly by using
* clutter_actor_set_x() and clutter_actor_set_y(); the coordinates are
* [method@Actor.set_x] and [method@Actor.set_y]; the coordinates are
* relative to the origin of the actor’s parent.
*
* ## Managing actor children ## {#clutter-actor-children}
* ## Managing actor children
*
* Each actor can have multiple children, by calling
* clutter_actor_add_child() to add a new child actor, and
@ -71,7 +72,7 @@
* the child is removed from its parent, or destroyed using
* clutter_actor_destroy().
*
* |[<!-- language="C" -->
* ```c
* ClutterActor *actor = clutter_actor_new ();
*
* // set the bounding box of the actor
@ -91,7 +92,7 @@
*
* // add the child to the actor
* clutter_actor_add_child (actor, child);
* ]|
* ```
*
* Children can be inserted at a given index, or above and below
* another child actor. The order of insertion determines the order of the
@ -109,7 +110,7 @@
*
* See [basic-actor.c](https://git.gnome.org/browse/clutter/tree/examples/basic-actor.c?h=clutter-1.18).
*
* ## Painting an actor ## {#clutter-actor-painting}
* ## Painting an actor
*
* There are three ways to paint an actor:
*
@ -123,7 +124,7 @@
* and before calling the actor's own implementation of the
* #ClutterActorClass.paint_node() virtual function.
*
* |[<!-- language="C" -->
* ```c
* ClutterActor *actor = clutter_actor_new ();
*
* // set the bounding box
@ -132,7 +133,7 @@
*
* // set the content; the image_content variable is set elsewhere
* clutter_actor_set_content (actor, image_content);
* ]|
* ```
*
* The #ClutterActorClass.paint_node() virtual function is invoked whenever
* an actor needs to be painted. The implementation of the virtual function
@ -143,7 +144,7 @@
* the render tree; any node added to it will be rendered at the correct
* position, as defined by the actor's #ClutterActor:allocation.
*
* |[<!-- language="C" -->
* ```c
* static void
* my_actor_paint_node (ClutterActor *actor,
* ClutterPaintNode *root)
@ -166,6 +167,7 @@
* clutter_paint_node_add_child (root, node);
* clutter_paint_node_unref (node);
* }
* ```
*
* The #ClutterActorClass.paint() virtual function function gives total
* control to the paint sequence of the actor itself, including the
@ -173,7 +175,7 @@
* the #ClutterActorClass.paint() virtual function and it will be removed
* when the Clutter API changes.
*
* ## Handling events on an actor ## {#clutter-actor-event-handling}
* ## Handling events on an actor
*
* A #ClutterActor can receive and handle input device events, for
* instance pointer events and key events, as long as its
@ -193,7 +195,7 @@
* through the scene graph by returning %CLUTTER_EVENT_STOP; otherwise, they can
* continue the propagation by returning %CLUTTER_EVENT_PROPAGATE.
*
* ## Animation ## {#clutter-actor-animation}
* ## Animation
*
* Animation is a core concept of modern user interfaces; Clutter provides a
* complete and powerful animation framework that automatically tweens the
@ -217,7 +219,7 @@
* the default easing state for an actor you should call the
* clutter_actor_save_easing_state() function:
*
* |[<!-- language="C" -->
* ```c
* // assume that the actor is currently positioned at (100, 100)
*
* // store the current easing state and reset the new easing state to
@ -229,7 +231,7 @@
*
* // restore the previously saved easing state
* clutter_actor_restore_easing_state (actor);
* ]|
* ```
*
* The example above will trigger an implicit animation of the
* actor between its current position to a new position.
@ -243,7 +245,7 @@
* at the same time, and you can animate multiple actors at the same
* time as well, for instance:
*
* |[<!-- language="C" -->
* ```c
* clutter_actor_save_easing_state (actor);
*
* // animate the actor's opacity and depth
@ -259,7 +261,7 @@
* clutter_actor_set_z_position (another_actor, 100);
*
* clutter_actor_restore_easing_state (another_actor);
* ]|
* ```
*
* Changing the easing state will affect all the following property
* transitions, but will not affect existing transitions.
@ -270,7 +272,7 @@
* mode by using the current easing state; for instance, in the following
* example:
*
* |[<!-- language="C" -->
* ```c
* clutter_actor_save_easing_state (actor);
* clutter_actor_set_easing_duration (actor, 1000);
* clutter_actor_set_x (actor, 200);
@ -280,7 +282,7 @@
* clutter_actor_set_easing_duration (actor, 500);
* clutter_actor_set_x (actor, 100);
* clutter_actor_restore_easing_state (actor);
* ]|
* ```
*
* the first call to clutter_actor_set_x() will begin a transition
* of the #ClutterActor:x property from the current value to the value of
@ -303,7 +305,7 @@
* and final values. The transition will not start unless you add it to the
* #ClutterActor.
*
* |[<!-- language="C" -->
* ```c
* ClutterTransition *transition;
*
* transition = clutter_property_transition_new_for_actor (actor, "opacity");
@ -314,7 +316,7 @@
* clutter_transition_set_to (transition, G_TYPE_UINT, 0);
*
* clutter_actor_add_transition (actor, "animate-opacity", transition);
* ]|
* ```
*
* The example above will animate the #ClutterActor:opacity property
* of an actor between fully opaque and fully transparent, and back, over
@ -334,7 +336,7 @@
* Finally, explicit animations are useful for creating animations
* that run continuously, for instance:
*
* |[<!-- language="C" -->
* ```c
* // this animation will pulse the actor's opacity continuously
* ClutterTransition *transition;
* ClutterInterval *interval;
@ -358,9 +360,9 @@
*
* // add the transition to the desired actor to start it
* clutter_actor_add_transition (actor, "opacityAnimation", transition);
* ]|
* ```
*
* ## Implementing an actor ## {#clutter-actor-implementing}
* ## Implementing an actor
*
* Careful consideration should be given when deciding to implement
* a #ClutterActor sub-class. It is generally recommended to implement a
@ -378,16 +380,16 @@
* In general, it is strongly encouraged to use delegation and composition
* instead of direct subclassing.
*
* ## ClutterActor custom properties for ClutterScript ## {#clutter-actor-custom-script}
* ## ClutterActor custom properties for ClutterScript
*
* #ClutterActor defines a custom "rotation" property which allows a short-hand
* description of the rotations to be applied to an actor.
*
* The syntax of the "rotation" property is the following:
*
* |[
* ```
* "rotation" : [ { "<axis>" : [ <angle>, [ <center-point> ] ] } ]
* ]|
* ```
*
* where:
*
@ -400,7 +402,7 @@
*
* #ClutterActor also defines a scriptable "margin" property which follows the CSS "margin" shorthand.
*
* |[
* ```
* // 4 values
* "margin" : [ top, right, bottom, left ]
* // 3 values
@ -409,7 +411,7 @@
* "margin" : [ top/bottom, left/right ]
* // 1 value
* "margin" : [ top/right/bottom/left ]
* ]|
* ```
*
* #ClutterActor will also parse every positional and dimensional
* property defined as a string through clutter_units_from_string(); you
@ -428,9 +430,9 @@
*
* The property can be accessed using the following syntax:
*
* |[
* ```
* @<section>.<meta-name>.<property-name>
* ]|
* ```
*
* - the initial `@` is mandatory
* - the `section` fragment can be one between "actions", "constraints", "content",
@ -448,11 +450,11 @@
* As the actor has only one #ClutterLayoutManager, the syntax for accessing its
* properties is simpler:
*
* |[
* ```
* @layout.<property-name>
* ]|
* ```
*
* |[<!-- language="C" -->
* ```c
* constraint = clutter_bind_constraint_new (origin, CLUTTER_BIND_X, 0.0);
* clutter_actor_meta_set_name (CLUTTER_ACTOR_META (constraint), "bind-x");
* clutter_actor_add_constraint (rect, constraint);
@ -466,13 +468,13 @@
* g_signal_connect (origin, "button-press-event",
* G_CALLBACK (on_button_press),
* rect);
* ]|
* ```
*
* On button press, the rectangle "slides" from behind the actor to
* which is bound to, using the #ClutterBindConstraint:offset property to
* achieve the effect:
*
* |[<!-- language="C" -->
* ```c
* gboolean
* on_button_press (ClutterActor *origin,
* ClutterEvent *event,
@ -512,7 +514,7 @@
* // we handled the event
* return CLUTTER_EVENT_STOP;
* }
* ]|
* ```
*/
/**
@ -6324,7 +6326,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
*
* For instance:
*
* |[<!-- language="C" -->
* ```c
* ClutterRequestMode mode;
* gfloat natural_width, min_width;
* gfloat natural_height, min_height;
@ -6358,7 +6360,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* if (content != NULL)
* clutter_content_get_preferred_size (content, &natural_width, &natural_height);
* }
* ]|
* ```
*
* will retrieve the minimum and natural width and height depending on the
* preferred request mode of the #ClutterActor "child".
@ -7348,10 +7350,10 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::destroy:
* @actor: the #ClutterActor which emitted the signal
*
* The ::destroy signal notifies that all references held on the
* The signal notifies that all references held on the
* actor which emitted it should be released.
*
* The ::destroy signal should be used by all holders of a reference
* The signal should be used by all holders of a reference
* on @actor.
*
* This signal might result in the finalization of the #ClutterActor
@ -7376,7 +7378,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::show:
* @actor: the object which received the signal
*
* The ::show signal is emitted when an actor is visible and
* The signal is emitted when an actor is visible and
* rendered on the stage.
*
* Since: 0.2
@ -7392,7 +7394,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::hide:
* @actor: the object which received the signal
*
* The ::hide signal is emitted when an actor is no longer rendered
* The signal is emitted when an actor is no longer rendered
* on the stage.
*
* Since: 0.2
@ -7426,7 +7428,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::queue-relayout:
* @actor: the actor being queued for relayout
*
* The ::queue_layout signal is emitted when clutter_actor_queue_relayout()
* The signal is emitted when clutter_actor_queue_relayout()
* is called on an actor.
*
* The default implementation for #ClutterActor chains up to the
@ -7453,7 +7455,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which received the event
* @event: a #ClutterEvent
*
* The ::event signal is emitted each time an event is received
* The signal is emitted each time an event is received
* by the @actor. This signal will be emitted on every actor,
* following the hierarchy chain, until it reaches the top-level
* container (the #ClutterStage).
@ -7480,7 +7482,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which received the event
* @event: (type ClutterButtonEvent): a #ClutterButtonEvent
*
* The ::button-press-event signal is emitted each time a mouse button
* The signal is emitted each time a mouse button
* is pressed on @actor.
*
* Return value: %TRUE if the event has been handled by the actor,
@ -7505,7 +7507,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which received the event
* @event: (type ClutterButtonEvent): a #ClutterButtonEvent
*
* The ::button-release-event signal is emitted each time a mouse button
* The signal is emitted each time a mouse button
* is released on @actor.
*
* Return value: %TRUE if the event has been handled by the actor,
@ -7530,7 +7532,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which received the event
* @event: (type ClutterScrollEvent): a #ClutterScrollEvent
*
* The ::scroll-event signal is emitted each time the mouse is
* The signal is emitted each time the mouse is
* scrolled on @actor
*
* Return value: %TRUE if the event has been handled by the actor,
@ -7555,7 +7557,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which received the event
* @event: (type ClutterKeyEvent): a #ClutterKeyEvent
*
* The ::key-press-event signal is emitted each time a keyboard button
* The signal is emitted each time a keyboard button
* is pressed while @actor has key focus (see clutter_stage_set_key_focus()).
*
* Return value: %TRUE if the event has been handled by the actor,
@ -7580,7 +7582,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which received the event
* @event: (type ClutterKeyEvent): a #ClutterKeyEvent
*
* The ::key-release-event signal is emitted each time a keyboard button
* The signal is emitted each time a keyboard button
* is released while @actor has key focus (see
* clutter_stage_set_key_focus()).
*
@ -7606,7 +7608,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which received the event
* @event: (type ClutterMotionEvent): a #ClutterMotionEvent
*
* The ::motion-event signal is emitted each time the mouse pointer is
* The signal is emitted each time the mouse pointer is
* moved over @actor.
*
* Return value: %TRUE if the event has been handled by the actor,
@ -7631,7 +7633,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::key-focus-in:
* @actor: the actor which now has key focus
*
* The ::key-focus-in signal is emitted when @actor receives key focus.
* The signal is emitted when @actor receives key focus.
*
* Since: 0.6
*/
@ -7647,7 +7649,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::key-focus-out:
* @actor: the actor which now has key focus
*
* The ::key-focus-out signal is emitted when @actor loses key focus.
* The signal is emitted when @actor loses key focus.
*
* Since: 0.6
*/
@ -7664,7 +7666,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which the pointer has entered.
* @event: (type ClutterCrossingEvent): a #ClutterCrossingEvent
*
* The ::enter-event signal is emitted when the pointer enters the @actor
* The signal is emitted when the pointer enters the @actor
*
* Return value: %TRUE if the event has been handled by the actor,
* or %FALSE to continue the emission.
@ -7689,7 +7691,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which the pointer has left
* @event: (type ClutterCrossingEvent): a #ClutterCrossingEvent
*
* The ::leave-event signal is emitted when the pointer leaves the @actor.
* The signal is emitted when the pointer leaves the @actor.
*
* Return value: %TRUE if the event has been handled by the actor,
* or %FALSE to continue the emission.
@ -7714,7 +7716,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the actor which received the signal
* @event: a #ClutterEvent
*
* The ::captured-event signal is emitted when an event is captured
* The signal is emitted when an event is captured
* by Clutter. This signal will be emitted starting from the top-level
* container (the #ClutterStage) to the actor which received the event
* going down the hierarchy. This signal can be used to intercept every
@ -7744,7 +7746,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::realize:
* @actor: the #ClutterActor that received the signal
*
* The ::realize signal is emitted each time an actor is being
* The signal is emitted each time an actor is being
* realized.
*
* Since: 0.8
@ -7763,7 +7765,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::unrealize:
* @actor: the #ClutterActor that received the signal
*
* The ::unrealize signal is emitted each time an actor is being
* The signal is emitted each time an actor is being
* unrealized.
*
* Since: 0.8
@ -7784,14 +7786,14 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: the #ClutterActor that received the signal
* @pick_context: a #ClutterPickContext
*
* The ::pick signal is emitted each time an actor is being painted
* The signal is emitted each time an actor is being painted
* in "pick mode". The pick mode is used to identify the actor during
* the event handling phase, or by clutter_stage_get_actor_at_pos().
*
* Subclasses of #ClutterActor should override the class signal handler
* and paint themselves in that function.
*
* It is possible to connect a handler to the ::pick signal in order
* It is possible to connect a handler to the signal in order
* to set up some custom aspect of a paint in pick mode.
*
* Since: 1.0
@ -7811,7 +7813,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::transitions-completed:
* @actor: a #ClutterActor
*
* The ::transitions-completed signal is emitted once all transitions
* The signal is emitted once all transitions
* involving @actor are complete.
*
* Since: 1.10
@ -7830,7 +7832,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @name: the name of the transition
* @is_finished: whether the transition was finished, or stopped
*
* The ::transition-stopped signal is emitted once a transition
* The signal is emitted once a transition
* is stopped; a transition is stopped once it reached its total
* duration (including eventual repeats), it has been stopped
* using clutter_timeline_stop(), or it has been removed from the
@ -7858,7 +7860,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* @actor: a #ClutterActor
* @event: a #ClutterEvent
*
* The ::touch-event signal is emitted each time a touch
* The signal is emitted each time a touch
* begin/end/update/cancel event.
*
* Return value: %CLUTTER_EVENT_STOP if the event has been handled by
@ -7883,7 +7885,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::stage-views-changed:
* @actor: a #ClutterActor
*
* The ::stage-views-changed signal is emitted when the position or
* The signal is emitted when the position or
* size an actor is being painted at have changed so that it's visible
* on different stage views.
*
@ -7903,7 +7905,7 @@ clutter_actor_class_init (ClutterActorClass *klass)
* ClutterActor::resource-scale-changed:
* @actor: a #ClutterActor
*
* The ::resource-scale-changed signal is emitted when the resource scale
* The signal is emitted when the resource scale
* value returned by clutter_actor_get_resource_scale() changes.
*
* This signal can be used to get notified about the correct resource scale
@ -11260,7 +11262,7 @@ clutter_actor_get_clip (ClutterActor *self,
* Retrieves the list of children of @self.
*
* Return value: (transfer container) (element-type ClutterActor): A newly
* allocated #GList of #ClutterActor<!-- -->s. Use g_list_free() when
* allocated #GList of `ClutterActor`s. Use g_list_free() when
* done.
*
* Since: 1.10
@ -13723,7 +13725,7 @@ clutter_actor_get_stage (ClutterActor *actor)
*
* The implementation of this function is equivalent to:
*
* |[<!-- language="C" -->
* ```c
* if (request_mode == CLUTTER_REQUEST_HEIGHT_FOR_WIDTH)
* {
* clutter_actor_get_preferred_width (self, available_height,
@ -13760,7 +13762,7 @@ clutter_actor_get_stage (ClutterActor *actor)
* box.x2 = box.x1 + available_width;
* box.y2 = box.y1 + available_height;
* clutter_actor_allocate (self, &box);
* ]|
* ```
*
* This function can be used by fluid layout managers to allocate
* an actor's preferred size without making it bigger than the area
@ -14895,10 +14897,10 @@ clutter_actor_add_action (ClutterActor *self,
*
* This function is the logical equivalent of:
*
* |[<!-- language="C" -->
* ```c
* clutter_actor_meta_set_name (CLUTTER_ACTOR_META (action), name);
* clutter_actor_add_action (self, action);
* ]|
* ```
*
* Since: 1.4
*/
@ -15005,7 +15007,7 @@ clutter_actor_remove_action_by_name (ClutterActor *self,
* Retrieves the list of actions applied to @self
*
* Return value: (transfer container) (element-type Clutter.Action): a copy
* of the list of #ClutterAction<!-- -->s. The contents of the list are
* of the list of `ClutterAction`s. The contents of the list are
* owned by the #ClutterActor. Use g_list_free() to free the resources
* allocated by the returned #GList
*
@ -15073,7 +15075,7 @@ clutter_actor_clear_actions (ClutterActor *self)
* @self: a #ClutterActor
* @constraint: a #ClutterConstraint
*
* Adds @constraint to the list of #ClutterConstraint<!-- -->s applied
* Adds @constraint to the list`of `ClutterConstraint`s applied
* to @self
*
* The #ClutterActor will hold a reference on the @constraint until
@ -15117,10 +15119,10 @@ clutter_actor_add_constraint (ClutterActor *self,
*
* This function is the logical equivalent of:
*
* |[<!-- language="C" -->
* ```c
* clutter_actor_meta_set_name (CLUTTER_ACTOR_META (constraint), name);
* clutter_actor_add_constraint (self, constraint);
* ]|
* ```
*
* Since: 1.4
*/
@ -15213,7 +15215,7 @@ clutter_actor_remove_constraint_by_name (ClutterActor *self,
* Retrieves the list of constraints applied to @self
*
* Return value: (transfer container) (element-type Clutter.Constraint): a copy
* of the list of #ClutterConstraint<!-- -->s. The contents of the list are
* of the list of `ClutterConstraint`s. The contents of the list are
* owned by the #ClutterActor. Use g_list_free() to free the resources
* allocated by the returned #GList
*
@ -15335,7 +15337,7 @@ clutter_actor_get_clip_to_allocation (ClutterActor *self)
* @self: a #ClutterActor
* @effect: a #ClutterEffect
*
* Adds @effect to the list of #ClutterEffect<!-- -->s applied to @self
* Adds @effect to the list of `ClutterEffect`s applied to @self
*
* The #ClutterActor will hold a reference on the @effect until either
* clutter_actor_remove_effect() or clutter_actor_clear_effects() is
@ -15368,10 +15370,10 @@ clutter_actor_add_effect (ClutterActor *self,
*
* This function is the logical equivalent of:
*
* |[<!-- language="C" -->
* ```c
* clutter_actor_meta_set_name (CLUTTER_ACTOR_META (effect), name);
* clutter_actor_add_effect (self, effect);
* ]|
* ```
*
* Since: 1.4
*/
@ -15449,10 +15451,10 @@ clutter_actor_remove_effect_by_name (ClutterActor *self,
* clutter_actor_get_effects:
* @self: a #ClutterActor
*
* Retrieves the #ClutterEffect<!-- -->s applied on @self, if any
* Retrieves the `ClutterEffect`s applied on @self, if any
*
* Return value: (transfer container) (element-type Clutter.Effect): a list
* of #ClutterEffect<!-- -->s, or %NULL. The elements of the returned
* of `ClutterEffect`s, or %NULL. The elements of the returned
* list are owned by Clutter and they should not be freed. You should
* free the returned list using g_list_free() when done
*
@ -16089,7 +16091,7 @@ clutter_actor_finish_layout (ClutterActor *self,
* clutter_actor_peek_stage_views:
* @self: A #ClutterActor
*
* Retrieves the list of #ClutterStageView<!-- -->s the actor is being
* Retrieves the list of `ClutterStageView`s the actor is being
* painted on.
*
* If this function is called during the paint cycle, the list is guaranteed
@ -16105,7 +16107,7 @@ clutter_actor_finish_layout (ClutterActor *self,
* always return an empty list.
*
* Returns: (transfer none) (element-type Clutter.StageView): The list of
* #ClutterStageView<!-- -->s the actor is being painted on. The list and
* `ClutterStageView`s the actor is being painted on. The list and
* its contents are owned by the #ClutterActor and the list may not be
* freed or modified.
*/
@ -17284,7 +17286,7 @@ typedef struct _RealActorIter
* Modifying the scene graph section that contains @root will invalidate
* the iterator.
*
* |[<!-- language="C" -->
* ```c
* ClutterActorIter iter;
* ClutterActor *child;
*
@ -17293,7 +17295,7 @@ typedef struct _RealActorIter
* {
* // do something with child
* }
* ]|
* ```
*
* Since: 1.10
*/
@ -18217,7 +18219,7 @@ clutter_actor_get_easing_delay (ClutterActor *self)
* Transitions created for animatable properties use the name of the
* property itself, for instance the code below:
*
* |[<!-- language="C" -->
* ```c
* clutter_actor_set_easing_duration (actor, 1000);
* clutter_actor_set_rotation_angle (actor, CLUTTER_Y_AXIS, 360.0);
*
@ -18225,7 +18227,7 @@ clutter_actor_get_easing_delay (ClutterActor *self)
* g_signal_connect (transition, "stopped",
* G_CALLBACK (on_transition_stopped),
* actor);
* ]|
* ```
*
* will call the `on_transition_stopped` callback when the transition
* is finished.
@ -19627,7 +19629,7 @@ bind_child_with_properties (gpointer item,
* items inside the @model to the corresponding properties on the child,
* for instance:
*
* |[<!-- language="C" -->
* ```c
* clutter_actor_bind_model_with_properties (actor, model,
* MY_TYPE_CHILD_VIEW,
* "label", "text", G_BINDING_DEFAULT | G_BINDING_SYNC_CREATE,
@ -19635,12 +19637,12 @@ bind_child_with_properties (gpointer item,
* "selected", "selected", G_BINDING_BIDIRECTIONAL,
* "active", "active", G_BINDING_BIDIRECTIONAL,
* NULL);
* ]|
* ```
*
* is the equivalent of calling clutter_actor_bind_model() with a
* #ClutterActorCreateChildFunc of:
*
* |[<!-- language="C" -->
* ```c
* ClutterActor *res = g_object_new (MY_TYPE_CHILD_VIEW, NULL);
*
* g_object_bind_property (item, "label", res, "text", G_BINDING_DEFAULT | G_BINDING_SYNC_CREATE);
@ -19649,7 +19651,7 @@ bind_child_with_properties (gpointer item,
* g_object_bind_property (item, "active", res, "active", G_BINDING_BIDIRECTIONAL);
*
* return res;
* ]|
* ```
*
* If the #ClutterActor was already bound to a #GListModel, the previous
* binding is destroyed.

7
clutter/clutter/clutter-actor.h
View file

@ -118,12 +118,7 @@ typedef void (*ClutterCallback) (ClutterActor *actor,
*/
#define CLUTTER_CALLBACK(f) ((ClutterCallback) (f))
/**
* ClutterActor:
* @flags: #ClutterActorFlags
*
* Base class for actors.
*/
struct _ClutterActor
{
/*< private >*/

14
clutter/clutter/clutter-align-constraint.c
View file

@ -23,15 +23,15 @@
*/
/**
* SECTION:clutter-align-constraint
* @Title: ClutterAlignConstraint
* @Short_Description: A constraint aligning the position of an actor
* ClutterAlignConstraint:
*
* A constraint aligning the position of an actor
*
* #ClutterAlignConstraint is a #ClutterConstraint that aligns the position
* of the #ClutterActor to which it is applied to the size of another
* #ClutterActor using an alignment factor
* #ClutterAlignConstraint is a [class@Constraint] that aligns the position
* of the [class@Actor] to which it is applied to the size of another
* [class@Actor] using an alignment factor
*
* #ClutterAlignConstraint is available since Clutter 1.4
* Since: 1.4
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-align-constraint.h
View file

@ -37,14 +37,6 @@ G_BEGIN_DECLS
#define CLUTTER_ALIGN_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_ALIGN_CONSTRAINT, ClutterAlignConstraint))
#define CLUTTER_IS_ALIGN_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_ALIGN_CONSTRAINT))
/**
* ClutterAlignConstraint:
*
* #ClutterAlignConstraint is an opaque structure
* whose members cannot be directly accesses
*
* Since: 1.4
*/
typedef struct _ClutterAlignConstraint ClutterAlignConstraint;
typedef struct _ClutterAlignConstraintClass ClutterAlignConstraintClass;

15
clutter/clutter/clutter-animatable.c
View file

@ -23,18 +23,19 @@
*/
/**
* SECTION:clutter-animatable
* @short_description: Interface for animatable classes
* ClutterAnimatable:
*
* Interface for animatable classes
*
* #ClutterAnimatable is an interface that allows a #GObject class
* #ClutterAnimatable is an interface that allows a [class@GObject.Object] class
* to control how an actor will animate a property.
*
* Each #ClutterAnimatable should implement the
* #ClutterAnimatableInterface.interpolate_property() virtual function of the
* [vfunc@Animatable.interpolate_value] virtual function of the
* interface to compute the animation state between two values of an interval
* depending on a progress factor, expressed as a floating point value.
*
* #ClutterAnimatable is available since Clutter 1.0
* Since: 1.0
*/
#include "clutter-build-config.h"
@ -56,7 +57,7 @@ clutter_animatable_default_init (ClutterAnimatableInterface *iface)
* @animatable: a #ClutterAnimatable
* @property_name: the name of the animatable property to find
*
* Finds the #GParamSpec for @property_name
* Finds the [class@GObject.ParamSpec] for @property_name
*
* Return value: (transfer none): The #GParamSpec for the given property
* or %NULL
@ -156,7 +157,7 @@ clutter_animatable_set_final_state (ClutterAnimatable *animatable,
* value, and store the result inside @value.
*
* This function should be used for every property animation
* involving #ClutterAnimatable<!-- -->s.
* involving `ClutterAnimatable`s.
*
* This function replaces clutter_animatable_animate_property().
*

13
clutter/clutter/clutter-backend.c
View file

@ -25,8 +25,9 @@
*/
/**
* SECTION:clutter-backend
* @short_description: Backend abstraction
* ClutterBackend:
*
* Backend abstraction
*
* Clutter can be compiled against different backends. Each backend
* has to implement a set of functions, in order to be used by Clutter.
@ -35,7 +36,7 @@
* it provides a basic API to query the backend for generic information
* and settings.
*
* #ClutterBackend is available since Clutter 0.4
* Since: 0.4
*/
#include "clutter-build-config.h"
@ -376,7 +377,7 @@ clutter_backend_class_init (ClutterBackendClass *klass)
* ClutterBackend::resolution-changed:
* @backend: the #ClutterBackend that emitted the signal
*
* The ::resolution-changed signal is emitted each time the font
* The signal is emitted each time the font
* resolutions has been changed through #ClutterSettings.
*
* Since: 1.0
@ -393,7 +394,7 @@ clutter_backend_class_init (ClutterBackendClass *klass)
* ClutterBackend::font-changed:
* @backend: the #ClutterBackend that emitted the signal
*
* The ::font-changed signal is emitted each time the font options
* The signal is emitted each time the font options
* have been changed through #ClutterSettings.
*
* Since: 1.0
@ -410,7 +411,7 @@ clutter_backend_class_init (ClutterBackendClass *klass)
* ClutterBackend::settings-changed:
* @backend: the #ClutterBackend that emitted the signal
*
* The ::settings-changed signal is emitted each time the #ClutterSettings
* The signal is emitted each time the #ClutterSettings
* properties have been changed.
*
* Since: 1.4

8
clutter/clutter/clutter-backend.h
View file

@ -43,14 +43,6 @@ G_BEGIN_DECLS
#define CLUTTER_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BACKEND, ClutterBackend))
#define CLUTTER_IS_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BACKEND))
/**
* ClutterBackend:
*
* #ClutterBackend is an opaque structure whose
* members cannot be directly accessed.
*
* Since: 0.4
*/
typedef struct _ClutterBackend ClutterBackend;
typedef struct _ClutterBackendClass ClutterBackendClass;

7
clutter/clutter/clutter-bin-layout.c
View file

@ -23,8 +23,9 @@
*/
/**
* SECTION:clutter-bin-layout
* @short_description: A simple layout manager
* ClutterBinLayout:
*
* A simple layout manager
*
* #ClutterBinLayout is a layout manager which implements the following
* policy:
@ -40,7 +41,7 @@
* The [bin-layout example](https://git.gnome.org/browse/clutter/tree/examples/bin-layout.c?h=clutter-1.18)
* shows how to pack actors inside a #ClutterBinLayout.
*
* #ClutterBinLayout is available since Clutter 1.2
* Since: 1.2
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-bin-layout.h
View file

@ -44,14 +44,6 @@ typedef struct _ClutterBinLayout ClutterBinLayout;
typedef struct _ClutterBinLayoutPrivate ClutterBinLayoutPrivate;
typedef struct _ClutterBinLayoutClass ClutterBinLayoutClass;
/**
* ClutterBinLayout:
*
* The #ClutterBinLayout structure contains only private data
* and should be accessed using the provided API
*
* Since: 1.2
*/
struct _ClutterBinLayout
{
/*< private >*/

22
clutter/clutter/clutter-bind-constraint.c
View file

@ -23,20 +23,20 @@
*/
/**
* SECTION:clutter-bind-constraint
* @Title: ClutterBindConstraint
* @Short_Description: A constraint binding the position or size of an actor
* ClutterBindConstraint:
*
* A constraint binding the position or size of an actor
*
* #ClutterBindConstraint is a #ClutterConstraint that binds the
* position or the size of the #ClutterActor to which it is applied
* to the the position or the size of another #ClutterActor, or
* #ClutterBindConstraint is a [class@Constraint] that binds the
* position or the size of the [class@Actor] to which it is applied
* to the the position or the size of another [class@Actor], or
* "source".
*
* An offset can be applied to the constraint, to avoid overlapping. The offset
* can also be animated. For instance, the following code will set up three
* actors to be bound to the same origin:
*
* |[<!-- language="C" -->
* ```c
* // source
* rect[0] = clutter_actor_new ();
* clutter_actor_set_background_color (rect[0], &red_color);
@ -64,12 +64,12 @@
* clutter_actor_add_constraint_with_name (rect[2], "blue-x", constraint);
* constraint = clutter_bind_constraint_new (rect[0], CLUTTER_BIND_Y, 0.0);
* clutter_actor_add_constraint_with_name (rect[2], "blue-y", constraint);
* ]|
* ```
*
* The following code animates the second and third rectangles to "expand"
* them horizontally from underneath the first rectangle:
*
* |[<!-- language="C" -->
* ```c
* clutter_actor_animate (rect[1], CLUTTER_EASE_OUT_CUBIC, 250,
* "@constraints.green-x.offset", 100.0,
* "opacity", 255,
@ -78,9 +78,9 @@
* "@constraints.blue-x.offset", 200.0,
* "opacity", 255,
* NULL);
* ]|
* ```
*
* #ClutterBindConstraint is available since Clutter 1.4
* Since: 1.4
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-bind-constraint.h
View file

@ -37,14 +37,6 @@ G_BEGIN_DECLS
#define CLUTTER_BIND_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BIND_CONSTRAINT, ClutterBindConstraint))
#define CLUTTER_IS_BIND_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BIND_CONSTRAINT))
/**
* ClutterBindConstraint:
*
* #ClutterBindConstraint is an opaque structure
* whose members cannot be directly accessed
*
* Since: 1.4
*/
typedef struct _ClutterBindConstraint ClutterBindConstraint;
typedef struct _ClutterBindConstraintClass ClutterBindConstraintClass;

35
clutter/clutter/clutter-binding-pool.c
View file

@ -22,8 +22,9 @@
*/
/**
* SECTION:clutter-binding-pool
* @short_description: Pool for key bindings
* ClutterBindingPool
*
* Pool for key bindings
*
* #ClutterBindingPool is a data structure holding a set of key bindings.
* Each key binding associates a key symbol (eventually with modifiers)
@ -38,7 +39,7 @@
* inside their class initialization function and then install actions
* like this:
*
* |[<!-- language="C" -->
* ```c
* static void
* foo_class_init (FooClass *klass)
* {
@ -55,23 +56,23 @@
* G_CALLBACK (foo_action_move_up),
* NULL, NULL);
* }
* ]|
* ```
*
* The callback has a signature of:
*
* |[<!-- language="C" -->
* ```c
* gboolean (* callback) (GObject *instance,
* const gchar *action_name,
* guint key_val,
* ClutterModifierType modifiers,
* gpointer user_data);
* ]|
* ```
*
* The actor should then override the #ClutterActor::key-press-event and
* use clutter_binding_pool_activate() to match a #ClutterKeyEvent structure
* The actor should then override the [signal@Actor::key-press-event] and
* use [method@BindingPool.activate] to match a [struct@KeyEvent] structure
* to one of the actions:
*
* |[<!-- language="C" -->
* ```c
* ClutterBindingPool *pool;
*
* // retrieve the binding pool for the type of the actor
@ -84,14 +85,14 @@
* key_event->keyval,
* key_event->modifier_state,
* G_OBJECT (actor));
* ]|
* ```
*
* The clutter_binding_pool_activate() function will return %FALSE if
* The [method@BindingPool.activate] function will return %FALSE if
* no action for the given key binding was found, if the action was
* blocked (using clutter_binding_pool_block_action()) or if the
* blocked (using [method@BindingPool.block_action]) or if the
* key binding handler returned %FALSE.
*
* #ClutterBindingPool is available since Clutter 1.0
* Since: 1.0
*/
#include "clutter-build-config.h"
@ -382,9 +383,9 @@ clutter_binding_pool_new (const gchar *name)
* A binding pool for a class can also be retrieved using
* clutter_binding_pool_find() with the class type name:
*
* |[
* ```
* pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (instance));
* ]|
* ```
*
* Return value: (transfer none): the binding pool for the given class.
* The returned #ClutterBindingPool is owned by Clutter and should not
@ -832,13 +833,13 @@ clutter_binding_entry_invoke (ClutterBindingEntry *entry,
*
* The callback has the following signature:
*
* |[
* ```
* void (* callback) (GObject *gobject,
* const gchar *action_name,
* guint key_val,
* ClutterModifierType modifiers,
* gpointer user_data);
* ]|
* ```
*
* Where the #GObject instance is @gobject and the user data
* is the one passed when installing the action with

8
clutter/clutter/clutter-binding-pool.h
View file

@ -37,14 +37,6 @@ G_BEGIN_DECLS
#define CLUTTER_BINDING_POOL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BINDING_POOL, ClutterBindingPool))
#define CLUTTER_IS_BINDING_POOL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BINDING_POOL))
/**
* ClutterBindingPool:
*
* Container of key bindings. The #ClutterBindingPool struct is
* private.
*
* Since: 1.0
*/
typedef struct _ClutterBindingPool ClutterBindingPool;
typedef struct _ClutterBindingPoolClass ClutterBindingPoolClass;

8
clutter/clutter/clutter-blur-effect.c
View file

@ -23,14 +23,14 @@
*/
/**
* SECTION:clutter-blur-effect
* @short_description: A blur effect
* @see_also: #ClutterEffect, #ClutterOffscreenEffect
* ClutterBlurEffect:
*
* A blur effect
*
* #ClutterBlurEffect is a sub-class of #ClutterEffect that allows blurring a
* actor and its contents.
*
* #ClutterBlurEffect is available since Clutter 1.4
* Since: 1.4
*/
#define CLUTTER_BLUR_EFFECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_BLUR_EFFECT, ClutterBlurEffectClass))

8
clutter/clutter/clutter-blur-effect.h
View file

@ -37,14 +37,6 @@ G_BEGIN_DECLS
#define CLUTTER_BLUR_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BLUR_EFFECT, ClutterBlurEffect))
#define CLUTTER_IS_BLUR_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BLUR_EFFECT))
/**
* ClutterBlurEffect:
*
* #ClutterBlurEffect is an opaque structure
* whose members cannot be accessed directly
*
* Since: 1.4
*/
typedef struct _ClutterBlurEffect ClutterBlurEffect;
typedef struct _ClutterBlurEffectClass ClutterBlurEffectClass;

7
clutter/clutter/clutter-box-layout.c
View file

@ -26,8 +26,9 @@
*/
/**
* SECTION:clutter-box-layout
* @short_description: A layout manager arranging children on a single line
* ClutterBoxLayout:
*
* A layout manager arranging children on a single line
*
* The #ClutterBoxLayout is a #ClutterLayoutManager implementing the
* following layout policy:
@ -44,7 +45,7 @@
* It is possible to control the spacing between children of a
* #ClutterBoxLayout by using clutter_box_layout_set_spacing().
*
* #ClutterBoxLayout is available since Clutter 1.2
* Since: 1.2
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-box-layout.h
View file

@ -47,14 +47,6 @@ typedef struct _ClutterBoxLayout ClutterBoxLayout;
typedef struct _ClutterBoxLayoutPrivate ClutterBoxLayoutPrivate;
typedef struct _ClutterBoxLayoutClass ClutterBoxLayoutClass;
/**
* ClutterBoxLayout:
*
* The #ClutterBoxLayout structure contains only private data
* and should be accessed using the provided API
*
* Since: 1.2
*/
struct _ClutterBoxLayout
{
/*< private >*/

8
clutter/clutter/clutter-brightness-contrast-effect.c
View file

@ -23,14 +23,14 @@
*/
/**
* SECTION:clutter-brightness-contrast-effect
* @short_description: Increase/decrease brightness and/or contrast of actor.
* @see_also: #ClutterEffect, #ClutterOffscreenEffect
* ClutterBrightnessContrastEffect:
*
* Increase/decrease brightness and/or contrast of actor.
*
* #ClutterBrightnessContrastEffect is a sub-class of #ClutterEffect that
* changes the overall brightness of a #ClutterActor.
*
* #ClutterBrightnessContrastEffect is available since Clutter 1.10
* Since: 1.10
*/
#define CLUTTER_BRIGHTNESS_CONTRAST_EFFECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_BRIGHTNESS_CONTRAST_EFFECT, ClutterBrightnessContrastEffectClass))

8
clutter/clutter/clutter-brightness-contrast-effect.h
View file

@ -38,14 +38,6 @@ G_BEGIN_DECLS
#define CLUTTER_BRIGHTNESS_CONTRAST_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BRIGHTNESS_CONTRAST_EFFECT, ClutterBrightnessContrastEffect))
#define CLUTTER_IS_BRIGHTNESS_CONTRAST_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BRIGHTNESS_CONTRAST_EFFECT))
/**
* ClutterBrightnessContrastEffect:
*
* #ClutterBrightnessContrastEffect is an opaque structure
* whose members cannot be directly accessed
*
* Since: 1.10
*/
typedef struct _ClutterBrightnessContrastEffect ClutterBrightnessContrastEffect;
typedef struct _ClutterBrightnessContrastEffectClass ClutterBrightnessContrastEffectClass;

4
clutter/clutter/clutter-cairo.c
View file

@ -40,13 +40,13 @@
* Utility function for setting the source color of @cr using
* a #ClutterColor. This function is the equivalent of:
*
* |[
* ```c
* cairo_set_source_rgba (cr,
* color->red / 255.0,
* color->green / 255.0,
* color->blue / 255.0,
* color->alpha / 255.0);
* ]|
* ```
*
* Since: 1.0
*/

13
clutter/clutter/clutter-canvas.c
View file

@ -23,10 +23,9 @@
*/
/**
* SECTION:clutter-canvas
* @Title: ClutterCanvas
* @Short_Description: Content for 2D painting
* @See_Also: #ClutterContent
* ClutterCanvas:
*
* Content for 2D painting
*
* The #ClutterCanvas class is a #ClutterContent implementation that allows
* drawing using the Cairo API on a 2D surface.
@ -39,7 +38,7 @@
* See [canvas.c](https://git.gnome.org/browse/clutter/tree/examples/canvas.c?h=clutter-1.18)
* for an example of how to use #ClutterCanvas.
*
* #ClutterCanvas is available since Clutter 1.10.
* Since: 1.10.
*/
#include "clutter-build-config.h"
@ -575,10 +574,10 @@ clutter_canvas_invalidate_internal (ClutterCanvas *canvas,
* the size, you can use the return value of the function to conditionally
* call clutter_content_invalidate():
*
* |[
* ```c
* if (!clutter_canvas_set_size (canvas, width, height))
* clutter_content_invalidate (CLUTTER_CONTENT (canvas));
* ]|
* ```
*
* Return value: this function returns %TRUE if the size change
* caused a content invalidation, and %FALSE otherwise

9
clutter/clutter/clutter-canvas.h
View file

@ -44,15 +44,6 @@ typedef struct _ClutterCanvas ClutterCanvas;
typedef struct _ClutterCanvasPrivate ClutterCanvasPrivate;
typedef struct _ClutterCanvasClass ClutterCanvasClass;
/**
* ClutterCanvas:
*
* The #ClutterCanvas structure contains
* private data and should only be accessed using the provided
* API.
*
* Since: 1.10
*/
struct _ClutterCanvas
{
/*< private >*/

41
clutter/clutter/clutter-child-meta.c
View file

@ -25,16 +25,45 @@
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* SECTION:clutter-child-meta
* @short_description: Wrapper for actors inside a container
* ClutterChildMeta:
*
* Base interface for container specific state for child actors.
*
* A child data is meant to be used when you need to keep track
* of information about each individual child added to a container.
*
* #ClutterChildMeta is a wrapper object created by #ClutterContainer
* implementations in order to store child-specific data and properties.
* In order to use it you should create your own subclass of
* #ClutterChildMeta and set the #ClutterContainerIface child_meta_type
* interface member to your subclass type, like:
*
* A #ClutterChildMeta wraps a #ClutterActor inside a #ClutterContainer.
* ```c
* static void
* my_container_iface_init (ClutterContainerIface *iface)
* {
* // set the rest of the #ClutterContainer vtable
*
* #ClutterChildMeta is available since Clutter 0.8
* container_iface->child_meta_type = MY_TYPE_CHILD_META;
* }
* ```
*
* This will automatically create a #ClutterChildMeta of type
* `MY_TYPE_CHILD_META` for every actor that is added to the container.
*
* The child data for an actor can be retrieved using the
* clutter_container_get_child_meta() function.
*
* The properties of the data and your subclass can be manipulated with
* clutter_container_child_set() and clutter_container_child_get() which
* act like g_object_set() and g_object_get().
*
* You can provide hooks for your own storage as well as control the
* instantiation by overriding the #ClutterContainerIface virtual functions
* #ClutterContainerIface.create_child_meta(), #ClutterContainerIface.destroy_child_meta(),
* and #ClutterContainerIface.get_child_meta().
*
* Since: 0.8
*/
#include "clutter-build-config.h"

40
clutter/clutter/clutter-child-meta.h
View file

@ -46,46 +46,6 @@ G_BEGIN_DECLS
typedef struct _ClutterChildMetaClass ClutterChildMetaClass;
/**
* ClutterChildMeta:
* @container: the container handling this data
* @actor: the actor wrapped by this data
*
* Base interface for container specific state for child actors. A child
* data is meant to be used when you need to keep track of information
* about each individual child added to a container.
*
* In order to use it you should create your own subclass of
* #ClutterChildMeta and set the #ClutterContainerIface child_meta_type
* interface member to your subclass type, like:
*
* |[
* static void
* my_container_iface_init (ClutterContainerIface *iface)
* {
* // set the rest of the #ClutterContainer vtable
*
* container_iface->child_meta_type = MY_TYPE_CHILD_META;
* }
* ]|
*
* This will automatically create a #ClutterChildMeta of type
* `MY_TYPE_CHILD_META` for every actor that is added to the container.
*
* The child data for an actor can be retrieved using the
* clutter_container_get_child_meta() function.
*
* The properties of the data and your subclass can be manipulated with
* clutter_container_child_set() and clutter_container_child_get() which
* act like g_object_set() and g_object_get().
*
* You can provide hooks for your own storage as well as control the
* instantiation by overriding the #ClutterContainerIface virtual functions
* #ClutterContainerIface.create_child_meta(), #ClutterContainerIface.destroy_child_meta(),
* and #ClutterContainerIface.get_child_meta().
*
* Since: 0.8
*/
struct _ClutterChildMeta
{
/*< private >*/

77
clutter/clutter/clutter-click-action.c
View file

@ -23,39 +23,39 @@
*/
/**
* SECTION:clutter-click-action
* @Title: ClutterClickAction
* @Short_Description: Action for clickable actors
* ClutterClickAction:
*
* Action for clickable actors
*
* #ClutterClickAction is a sub-class of #ClutterAction that implements
* #ClutterClickAction is a sub-class of [class@Action] that implements
* the logic for clickable actors, by using the low level events of
* #ClutterActor, such as #ClutterActor::button-press-event and
* #ClutterActor::button-release-event, to synthesize the high level
* #ClutterClickAction::clicked signal.
* [class@Actor], such as [signal@Actor::button-press-event] and
* [signal@Actor::button-release-event], to synthesize the high level
* [signal@ClickAction::clicked] signal.
*
* To use #ClutterClickAction you just need to apply it to a #ClutterActor
* using clutter_actor_add_action() and connect to the
* #ClutterClickAction::clicked signal:
* To use #ClutterClickAction you just need to apply it to a [class@Actor]
* using [method@Actor.add_action] and connect to the
* [signal@ClickAction::clicked] signal:
*
* |[
* ```c
* ClutterAction *action = clutter_click_action_new ();
*
* clutter_actor_add_action (actor, action);
*
* g_signal_connect (action, "clicked", G_CALLBACK (on_clicked), NULL);
* ]|
* ```
*
* #ClutterClickAction also supports long press gestures: a long press is
* activated if the pointer remains pressed within a certain threshold (as
* defined by the #ClutterClickAction:long-press-threshold property) for a
* defined by the [property@ClickAction:long-press-threshold] property) for a
* minimum amount of time (as the defined by the
* #ClutterClickAction:long-press-duration property).
* The #ClutterClickAction::long-press signal is emitted multiple times,
* using different #ClutterLongPressState values; to handle long presses
* you should connect to the #ClutterClickAction::long-press signal and
* [property@ClickAction:long-press-duration] property).
* The [signal@ClickAction::long-press] signal is emitted multiple times,
* using different [enum@LongPressState] values; to handle long presses
* you should connect to the [signal@ClickAction::long-press] signal and
* handle the different states:
*
* |[
* ```c
* static gboolean
* on_long_press (ClutterClickAction *action,
* ClutterActor *actor,
@ -64,32 +64,29 @@
* switch (state)
* {
* case CLUTTER_LONG_PRESS_QUERY:
* /&ast; return TRUE if the actor should support long press
* &ast; gestures, and FALSE otherwise; this state will be
* &ast; emitted on button presses
* &ast;/
* // return TRUE if the actor should support long press
* // gestures, and FALSE otherwise; this state will be
* // emitted on button presses
* return TRUE;
*
* case CLUTTER_LONG_PRESS_ACTIVATE:
* /&ast; this state is emitted if the minimum duration has
* &ast; been reached without the gesture being cancelled.
* &ast; the return value is not used
* &ast;/
* // this state is emitted if the minimum duration has
* // been reached without the gesture being cancelled.
* // the return value is not used
* return TRUE;
*
* case CLUTTER_LONG_PRESS_CANCEL:
* /&ast; this state is emitted if the long press was cancelled;
* &ast; for instance, the pointer went outside the actor or the
* &ast; allowed threshold, or the button was released before
* &ast; the minimum duration was reached. the return value is
* &ast; not used
* &ast;/
* // this state is emitted if the long press was cancelled;
* // for instance, the pointer went outside the actor or the
* // allowed threshold, or the button was released before
* // the minimum duration was reached. the return value is
* // not used
* return FALSE;
* }
* }
* ]|
* ```
*
* #ClutterClickAction is available since Clutter 1.4
* Since: 1.4
*/
#include "clutter-build-config.h"
@ -578,7 +575,7 @@ clutter_click_action_class_init (ClutterClickActionClass *klass)
* press gesture, in milliseconds.
*
* A value of -1 will make the #ClutterClickAction use the value of
* the #ClutterSettings:long-press-duration property.
* the [property@Settings:long-press-duration] property.
*
* Since: 1.8
*/
@ -597,7 +594,7 @@ clutter_click_action_class_init (ClutterClickActionClass *klass)
* a long press gesture is cancelled, in pixels.
*
* A value of -1 will make the #ClutterClickAction use the value of
* the #ClutterSettings:dnd-drag-threshold property.
* the [property@Settings:dnd-drag-threshold] property.
*
* Since: 1.8
*/
@ -618,7 +615,7 @@ clutter_click_action_class_init (ClutterClickActionClass *klass)
* @action: the #ClutterClickAction that emitted the signal
* @actor: the #ClutterActor attached to the @action
*
* The ::clicked signal is emitted when the #ClutterActor to which
* The signal is emitted when the [class@Actor] to which
* a #ClutterClickAction has been applied should respond to a
* pointer button press and release events
*
@ -639,7 +636,7 @@ clutter_click_action_class_init (ClutterClickActionClass *klass)
* @actor: the #ClutterActor attached to the @action
* @state: the long press state
*
* The ::long-press signal is emitted during the long press gesture
* The signal is emitted during the long press gesture
* handling.
*
* This signal can be emitted multiple times with different states.
@ -653,7 +650,7 @@ clutter_click_action_class_init (ClutterClickActionClass *klass)
* %CLUTTER_LONG_PRESS_CANCEL state if the long press was cancelled.
*
* It is possible to forcibly cancel a long press detection using
* clutter_click_action_release().
* [method@ClickAction.release].
*
* Return value: Only the %CLUTTER_LONG_PRESS_QUERY state uses the
* returned value of the handler; other states will ignore it
@ -702,7 +699,7 @@ clutter_click_action_new (void)
* @action: a #ClutterClickAction
*
* Emulates a release of the pointer button, which ungrabs the pointer
* and unsets the #ClutterClickAction:pressed state.
* and unsets the [property@ClickAction:pressed] state.
*
* This function will also cancel the long press gesture if one was
* initiated.

7
clutter/clutter/clutter-clone.c
View file

@ -22,8 +22,9 @@
*/
/**
* SECTION:clutter-clone
* @short_description: An actor that displays a clone of a source actor
* ClutterClone:
*
* An actor that displays a clone of a source actor
*
* #ClutterClone is a #ClutterActor which draws with the paint
* function of another actor, scaled to fit its own allocation.
@ -34,7 +35,7 @@
* the presence of support for FBOs in the underlying GL or GLES
* implementation.
*
* #ClutterClone is available since Clutter 1.0
* Since: 1.0
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-clone.h
View file

@ -43,14 +43,6 @@ 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 >*/

24
clutter/clutter/clutter-color.c
View file

@ -21,18 +21,6 @@
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* SECTION:clutter-color
* @short_description: Color management and manipulation.
*
* #ClutterColor is a simple type for representing colors in Clutter.
*
* A #ClutterColor is expressed as a 4-tuple of values ranging from
* zero to 255, one for each color channel plus one for the alpha.
*
* The alpha channel is fully opaque at 255 and fully transparent at 0.
*/
#include "clutter-build-config.h"
#include <math.h>
@ -803,10 +791,10 @@ clutter_color_to_string (const ClutterColor *color)
* @v1: (type Clutter.Color): a #ClutterColor
* @v2: (type Clutter.Color): a #ClutterColor
*
* Compares two #ClutterColor<!-- -->s and checks if they are the same.
* Compares two `ClutterColor`s and checks if they are the same.
*
* This function can be passed to g_hash_table_new() as the @key_equal_func
* parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
* parameter, when using `ClutterColor`s as keys in a #GHashTable.
*
* Return value: %TRUE if the two colors are the same.
*
@ -840,7 +828,7 @@ clutter_color_equal (gconstpointer v1,
* Converts a #ClutterColor to a hash value.
*
* This function can be passed to g_hash_table_new() as the @hash_func
* parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
* parameter, when using `ClutterColor`s as keys in a #GHashTable.
*
* Return value: a hash value corresponding to the color
*
@ -859,7 +847,7 @@ clutter_color_hash (gconstpointer v)
* @progress: the interpolation progress
* @result: (out): return location for the interpolation
*
* Interpolates between @initial and @final #ClutterColor<!-- -->s
* Interpolates between @initial and @final `ClutterColor`s
* using @progress
*
* Since: 1.6
@ -942,9 +930,9 @@ clutter_color_free (ClutterColor *color)
*
* This function is the equivalent of:
*
* |[
* ```c
* clutter_color_init (clutter_color_alloc (), red, green, blue, alpha);
* ]|
* ```
*
* Return value: (transfer full): the newly allocated color.
* Use clutter_color_free() when done

9
clutter/clutter/clutter-color.h
View file

@ -43,7 +43,12 @@ G_BEGIN_DECLS
* @blue: blue component, between 0 and 255
* @alpha: alpha component, between 0 and 255
*
* Color representation.
* A simple type for representing colors.
*
* A #ClutterColor is expressed as a 4-tuple of values ranging from
* zero to 255, one for each color channel plus one for the alpha.
*
* The alpha channel is fully opaque at 255 and fully transparent at 0.
*/
struct _ClutterColor
{
@ -151,7 +156,7 @@ void clutter_color_interpolate (const ClutterColor *initial,
* CLUTTER_VALUE_HOLDS_COLOR:
* @x: a #GValue
*
* Evaluates to %TRUE if @x holds a #ClutterColor<!-- -->.
* Evaluates to %TRUE if @x holds a `ClutterColor`.
*
* Since: 1.0
*/

8
clutter/clutter/clutter-colorize-effect.c
View file

@ -23,14 +23,14 @@
*/
/**
* SECTION:clutter-colorize-effect
* @short_description: A colorization effect
* @see_also: #ClutterEffect, #ClutterOffscreenEffect
* ClutterColorizeEffect:
*
* A colorization effect
*
* #ClutterColorizeEffect is a sub-class of #ClutterEffect that
* colorizes an actor with the given tint.
*
* #ClutterColorizeEffect is available since Clutter 1.4
* Since: 1.4
*/
#define CLUTTER_COLORIZE_EFFECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_COLORIZE_EFFECT, ClutterColorizeEffectClass))

8
clutter/clutter/clutter-colorize-effect.h
View file

@ -38,14 +38,6 @@ G_BEGIN_DECLS
#define CLUTTER_COLORIZE_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_COLORIZE_EFFECT, ClutterColorizeEffect))
#define CLUTTER_IS_COLORIZE_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_COLORIZE_EFFECT))
/**
* ClutterColorizeEffect:
*
* #ClutterColorizeEffect is an opaque structure
* whose members cannot be directly accessed
*
* Since: 1.4
*/
typedef struct _ClutterColorizeEffect ClutterColorizeEffect;
typedef struct _ClutterColorizeEffectClass ClutterColorizeEffectClass;

11
clutter/clutter/clutter-constraint.c
View file

@ -23,10 +23,9 @@
*/
/**
* SECTION:clutter-constraint
* @Title: ClutterConstraint
* @Short_Description: Abstract class for constraints on position or size
* @See_Also: #ClutterAction
* ClutterConstraint:
*
* Abstract class for constraints on position or size
*
* #ClutterConstraint is a base abstract class for modifiers of a #ClutterActor
* position or size.
@ -37,8 +36,6 @@
* allocation of the actor to which they are applied by overriding the
* #ClutterConstraintClass.update_allocation() virtual function.
*
* #ClutterConstraint is available since Clutter 1.4
*
* ## Using Constraints
*
* Constraints can be used with fixed layout managers, like
@ -126,6 +123,8 @@
* call clutter_actor_queue_relayout() on the actor to which it is attached
* to whenever any parameter is changed. The actor to which it is attached
* can be recovered at any point using clutter_actor_meta_get_actor().
*
* Since: 1.4
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-constraint.h
View file

@ -42,14 +42,6 @@ G_BEGIN_DECLS
typedef struct _ClutterConstraintClass ClutterConstraintClass;
/**
* ClutterConstraint:
*
* The #ClutterConstraint structure contains only
* private data and should be accessed using the provided API
*
* Since: 1.4
*/
struct _ClutterConstraint
{
/*< private >*/

32
clutter/clutter/clutter-container.c
View file

@ -63,20 +63,16 @@
} G_STMT_END
/**
* SECTION:clutter-container
* @short_description: An interface for container actors
* ClutterContainer:
*
* An interface for container actors
*
* #ClutterContainer is an interface implemented by #ClutterActor, and
* #ClutterContainer is an interface implemented by [class@Actor], and
* it provides some common API for notifying when a child actor is added
* or removed, as well as the infrastructure for accessing child properties
* through #ClutterChildMeta.
*
* Until Clutter 1.10, the #ClutterContainer interface was also the public
* API for implementing container actors; this part of the interface has
* been deprecated: #ClutterContainer has a default implementation which
* defers to #ClutterActor the child addition and removal, as well as the
* iteration. See the documentation of #ClutterContainerIface for the list
* of virtual functions that should be overridden.
* through [class@ChildMeta].
*
* Since: 0.4
*/
enum
@ -132,7 +128,7 @@ clutter_container_default_init (ClutterContainerInterface *iface)
* @container: the actor which received the signal
* @actor: the new child that has been added to @container
*
* The ::actor-added signal is emitted each time an actor
* The signal is emitted each time an actor
* has been added to @container.
*
* Since: 0.4
@ -150,7 +146,7 @@ clutter_container_default_init (ClutterContainerInterface *iface)
* @container: the actor which received the signal
* @actor: the child that has been removed from @container
*
* The ::actor-removed signal is emitted each time an actor
* The signal is emitted each time an actor
* is removed from @container.
*
* Since: 0.4
@ -170,7 +166,7 @@ clutter_container_default_init (ClutterContainerInterface *iface)
* @actor: the child that has had a property set
* @pspec: (type GParamSpec): the #GParamSpec of the property set
*
* The ::child-notify signal is emitted each time a property is
* The signal is emitted each time a property is
* being set through the clutter_container_child_set() and
* clutter_container_child_set_property() calls.
*
@ -301,7 +297,7 @@ container_remove_valist (ClutterContainer *container,
* @first_actor: the first #ClutterActor to add
* @...: %NULL terminated list of actors to add
*
* Adds a list of #ClutterActor<!-- -->s to @container. Each time and
* Adds a list of `ClutterActor`s to @container. Each time and
* actor is added, the "actor-added" signal is emitted. Each actor should
* be parented to @container, which takes a reference on the actor. You
* cannot add a #ClutterActor to more than one #ClutterContainer.
@ -363,7 +359,7 @@ clutter_container_add_actor (ClutterContainer *container,
* @first_actor: first #ClutterActor to remove
* @...: a %NULL-terminated list of actors to remove
*
* Removes a %NULL terminated list of #ClutterActor<!-- -->s from
* Removes a %NULL terminated list of `ClutterActor`s from
* @container. Each actor should be unparented, so if you want to keep it
* around you must hold a reference to it yourself, using g_object_ref().
* Each time an actor is removed, the "actor-removed" signal is
@ -541,7 +537,7 @@ destroy_child_meta (ClutterContainer *container,
*
* Return value: (transfer none): the #ClutterChildMeta for the @actor child
* of @container or %NULL if the specifiec actor does not exist or the
* container is not configured to provide #ClutterChildMeta<!-- -->s
* container is not configured to provide `ClutterChildMeta`s
*
* Since: 0.8
*/
@ -678,7 +674,7 @@ clutter_container_class_find_child_property (GObjectClass *klass,
* Returns an array of #GParamSpec for all child properties.
*
* Return value: (array length=n_properties) (transfer full): an array
* of #GParamSpec<!-- -->s which should be freed after use.
* of `GParamSpec`s which should be freed after use.
*
* Since: 0.8
*/

9
clutter/clutter/clutter-container.h
View file

@ -44,15 +44,6 @@ G_BEGIN_DECLS
typedef struct _ClutterContainerIface ClutterContainerIface;
/**
* ClutterContainer:
*
* #ClutterContainer is an opaque structure whose members cannot be directly
* accessed
*
* Since: 0.4
*/
/**
* ClutterContainerIface:
* @add: virtual function for adding an actor to the container. This virtual

10
clutter/clutter/clutter-content.c
View file

@ -23,17 +23,17 @@
*/
/**
* SECTION:clutter-content
* @Title: ClutterContent
* @Short_Description: Delegate for painting the content of an actor
* ClutterContent:
*
* Delegate for painting the content of an actor
*
* #ClutterContent is an interface to implement types responsible for
* painting the content of a #ClutterActor.
* painting the content of a [class@Actor].
*
* Multiple actors can use the same #ClutterContent instance, in order
* to share the resources associated with painting the same content.
*
* #ClutterContent is available since Clutter 1.10.
* Since: 1.10.
*/
#include "clutter-build-config.h"

13
clutter/clutter/clutter-deform-effect.c
View file

@ -26,10 +26,9 @@
*/
/**
* SECTION:clutter-deform-effect
* @Title: ClutterDeformEffect
* @Short_Description: A base class for effects deforming the geometry
* of an actor
* ClutterDeformEffect:
*
* A base class for effects deforming the geometry of an actor
*
* #ClutterDeformEffect is an abstract class providing all the plumbing
* for creating effects that result in the deformation of an actor's
@ -39,8 +38,6 @@
* a #ClutterActor and then the Cogl vertex buffers API to submit the
* geometry to the GPU.
*
* #ClutterDeformEffect is available since Clutter 1.4
*
* ## Implementing ClutterDeformEffect
*
* Sub-classes of #ClutterDeformEffect should override the
@ -49,6 +46,8 @@
* Each passed vertex is an in-out parameter that initially contains the
* position of the vertex and should be modified according to a specific
* deformation algorithm.
*
* Since: 1.4
*/
#include "clutter-build-config.h"
@ -803,7 +802,7 @@ clutter_deform_effect_get_n_tiles (ClutterDeformEffect *effect,
* clutter_deform_effect_invalidate:
* @effect: a #ClutterDeformEffect
*
* Invalidates the @effect<!-- -->'s vertices and, if it is associated
* Invalidates the `effect`'s vertices and, if it is associated
* to an actor, it will queue a redraw
*
* Since: 1.4

8
clutter/clutter/clutter-deform-effect.h
View file

@ -45,14 +45,6 @@ typedef struct _ClutterDeformEffect ClutterDeformEffect;
typedef struct _ClutterDeformEffectPrivate ClutterDeformEffectPrivate;
typedef struct _ClutterDeformEffectClass ClutterDeformEffectClass;
/**
* ClutterDeformEffect:
*
* The #ClutterDeformEffect structure contains
* only private data and should be accessed using the provided API
*
* Since: 1.4
*/
struct _ClutterDeformEffect
{
/*< private >*/

8
clutter/clutter/clutter-desaturate-effect.c
View file

@ -23,16 +23,16 @@
*/
/**
* SECTION:clutter-desaturate-effect
* @short_description: A desaturation effect
* @see_also: #ClutterEffect, #ClutterOffscreenEffect
* ClutterDesaturateEffect:
*
* A desaturation effect
*
* #ClutterDesaturateEffect is a sub-class of #ClutterEffect that
* desaturates the color of an actor and its contents. The strength
* of the desaturation effect is controllable and animatable through
* the #ClutterDesaturateEffect:factor property.
*
* #ClutterDesaturateEffect is available since Clutter 1.4
* Since: 1.4
*/
#define CLUTTER_DESATURATE_EFFECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_DESATURATE_EFFECT, ClutterDesaturateEffectClass))

8
clutter/clutter/clutter-desaturate-effect.h
View file

@ -37,14 +37,6 @@ G_BEGIN_DECLS
#define CLUTTER_DESATURATE_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_DESATURATE_EFFECT, ClutterDesaturateEffect))
#define CLUTTER_IS_DESATURATE_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_DESATURATE_EFFECT))
/**
* ClutterDesaturateEffect:
*
* #ClutterDesaturateEffect is an opaque structure
* whose members cannot be directly accessed
*
* Since: 1.4
*/
typedef struct _ClutterDesaturateEffect ClutterDesaturateEffect;
typedef struct _ClutterDesaturateEffectClass ClutterDesaturateEffectClass;

15
clutter/clutter/clutter-effect.c
View file

@ -23,8 +23,9 @@
*/
/**
* SECTION:clutter-effect
* @short_description: Base class for actor effects
* ClutterEffect:
*
* Base class for actor effects
*
* The #ClutterEffect class provides a default type and API for creating
* effects for generic actors.
@ -42,7 +43,7 @@
* #ClutterEffectClass.paint() method. The implementation of the function should look
* something like this:
*
* |[
* ```c
* void effect_paint (ClutterEffect *effect, ClutterEffectPaintFlags flags)
* {
* // Set up initialisation of the paint such as binding a
@ -58,7 +59,7 @@
*
* // perform any cleanup of state, such as popping the CoglOffscreen
* }
* ]|
* ```
*
* The effect can optionally avoid calling clutter_actor_continue_paint() to skip any
* further stages of the paint sequence. This is useful for example if the effect
@ -79,7 +80,7 @@
* will paint the first material using cogl_rectangle(), before continuing and then it
* will paint paint the second material after.
*
* |[
* ```c
* typedef struct {
* ClutterEffect parent_instance;
*
@ -155,9 +156,9 @@
*
* klass->paint = my_effect_paint;
* }
* ]|
* ```
*
* #ClutterEffect is available since Clutter 1.4
* Since: 1.4
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-effect.h
View file

@ -44,14 +44,6 @@ G_BEGIN_DECLS
typedef struct _ClutterEffectClass ClutterEffectClass;
/**
* ClutterEffect:
*
* The #ClutterEffect structure contains only private data and should
* be accessed using the provided API
*
* Since: 1.4
*/
struct _ClutterEffect
{
/*< private >*/

37
clutter/clutter/clutter-enums.h
View file

@ -43,9 +43,11 @@ G_BEGIN_DECLS
* @CLUTTER_GRAVITY_NORTH_WEST: Scale from the top left corner
* @CLUTTER_GRAVITY_CENTER: Scale from the center.
*
* Gravity of the scaling operations. When a gravity different than
* %CLUTTER_GRAVITY_NONE is used, an actor is scaled keeping the position
* of the specified portion at the same coordinates.
* Gravity of the scaling operations.
*
* When a gravity different than %CLUTTER_GRAVITY_NONE is used,
* an actor is scaled keeping the position of the specified portion
* at the same coordinates.
*
* Since: 0.2
*
@ -190,8 +192,9 @@ typedef enum /*< prefix=CLUTTER_REQUEST >*/
* @CLUTTER_ANIMATION_LAST: last animation mode, used as a guard for
* registered global alpha functions
*
* The animation modes used by #ClutterAnimatable. This
* enumeration can be expanded in later versions of Clutter.
* The animation modes used by [iface@Animatable].
*
* This enumeration can be expanded in later versions of Clutter.
*
* <figure id="easing-modes">
* <title>Easing modes provided by Clutter</title>
@ -284,7 +287,7 @@ typedef enum
* @CLUTTER_TEXT_DIRECTION_LTR: Use left-to-right text direction
* @CLUTTER_TEXT_DIRECTION_RTL: Use right-to-left text direction
*
* The text direction to be used by #ClutterActor<!-- -->s
* The text direction to be used by [class@Actor]s
*
* Since: 1.2
*/
@ -1338,8 +1341,8 @@ typedef enum
* mipmap generation; this filter linearly interpolates on every axis,
* as well as between mipmap levels.
*
* The scaling filters to be used with the #ClutterActor:minification-filter
* and #ClutterActor:magnification-filter properties.
* The scaling filters to be used with the [property@Actor:minification-filter]
* and [property@Actor:magnification-filter] properties.
*
* Since: 1.10
*/
@ -1472,7 +1475,7 @@ typedef enum
* the gesture must begin immediately and that it must be cancelled
* once the drag exceed the configured threshold.
*
* Enum passed to the clutter_gesture_action_set_threshold_trigger_edge()
* Enum passed to the [method@GestureAction.set_threshold_trigger_edge]
* function.
*
* Since: 1.18
@ -1493,9 +1496,11 @@ typedef enum
* @CLUTTER_TOUCHPAD_GESTURE_PHASE_CANCEL: The gesture was cancelled, all
* changes should be undone.
*
* The phase of a touchpad gesture event. All gestures are guaranteed to
* begin with an event of type %CLUTTER_TOUCHPAD_GESTURE_PHASE_BEGIN,
* followed by a number of %CLUTTER_TOUCHPAD_GESTURE_PHASE_UPDATE (possibly 0).
* The phase of a touchpad gesture event.
*
* All gestures are guaranteed to begin with an event of type
* %CLUTTER_TOUCHPAD_GESTURE_PHASE_BEGIN, followed by a number
* of %CLUTTER_TOUCHPAD_GESTURE_PHASE_UPDATE (possibly 0).
*
* A finished gesture may have 2 possible outcomes, an event with phase
* %CLUTTER_TOUCHPAD_GESTURE_PHASE_END will be emitted when the gesture is
@ -1531,9 +1536,10 @@ typedef enum
* @CLUTTER_SCROLL_SOURCE_CONTINUOUS: The scroll event is originated by the
* motion of some device (eg. a scroll button is set).
*
* The scroll source determines the source of the scroll event. Keep in mind
* that the source device #ClutterInputDeviceType is not enough to infer
* the scroll source.
* The scroll source determines the source of the scroll event.
*
* Keep in mind that the source device #ClutterInputDeviceType is not enough
* to infer the scroll source.
*
* Since: 1.26
*/
@ -1552,6 +1558,7 @@ typedef enum
* @CLUTTER_SCROLL_FINISHED_VERTICAL: The vertical axis stopped.
*
* Flags used to notify the axes that were stopped in a #ClutterScrollEvent.
*
* These can be used to trigger post-scroll effects like kinetic scrolling.
*
* Since: 1.26

10
clutter/clutter/clutter-event.c
View file

@ -33,16 +33,6 @@
#include <math.h>
/**
* SECTION:clutter-event
* @short_description: User and window system events
*
* Windowing events handled by Clutter.
*
* The events usually come from the windowing backend, but can also
* be synthesized by Clutter itself or by the application code.
*/
typedef struct _ClutterEventPrivate {
ClutterEvent base;

20
clutter/clutter/clutter-event.h
View file

@ -412,8 +412,9 @@ struct _ClutterTouchEvent
* represented by positive deltas
* @scale: the current scale
*
* Used for touchpad pinch gesture events. The current state of the
* gesture will be determined by the @phase field.
* Used for touchpad pinch gesture events.
*
* The current state of the gesture will be determined by the @phase field.
*
* Each event with phase %CLUTTER_TOUCHPAD_GESTURE_PHASE_BEGIN
* will report a @scale of 1.0, all later phases in the gesture
@ -459,8 +460,9 @@ struct _ClutterTouchpadPinchEvent
* @dy_unaccel: unaccelerated movement delta of the swipe center
* point in the Y axis
*
* Used for touchpad swipe gesture events. The current state of the
* gesture will be determined by the @phase field.
* Used for touchpad swipe gesture events.
*
* The current state of the gesture will be determined by the @phase field.
*
* Since: 1.24
*/
@ -493,8 +495,9 @@ struct _ClutterTouchpadSwipeEvent
* @x: the X coordinate of the pointer, relative to the stage
* @y: the Y coordinate of the pointer, relative to the stage
*
* Used for touchpad hold gesture events. The current state of the
* gesture will be determined by the @phase field.
* Used for touchpad hold gesture events.
*
* The current state of the gesture will be determined by the @phase field.
*
* A hold gesture starts when the user places one or many fingers on the
* touchpad and ends when all fingers are lifted. It is cancelled when the
@ -586,8 +589,11 @@ struct _ClutterIMEvent
/**
* ClutterEvent:
*
* Generic event wrapper.
* User and window system events
*
* The events usually come from the windowing backend, but can also
* be synthesized by Clutter itself or by the application code.
*
* Since: 0.2
*/
union _ClutterEvent

7
clutter/clutter/clutter-fixed-layout.c
View file

@ -25,13 +25,14 @@
*/
/**
* SECTION:clutter-fixed-layout
* @short_description: A fixed layout manager
* ClutterFixedLayout:
*
* A fixed layout manager
*
* #ClutterFixedLayout is a layout manager implementing the same
* layout policies as #ClutterGroup.
*
* #ClutterFixedLayout is available since Clutter 1.2
* Since: 1.2
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-fixed-layout.h
View file

@ -43,14 +43,6 @@ G_BEGIN_DECLS
typedef struct _ClutterFixedLayout ClutterFixedLayout;
typedef struct _ClutterFixedLayoutClass ClutterFixedLayoutClass;
/**
* ClutterFixedLayout:
*
* The #ClutterFixedLayout structure contains only private data and
* it should be accessed using the provided API
*
* Since: 1.2
*/
struct _ClutterFixedLayout
{
/*< private >*/

7
clutter/clutter/clutter-flow-layout.c
View file

@ -23,8 +23,9 @@
*/
/**
* SECTION:clutter-flow-layout
* @short_description: A reflowing layout manager
* ClutterFlowLayout:
*
* A reflowing layout manager
*
* #ClutterFlowLayout is a layout manager which implements the following
* policy:
@ -49,7 +50,7 @@
* The [flow-layout example](https://git.gnome.org/browse/clutter/tree/examples/flow-layout.c?h=clutter-1.18)
* shows how to use the #ClutterFlowLayout.
*
* #ClutterFlowLayout is available since Clutter 1.2
* Since: 1.2
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-flow-layout.h
View file

@ -44,14 +44,6 @@ typedef struct _ClutterFlowLayout ClutterFlowLayout;
typedef struct _ClutterFlowLayoutPrivate ClutterFlowLayoutPrivate;
typedef struct _ClutterFlowLayoutClass ClutterFlowLayoutClass;
/**
* ClutterFlowLayout:
*
* The #ClutterFlowLayout structure contains only private data
* and should be accessed using the provided API
*
* Since: 1.2
*/
struct _ClutterFlowLayout
{
/*< private >*/

66
clutter/clutter/clutter-gesture-action.c
View file

@ -25,20 +25,20 @@
*/
/**
* SECTION:clutter-gesture-action
* @Title: ClutterGestureAction
* @Short_Description: Action for gesture gestures
* ClutterGestureAction:
*
* Action for gesture gestures
*
* #ClutterGestureAction is a sub-class of #ClutterAction that implements
* #ClutterGestureAction is a sub-class of [class@Action] that implements
* the logic for recognizing gesture gestures. It listens for low level events
* such as #ClutterButtonEvent and #ClutterMotionEvent on the stage to raise
* the #ClutterGestureAction::gesture-begin, #ClutterGestureAction::gesture-progress,
* and #ClutterGestureAction::gesture-end signals.
* such as [struct@ButtonEvent] and [struct@MotionEvent] on the stage to raise
* the [signal@GestureAction::gesture-begin], [signal@GestureAction::gesture-progress],
* and [signal@GestureAction::gesture-end] signals.
*
* To use #ClutterGestureAction you just need to apply it to a #ClutterActor
* using clutter_actor_add_action() and connect to the signals:
* To use #ClutterGestureAction you just need to apply it to a [class@Actor]
* using [method@Actor.add_action] and connect to the signals:
*
* |[<!-- language="C" -->
* ```c
* ClutterAction *action = clutter_gesture_action_new ();
*
* clutter_actor_add_action (actor, action);
@ -46,7 +46,7 @@
* g_signal_connect (action, "gesture-begin", G_CALLBACK (on_gesture_begin), NULL);
* g_signal_connect (action, "gesture-progress", G_CALLBACK (on_gesture_progress), NULL);
* g_signal_connect (action, "gesture-end", G_CALLBACK (on_gesture_end), NULL);
* ]|
* ```
*
* ## Creating Gesture actions
*
@ -60,13 +60,13 @@
* - Prepare -> Begin -> Progress -> End
*
* Each #ClutterGestureAction starts in the "prepare" state, and calls
* the #ClutterGestureActionClass.gesture_prepare() virtual function; this
* the [vfunc@GestureAction.gesture_prepare] virtual function; this
* state can be used to reset the internal state of a #ClutterGestureAction
* subclass, but it can also immediately cancel a gesture without going
* through the rest of the states.
*
* The "begin" state follows the "prepare" state, and calls the
* #ClutterGestureActionClass.gesture_begin() virtual function. This state
* [vfunc@GestureAction.gesture_begin] virtual function. This state
* signals the start of a gesture recognizing process. From the "begin" state
* the gesture recognition process can successfully end, by going to the
* "end" state; it can continue in the "progress" state, in case of a
@ -74,7 +74,7 @@
* state.
*
* In case of continuous gestures, the #ClutterGestureAction will use
* the "progress" state, calling the #ClutterGestureActionClass.gesture_progress()
* the "progress" state, calling the [vfunc@GestureAction.gesture_progress]
* virtual function; the "progress" state will continue until the end of the
* gesture, in which case the "end" state will be reached, or until the
* gesture is cancelled, in which case the "cancel" gesture will be used
@ -665,8 +665,8 @@ clutter_gesture_action_class_init (ClutterGestureActionClass *klass)
* ClutterGestureAction:threshold-trigger-edge:
*
* The trigger edge to be used by the action to either emit the
* #ClutterGestureAction::gesture-begin signal or to emit the
* #ClutterGestureAction::gesture-cancel signal.
* [signal@GestureAction::gesture-begin] signal or to emit the
* [signal@GestureAction::gesture-cancel] signal.
*
* Since: 1.18
*/
@ -683,8 +683,8 @@ clutter_gesture_action_class_init (ClutterGestureActionClass *klass)
* ClutterGestureAction:threshold-trigger-distance-x:
*
* The horizontal trigger distance to be used by the action to either
* emit the #ClutterGestureAction::gesture-begin signal or to emit
* the #ClutterGestureAction::gesture-cancel signal.
* emit the [signal@GestureAction::gesture-begin] signal or to emit
* the [signal@GestureAction::gesture-cancel] signal.
*
* A negative value will be interpreted as the default drag threshold.
*
@ -702,8 +702,8 @@ clutter_gesture_action_class_init (ClutterGestureActionClass *klass)
* ClutterGestureAction:threshold-trigger-distance-y:
*
* The vertical trigger distance to be used by the action to either
* emit the #ClutterGestureAction::gesture-begin signal or to emit
* the #ClutterGestureAction::gesture-cancel signal.
* emit the [signal@GestureAction::gesture-begin] signal or to emit
* the [signal@GestureAction::gesture-cancel] signal.
*
* A negative value will be interpreted as the default drag threshold.
*
@ -726,7 +726,7 @@ clutter_gesture_action_class_init (ClutterGestureActionClass *klass)
* @action: the #ClutterGestureAction that emitted the signal
* @actor: the #ClutterActor attached to the @action
*
* The ::gesture_begin signal is emitted when the #ClutterActor to which
* The signal is emitted when the [class@Actor] to which
* a #ClutterGestureAction has been applied starts receiving a gesture.
*
* Return value: %TRUE if the gesture should start, and %FALSE if
@ -749,8 +749,8 @@ clutter_gesture_action_class_init (ClutterGestureActionClass *klass)
* @action: the #ClutterGestureAction that emitted the signal
* @actor: the #ClutterActor attached to the @action
*
* The ::gesture-progress signal is emitted for each motion event after
* the #ClutterGestureAction::gesture-begin signal has been emitted.
* The signal is emitted for each motion event after
* the [signal@GestureAction::gesture-begin] signal has been emitted.
*
* Return value: %TRUE if the gesture should continue, and %FALSE if
* the gesture should be cancelled.
@ -772,10 +772,10 @@ clutter_gesture_action_class_init (ClutterGestureActionClass *klass)
* @action: the #ClutterGestureAction that emitted the signal
* @actor: the #ClutterActor attached to the @action
*
* The ::gesture-end signal is emitted at the end of the gesture gesture,
* The signal is emitted at the end of the gesture gesture,
* when the pointer's button is released
*
* This signal is emitted if and only if the #ClutterGestureAction::gesture-begin
* This signal is emitted if and only if the [signal@GestureAction::gesture-begin]
* signal has been emitted first.
*
* Since: 1.8
@ -794,10 +794,10 @@ clutter_gesture_action_class_init (ClutterGestureActionClass *klass)
* @action: the #ClutterGestureAction that emitted the signal
* @actor: the #ClutterActor attached to the @action
*
* The ::gesture-cancel signal is emitted when the ongoing gesture gets
* cancelled from the #ClutterGestureAction::gesture-progress signal handler.
* The signal is emitted when the ongoing gesture gets
* cancelled from the [signal@GestureAction::gesture-progress] signal handler.
*
* This signal is emitted if and only if the #ClutterGestureAction::gesture-begin
* This signal is emitted if and only if the [signal@GestureAction::gesture-begin]
* signal has been emitted first.
*
* Since: 1.8
@ -1218,7 +1218,7 @@ clutter_gesture_action_get_device (ClutterGestureAction *action,
* @point: index of a point currently active
*
* Retrieves a reference to the last #ClutterEvent for a touch point. Call
* clutter_event_copy() if you need to store the reference somewhere.
* [method@Event.copy] if you need to store the reference somewhere.
*
* Return value: (transfer none): the last #ClutterEvent for a touch point.
*
@ -1293,7 +1293,7 @@ clutter_gesture_action_set_threshold_trigger_edge (ClutterGestureAction *ac
* @action: a #ClutterGestureAction
*
* Retrieves the edge trigger of the gesture @action, as set using
* clutter_gesture_action_set_threshold_trigger_edge().
* [method@GestureAction.set_threshold_trigger_edge].
*
* Return value: the edge trigger
*
@ -1317,13 +1317,13 @@ clutter_gesture_action_get_threshold_trigger_edge (ClutterGestureAction *action)
* @action: a #ClutterGestureAction
*
* Retrieves the edge trigger of the gesture @action, as set using
* clutter_gesture_action_set_threshold_trigger_edge().
* [method@GestureAction.set_threshold_trigger_edge].
*
* Return value: the edge trigger
*
* Since: 1.18
*
* Deprecated: 1.20: Use clutter_gesture_action_get_threshold_trigger_edge() instead.
* Deprecated: 1.20: Use [method@GestureAction.get_threshold_trigger_edge] instead.
*/
ClutterGestureTriggerEdge
clutter_gesture_action_get_threshold_trigger_egde (ClutterGestureAction *action)
@ -1375,7 +1375,7 @@ clutter_gesture_action_set_threshold_trigger_distance (ClutterGestureAction
* @y: (out) (allow-none): The return location for the vertical distance, or %NULL
*
* Retrieves the threshold trigger distance of the gesture @action,
* as set using clutter_gesture_action_set_threshold_trigger_distance().
* as set using [method@GestureAction.set_threshold_trigger_distance].
*
* Since: 1.18
*/

7
clutter/clutter/clutter-grid-layout.c
View file

@ -41,10 +41,9 @@
#include "clutter-private.h"
/**
* SECTION:clutter-grid-layout
* @Short_description: A layout manager for a grid of actors
* @Title: ClutterGridLayout
* @See_also: #ClutterBoxLayout
* ClutterGridLayout:
*
* A layout manager for a grid of actors
*
* #ClutterGridLayout is a layout manager which arranges its child widgets in
* rows and columns. It is a very similar to #ClutterBoxLayout, but it

8
clutter/clutter/clutter-grid-layout.h
View file

@ -48,14 +48,6 @@ typedef struct _ClutterGridLayout ClutterGridLayout;
typedef struct _ClutterGridLayoutPrivate ClutterGridLayoutPrivate;
typedef struct _ClutterGridLayoutClass ClutterGridLayoutClass;
/**
* ClutterGridLayout:
*
* The #ClutterGridLayout structure contains only private data
* and should be accessed using the provided API
*
* Since: 1.12
*/
struct _ClutterGridLayout
{
/*< private >*/

14
clutter/clutter/clutter-image.c
View file

@ -23,17 +23,17 @@
*/
/**
* SECTION:clutter-image
* @Title: ClutterImage
* @Short_Description: Image data content
* ClutterImage:
*
* Image data content
*
* #ClutterImage is a #ClutterContent implementation that displays
* image data inside a #ClutterActor.
* image data inside a [class@Actor].
*
* See [image.c](https://git.gnome.org/browse/clutter/tree/examples/image-content.c?h=clutter-1.18)
* for an example of how to use #ClutterImage.
*
* #ClutterImage is available since Clutter 1.10.
* Since: 1.10.
*/
#include "clutter-build-config.h"
@ -218,7 +218,7 @@ clutter_image_new (void)
* how to retrieve that data is left to platform specific image loaders. For
* instance, if you use the GdkPixbuf library:
*
* |[<!-- language="C" -->
* ```c
* ClutterContent *image = clutter_image_new ();
*
* GdkPixbuf *pixbuf = gdk_pixbuf_new_from_file (filename, NULL);
@ -234,7 +234,7 @@ clutter_image_new (void)
* &error);
*
* g_object_unref (pixbuf);
* ]|
* ```
*
* Return value: %TRUE if the image data was successfully loaded,
* and %FALSE otherwise.

5
clutter/clutter/clutter-input-device.c
View file

@ -22,8 +22,9 @@
*/
/**
* SECTION:clutter-input-device
* @short_description: An input device managed by Clutter
* ClutterInputDevice:
*
* An input device managed by Clutter
*
* #ClutterInputDevice represents an input device known to Clutter.
*

6
clutter/clutter/clutter-input-device.h
View file

@ -59,12 +59,6 @@ struct _ClutterInputDeviceClass
#define CLUTTER_IS_INPUT_DEVICE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_INPUT_DEVICE))
#define CLUTTER_INPUT_DEVICE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_INPUT_DEVICE, ClutterInputDeviceClass))
/**
* ClutterInputDevice:
*
* Generic representation of an input device. The actual contents of this
* structure depend on the backend used.
*/
typedef struct _ClutterInputDeviceClass ClutterInputDeviceClass;
CLUTTER_EXPORT

19
clutter/clutter/clutter-interval.c
View file

@ -23,8 +23,9 @@
*/
/**
* SECTION:clutter-interval
* @short_description: An object holding an interval of two values
* ClutterInterval:
*
* An object holding an interval of two values
*
* #ClutterInterval is a simple object that can hold two values
* defining an interval. #ClutterInterval can hold any value that
@ -40,7 +41,7 @@
* #ClutterInterval can be subclassed to override the validation
* and value computation.
*
* #ClutterInterval is available since Clutter 1.0
* Since: 1.0
*/
#include "clutter-build-config.h"
@ -744,11 +745,11 @@ clutter_interval_get_interval_valist (ClutterInterval *interval,
* This function avoids using a #GValue for the initial and final values
* of the interval:
*
* |[
* ```c
* interval = clutter_interval_new (G_TYPE_FLOAT, 0.0, 1.0);
* interval = clutter_interval_new (G_TYPE_BOOLEAN, FALSE, TRUE);
* interval = clutter_interval_new (G_TYPE_INT, 0, 360);
* ]|
* ```
*
* Return value: the newly created #ClutterInterval
*
@ -1047,11 +1048,11 @@ clutter_interval_peek_final_value (ClutterInterval *interval)
* and clutter_interval_set_final_value() that avoids using the
* #GValue arguments:
*
* |[
* ```c
* clutter_interval_set_interval (interval, 0, 50);
* clutter_interval_set_interval (interval, 1.0, 0.0);
* clutter_interval_set_interval (interval, FALSE, TRUE);
* ]|
* ```
*
* This function is meant for the convenience of the C API; bindings
* should reimplement this function using the #GValue-based API.
@ -1088,10 +1089,10 @@ out:
* and clutter_interval_get_final_value() that avoids using the
* #GValue arguments:
*
* |[
* ```c
* gint a = 0, b = 0;
* clutter_interval_get_interval (interval, &a, &b);
* ]|
* ```
*
* This function is meant for the convenience of the C API; bindings
* should reimplement this function using the #GValue-based API.

8
clutter/clutter/clutter-interval.h
View file

@ -43,14 +43,6 @@ G_BEGIN_DECLS
typedef struct _ClutterIntervalPrivate ClutterIntervalPrivate;
typedef struct _ClutterIntervalClass ClutterIntervalClass;
/**
* ClutterInterval:
*
* The #ClutterInterval structure contains only private data and should
* be accessed using the provided functions.
*
* Since: 1.0
*/
struct _ClutterInterval
{
/*< private >*/

12
clutter/clutter/clutter-keyframe-transition.c
View file

@ -22,9 +22,9 @@
*/
/**
* SECTION:clutter-keyframe-transition
* @Title: ClutterKeyframeTransition
* @Short_Description: Keyframe property transition
* ClutterKeyframeTransition:
*
* Keyframe property transition
*
* #ClutterKeyframeTransition allows animating a property by defining
* "key frames": values at a normalized position on the transition
@ -36,7 +36,7 @@
* Setting up a #ClutterKeyframeTransition means providing the times,
* values, and easing modes between these key frames, for instance:
*
* |[
* ```c
* ClutterTransition *keyframe;
*
* keyframe = clutter_keyframe_transition_new ("opacity");
@ -46,7 +46,7 @@
* G_TYPE_UINT,
* 1, /&ast; number of key frames &ast;/
* 0.5, 128, CLUTTER_EASE_IN_OUT_CUBIC);
* ]|
* ```
*
* The example above sets up a keyframe transition for the #ClutterActor:opacity
* property of a #ClutterActor; the transition starts and sets the value of the
@ -59,7 +59,7 @@
* and the 1.0 value, to interpolate to the final value of the transition's
* interval.
*
* #ClutterKeyframeTransition is available since Clutter 1.12.
* Since: 1.12.
*/
#include "clutter-build-config.h"

8
clutter/clutter/clutter-keyframe-transition.h
View file

@ -43,14 +43,6 @@ G_BEGIN_DECLS
typedef struct _ClutterKeyframeTransitionPrivate ClutterKeyframeTransitionPrivate;
typedef struct _ClutterKeyframeTransitionClass ClutterKeyframeTransitionClass;
/**
* ClutterKeyframeTransition:
*
* The `ClutterKeyframeTransition` structure contains only private
* data and should be accessed using the provided API.
*
* Since: 1.12
*/
struct _ClutterKeyframeTransition
{
/*< private >*/

30
clutter/clutter/clutter-layout-manager.c
View file

@ -23,8 +23,9 @@
*/
/**
* SECTION:clutter-layout-manager
* @short_description: Layout managers base class
* ClutterLayoutManager:
*
* Layout managers base class
*
* #ClutterLayoutManager is a base abstract class for layout managers. A
* layout manager implements the layouting policy for a composite or a
@ -66,7 +67,7 @@
* to control how the #ClutterLayoutMeta instance is created, otherwise the
* default implementation will be equivalent to:
*
* |[
* ```c
* ClutterLayoutManagerClass *klass;
* GType meta_type;
*
@ -78,7 +79,7 @@
* "container", container,
* "actor", actor,
* NULL);
* ]|
* ```
*
* Where `manager` is the #ClutterLayoutManager, `container` is the
* #ClutterContainer using the #ClutterLayoutManager, and `actor` is
@ -94,7 +95,7 @@
* a #ClutterLayoutManager using the `layout::` modifier on the property
* name, for instance:
*
* |[
* ```json
* {
* "type" : "ClutterActor",
* "layout-manager" : { "type" : "ClutterGridLayout" },
@ -123,9 +124,9 @@
* }
* ]
* }
* ]|
* ```
*
* #ClutterLayoutManager is available since Clutter 1.2
* Since: 1.2
*/
#include "clutter-build-config.h"
@ -316,12 +317,13 @@ clutter_layout_manager_class_init (ClutterLayoutManagerClass *klass)
* ClutterLayoutManager::layout-changed:
* @manager: the #ClutterLayoutManager that emitted the signal
*
* The ::layout-changed signal is emitted each time a layout manager
* The signal is emitted each time a layout manager
* has been changed. Every #ClutterActor using the @manager instance
* as a layout manager should connect a handler to the ::layout-changed
* as a layout manager should connect a handler to the
* [signal@LayoutManager::layout-changed]
* signal and queue a relayout on themselves:
*
* |[
* ```c
* static void layout_changed (ClutterLayoutManager *manager,
* ClutterActor *self)
* {
@ -332,7 +334,7 @@ clutter_layout_manager_class_init (ClutterLayoutManagerClass *klass)
* g_signal_connect (self->manager, "layout-changed",
* G_CALLBACK (layout_changed),
* self);
* ]|
* ```
*
* Sub-classes of #ClutterLayoutManager that implement a layout that
* can be controlled or changed using parameters should emit the
@ -975,13 +977,13 @@ clutter_layout_manager_find_child_property (ClutterLayoutManager *manager,
* clutter_layout_manager_list_child_properties:
* @manager: a #ClutterLayoutManager
* @n_pspecs: (out): return location for the number of returned
* #GParamSpec<!-- -->s
* `GParamSpec`s
*
* Retrieves all the #GParamSpec<!-- -->s for the layout properties
* Retrieves all the `GParamSpec`s for the layout properties
* stored inside the #ClutterLayoutMeta sub-class used by @manager
*
* Return value: (transfer full) (array length=n_pspecs): the newly-allocated,
* %NULL-terminated array of #GParamSpec<!-- -->s. Use g_free() to free the
* %NULL-terminated array of `GParamSpec`s. Use g_free() to free the
* resources allocated for the array
*
* Since: 1.2

8
clutter/clutter/clutter-layout-manager.h
View file

@ -42,14 +42,6 @@ G_BEGIN_DECLS
typedef struct _ClutterLayoutManagerClass ClutterLayoutManagerClass;
/**
* ClutterLayoutManager:
*
* The #ClutterLayoutManager structure contains only private data
* and should be accessed using the provided API
*
* Since: 1.2
*/
struct _ClutterLayoutManager
{
/*< private >*/

15
clutter/clutter/clutter-layout-meta.c
View file

@ -23,16 +23,17 @@
*/
/**
* SECTION:clutter-layout-meta
* @short_description: Wrapper for actors inside a layout manager
* ClutterLayoutMeta:
*
* Wrapper for actors inside a layout manager
*
* #ClutterLayoutMeta is a wrapper object created by #ClutterLayoutManager
* #ClutterLayoutMeta is a wrapper object created by [class@LayoutManager]
* implementations in order to store child-specific data and properties.
*
* A #ClutterLayoutMeta wraps a #ClutterActor inside a #ClutterContainer
* using a #ClutterLayoutManager.
* A #ClutterLayoutMeta wraps a [class@Actor] inside a [iface@Container]
* using a [class@LayoutManager].
*
* #ClutterLayoutMeta is available since Clutter 1.2
* Since: 1.2
*/
#include "clutter-build-config.h"
@ -108,7 +109,7 @@ clutter_layout_meta_class_init (ClutterLayoutMetaClass *klass)
/**
* ClutterLayoutMeta:manager:
*
* The #ClutterLayoutManager that created this #ClutterLayoutMeta.
* The [class@LayoutManager] that created this #ClutterLayoutMeta.
*
* Since: 1.2
*/

12
clutter/clutter/clutter-layout-meta.h
View file

@ -46,18 +46,6 @@ G_BEGIN_DECLS
typedef struct _ClutterLayoutMetaClass ClutterLayoutMetaClass;
/**
* ClutterLayoutMeta:
* @manager: the layout manager handling this data
*
* Sub-class of #ClutterChildMeta specific for layout managers
*
* A #ClutterLayoutManager sub-class should create a #ClutterLayoutMeta
* instance by overriding the #ClutterLayoutManager::create_child_meta()
* virtual function
*
* Since: 1.2
*/
struct _ClutterLayoutMeta
{
/*< private >*/

10
clutter/clutter/clutter-main.c
View file

@ -286,7 +286,7 @@ _clutter_threads_dispatch_free (gpointer data)
* it will call @function while holding the Clutter lock. It is logically
* equivalent to the following implementation:
*
* |[
* ```c
* static gboolean
* idle_safe_callback (gpointer data)
* {
@ -314,7 +314,7 @@ _clutter_threads_dispatch_free (gpointer data)
* closure,
* g_free)
* }
*]|
* ```
*
* This function should be used by threaded applications to make sure
* that @func is emitted under the Clutter threads lock and invoked
@ -322,7 +322,7 @@ _clutter_threads_dispatch_free (gpointer data)
* it can be used to update the UI using the results from a worker
* thread:
*
* |[
* ```c
* static gboolean
* update_ui (gpointer data)
* {
@ -351,7 +351,7 @@ _clutter_threads_dispatch_free (gpointer data)
* update_ui,
* closure,
* NULL);
* ]|
* ```
*
* Return value: the ID (greater than 0) of the event source.
*
@ -1239,7 +1239,7 @@ _clutter_run_repaint_functions (ClutterRepaintFlags flags)
* environment variable.
*
* The default text direction can be overridden on a per-actor basis by using
* clutter_actor_set_text_direction().
* [method@Actor.set_text_direction].
*
* Return value: the default text direction
*

43
clutter/clutter/clutter-offscreen-effect.c
View file

@ -24,12 +24,12 @@
*/
/**
* SECTION:clutter-offscreen-effect
* @short_description: Base class for effects using offscreen buffers
* @see_also: #ClutterBlurEffect, #ClutterEffect
* ClutterOffscreenEffect:
*
* Base class for effects using offscreen buffers
*
* #ClutterOffscreenEffect is an abstract class that can be used by
* #ClutterEffect sub-classes requiring access to an offscreen buffer.
* [class@Effect] sub-classes requiring access to an offscreen buffer.
*
* Some effects, like the fragment shader based effects, can only use GL
* textures, and in order to apply those effects to any kind of actor they
@ -40,24 +40,23 @@
* offscreen framebuffer, the redirection and the final paint of the texture on
* the desired stage.
*
* #ClutterOffscreenEffect is available since Clutter 1.4
*
* ## Implementing a ClutterOffscreenEffect
*
* Creating a sub-class of #ClutterOffscreenEffect requires, in case
* of overriding the #ClutterEffect virtual functions, to chain up to the
* of overriding the [class@Effect] virtual functions, to chain up to the
* #ClutterOffscreenEffect's implementation.
*
* On top of the #ClutterEffect's virtual functions,
* #ClutterOffscreenEffect also provides a #ClutterOffscreenEffectClass.paint_target()
* On top of the [class@Effect]'s virtual functions,
* #ClutterOffscreenEffect also provides a [vfunc@OffscreenEffect.paint_target]
* function, which encapsulates the effective painting of the texture that
* contains the result of the offscreen redirection.
*
* The size of the target material is defined to be as big as the
* transformed size of the #ClutterActor using the offscreen effect.
* transformed size of the [class@Actor] using the offscreen effect.
* Sub-classes of #ClutterOffscreenEffect can change the texture creation
* code to provide bigger textures by overriding the
* #ClutterOffscreenEffectClass.create_texture() virtual function; no chain up
* [vfunc@OffscreenEffect.create_texture] virtual function; no chain up
* to the #ClutterOffscreenEffect implementation is required in this
* case.
*
@ -65,25 +64,27 @@
*
* #ClutterOffscreenEffect generates the following paint node tree:
*
* |[<!-- language="plain" -->
* ```
* Effect
* ├─────────┐
* Layer Pipeline
* │
* Actor
* ]|
* ```
*
* When the actor contents are cached, the generated paint node tree
* looks like this:
*
* |[<!-- language="plain" -->
* ```
* Effect
* │
* Pipeline
* ]|
* ```
*
* In both cases, the "Pipeline" node is created with the return value
* of #ClutterOffscreenEffectClass.create_pipeline().
* of [vfunc@OffscreenEffect.create_pipeline].
*
* Since: 1.4
*/
#include "clutter-build-config.h"
@ -619,10 +620,10 @@ clutter_offscreen_effect_init (ClutterOffscreenEffect *self)
* buffer created by @effect
*
* You should only use the returned texture when painting. The texture
* may change after ClutterEffect::pre_paint is called so the effect
* may change after [vfunc@Effect.pre_paint] is called so the effect
* implementation should update any references to the texture after
* chaining-up to the parent's pre_paint implementation. This can be
* used instead of clutter_offscreen_effect_get_target() when the
* used instead of [method@OffscreenEffect.get_texture] when the
* effect subclass wants to paint using its own material.
*
* Return value: (transfer none): a #CoglHandle or %NULL. The
@ -647,7 +648,7 @@ clutter_offscreen_effect_get_texture (ClutterOffscreenEffect *effect)
* Retrieves the pipeline used as a render target for the offscreen
* buffer created by @effect
*
* You should only use the returned #CoglPipeline when painting. The
* You should only use the returned [class@Cogl.Pipeline] when painting. The
* returned pipeline might change between different frames.
*
* Return value: (transfer none)(nullable): a #CoglPipeline. The
@ -671,7 +672,7 @@ clutter_offscreen_effect_get_pipeline (ClutterOffscreenEffect *effect)
* @node: a #ClutterPaintNode
* @paint_context: a #ClutterPaintContext
*
* Calls the paint_target() virtual function of the @effect
* Calls the [vfunc@OffscreenEffect.paint_target] virtual function of the @effect
*
* Since: 1.4
*/
@ -693,7 +694,7 @@ clutter_offscreen_effect_paint_target (ClutterOffscreenEffect *effect,
* @width: the minimum width of the target texture
* @height: the minimum height of the target texture
*
* Calls the create_texture() virtual function of the @effect
* Calls the [vfunc@OffscreenEffect.create_texture] virtual function of the @effect
*
* Return value: (transfer full): a handle to a Cogl texture, or
* %NULL. The returned handle has its reference
@ -724,7 +725,7 @@ clutter_offscreen_effect_create_texture (ClutterOffscreenEffect *effect,
* paint the actor to which it has been applied.
*
* This function should only be called by #ClutterOffscreenEffect
* implementations, from within the #ClutterOffscreenEffectClass.paint_target()
* implementations, from within the [vfunc@OffscreenEffect.paint_target]
* virtual function.
*
* Return value: %TRUE if the offscreen buffer has a valid size,

8
clutter/clutter/clutter-offscreen-effect.h
View file

@ -45,14 +45,6 @@ typedef struct _ClutterOffscreenEffect ClutterOffscreenEffect;
typedef struct _ClutterOffscreenEffectPrivate ClutterOffscreenEffectPrivate;
typedef struct _ClutterOffscreenEffectClass ClutterOffscreenEffectClass;
/**
* ClutterOffscreenEffect:
*
* The #ClutterOffscreenEffect structure contains only private data
* and should be accessed using the provided API
*
* Since: 1.4
*/
struct _ClutterOffscreenEffect
{
/*< private >*/

14
clutter/clutter/clutter-page-turn-effect.c
View file

@ -26,13 +26,13 @@
*/
/**
* SECTION:clutter-page-turn-effect
* @Title: ClutterPageTurnEffect
* @Short_Description: A page turning effect
* ClutterPageTurnEffect:
*
* A page turning effect
*
* A simple page turning effect
*
* #ClutterPageTurnEffect is available since Clutter 1.4
* Since: 1.4
*/
#include "clutter-build-config.h"
@ -326,7 +326,7 @@ clutter_page_turn_effect_set_period (ClutterPageTurnEffect *effect,
* clutter_page_turn_effect_get_period:
* @effect: a #ClutterPageTurnEffect
*
* Retrieves the value set using clutter_page_turn_effect_get_period()
* Retrieves the value set using [method@PageTurnEffect.get_period]
*
* Return value: the period of the page curling
*
@ -367,7 +367,7 @@ clutter_page_turn_effect_set_angle (ClutterPageTurnEffect *effect,
* clutter_page_turn_effect_get_angle:
* @effect: a #ClutterPageTurnEffect:
*
* Retrieves the value set using clutter_page_turn_effect_get_angle()
* Retrieves the value set using [method@PageTurnEffect.get_angle]
*
* Return value: the angle of the page curling
*
@ -407,7 +407,7 @@ clutter_page_turn_effect_set_radius (ClutterPageTurnEffect *effect,
* clutter_page_turn_effect_get_radius:
* @effect: a #ClutterPageTurnEffect
*
* Retrieves the value set using clutter_page_turn_effect_set_radius()
* Retrieves the value set using [method@PageTurnEffect.set_radius]
*
* Return value: the radius of the page curling
*

8
clutter/clutter/clutter-page-turn-effect.h
View file

@ -40,14 +40,6 @@ G_BEGIN_DECLS
#define CLUTTER_PAGE_TURN_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PAGE_TURN_EFFECT, ClutterPageTurnEffect))
#define CLUTTER_IS_PAGE_TURN_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PAGE_TURN_EFFECT))
/**
* ClutterPageTurnEffect:
*
* #ClutterPageTurnEffect is an opaque structure
* whose members can only be accessed using the provided API
*
* Since: 1.4
*/
typedef struct _ClutterPageTurnEffect ClutterPageTurnEffect;
typedef struct _ClutterPageTurnEffectClass ClutterPageTurnEffectClass;

17
clutter/clutter/clutter-paint-node.c
View file

@ -23,9 +23,9 @@
*/
/**
* SECTION:clutter-paint-node
* @Title: ClutterPaintNode
* @Short_Description: Paint objects
* ClutterPaintNode:(ref-func clutter_paint_node_ref) (unref-func clutter_paint_node_unref) (set-value-func clutter_value_set_paint_node) (get-value-func clutter_value_get_paint_node)
*
* Paint objects
*
* #ClutterPaintNode is an element in the render graph.
*
@ -37,16 +37,9 @@
* elements also respond to events. The render graph, instead, is only
* composed by nodes that will be painted.
*
* Each #ClutterActor can submit multiple #ClutterPaintNode<!-- -->s to
* Each #ClutterActor can submit multiple `ClutterPaintNode`s to
* the render graph.
*/
/**
* ClutterPaintNode: (ref-func clutter_paint_node_ref) (unref-func clutter_paint_node_unref) (set-value-func clutter_value_set_paint_node) (get-value-func clutter_value_get_paint_node)
*
* The `ClutterPaintNode` structure contains only private data
* and it should be accessed using the provided API.
*
*
* Since: 1.10
*/

61
clutter/clutter/clutter-paint-nodes.c
View file

@ -22,14 +22,6 @@
* Emmanuele Bassi <ebassi@linux.intel.com>
*/
/**
* SECTION:clutter-paint-nodes
* @Title: Paint Nodes
* @Short_Description: ClutterPaintNode implementations
*
* Clutter provides a set of predefined #ClutterPaintNode implementations
* that cover all the state changes available.
*/
#include "clutter-build-config.h"
@ -82,9 +74,9 @@ clutter_paint_node_init_types (ClutterBackend *clutter_backend)
}
/*
* Root node
* ClutterRootNode:
*
* any frame can only have a since RootNode instance for each
* Any frame can only have a since RootNode instance for each
* top-level actor.
*/
@ -183,7 +175,9 @@ clutter_root_node_new (CoglFramebuffer *framebuffer,
}
/*
* ClutterTransformNode
* ClutterTransformNode:
*
* Since: 1.10
*/
struct _ClutterTransformNode
@ -362,8 +356,10 @@ _clutter_dummy_node_new (ClutterActor *actor,
return res;
}
/*
* Pipeline node
/**
* ClutterPipelineNode:
*
* Since: 1.10
*/
struct _ClutterPipelineNode
@ -586,8 +582,10 @@ clutter_pipeline_node_new (CoglPipeline *pipeline)
return (ClutterPaintNode *) res;
}
/*
* Color node
/**
* ClutterColorNode:
*
* Since: 1.10
*/
struct _ClutterColorNode
@ -661,8 +659,11 @@ clutter_color_node_new (const ClutterColor *color)
return (ClutterPaintNode *) cnode;
}
/*
* Texture node
/**
* ClutterTextureNode:
*
*
* Since: 1.10
*/
struct _ClutterTextureNode
@ -775,10 +776,12 @@ clutter_texture_node_new (CoglTexture *texture,
return (ClutterPaintNode *) tnode;
}
/*
* Text node
*/
/**
* ClutterTextNode:
*
* Since: 1.10
*/
struct _ClutterTextNode
{
ClutterPaintNode parent_instance;
@ -986,8 +989,10 @@ clutter_text_node_new (PangoLayout *layout,
return (ClutterPaintNode *) res;
}
/*
* Clip node
/**
* ClutterClipNode:
*
* Since: 1.10
*/
struct _ClutterClipNode
{
@ -1115,8 +1120,8 @@ clutter_clip_node_new (void)
return _clutter_paint_node_create (CLUTTER_TYPE_CLIP_NODE);
}
/*
* ClutterActorNode
/**
* ClutterActorNode:
*/
struct _ClutterActorNode
@ -1769,7 +1774,7 @@ clutter_blit_node_init (ClutterBlitNode *self)
* Creates a new #ClutterBlitNode that blits @src into the current
* draw framebuffer.
*
* You must only add rectangles using clutter_blit_node_add_blit_rectangle().
* You must only add rectangles using [method@BlitNode.add_blit_rectangle].
*
* Return value: (transfer full): the newly created #ClutterBlitNode.
* Use clutter_paint_node_unref() when done.
@ -1798,7 +1803,7 @@ clutter_blit_node_new (CoglFramebuffer *src)
* @height: Height of region to copy
*
* Adds a new blit rectangle to the stack of rectangles. All the
* constraints of cogl_blit_framebuffer() apply here.
* constraints of [func@Cogl.blit_framebuffer] apply here.
*/
void
clutter_blit_node_add_blit_rectangle (ClutterBlitNode *blit_node,
@ -1824,8 +1829,8 @@ clutter_blit_node_add_blit_rectangle (ClutterBlitNode *blit_node,
dst_y + height);
}
/*
* ClutterBlurNode
/**
* ClutterBlurNode:
*/
struct _ClutterBlurNode

80
clutter/clutter/clutter-paint-nodes.h
View file

@ -38,14 +38,6 @@ G_BEGIN_DECLS
#define CLUTTER_COLOR_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_COLOR_NODE, ClutterColorNode))
#define CLUTTER_IS_COLOR_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_COLOR_NODE))
/**
* ClutterColorNode:
*
* The #ClutterTextNode structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
*/
typedef struct _ClutterColorNode ClutterColorNode;
typedef struct _ClutterColorNodeClass ClutterColorNodeClass;
@ -59,14 +51,6 @@ ClutterPaintNode * clutter_color_node_new (const ClutterColor *
#define CLUTTER_TEXTURE_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_TEXTURE_NODE, ClutterTextureNode))
#define CLUTTER_IS_TEXTURE_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_TEXTURE_NODE))
/**
* ClutterTextureNode:
*
* The #ClutterTextNode structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
*/
typedef struct _ClutterTextureNode ClutterTextureNode;
typedef struct _ClutterTextureNodeClass ClutterTextureNodeClass;
@ -83,14 +67,6 @@ ClutterPaintNode * clutter_texture_node_new (CoglTexture *
#define CLUTTER_CLIP_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_CLIP_NODE, ClutterClipNode))
#define CLUTTER_IS_CLIP_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_CLIP_NODE))
/**
* ClutterClipNode:
*
* The #ClutterTextNode structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
*/
typedef struct _ClutterClipNode ClutterClipNode;
typedef struct _ClutterClipNodeClass ClutterClipNodeClass;
@ -104,14 +80,6 @@ ClutterPaintNode * clutter_clip_node_new (void);
#define CLUTTER_PIPELINE_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PIPELINE_NODE, ClutterPipelineNode))
#define CLUTTER_IS_PIPELINE_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PIPELINE_NODE))
/**
* ClutterPipelineNode:
*
* The #ClutterTextNode structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
*/
typedef struct _ClutterPipelineNode ClutterPipelineNode;
typedef struct _ClutterPipelineNodeClass ClutterPipelineNodeClass;
@ -125,14 +93,6 @@ ClutterPaintNode * clutter_pipeline_node_new (CoglPipeline *
#define CLUTTER_TEXT_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_TEXT_NODE, ClutterTextNode))
#define CLUTTER_IS_TEXT_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_TEXT_NODE))
/**
* ClutterTextNode:
*
* The #ClutterTextNode structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
*/
typedef struct _ClutterTextNode ClutterTextNode;
typedef struct _ClutterTextNodeClass ClutterTextNodeClass;
@ -147,12 +107,6 @@ ClutterPaintNode * clutter_text_node_new (PangoLayout *
#define CLUTTER_ACTOR_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_ACTOR_NODE, ClutterActorNode))
#define CLUTTER_IS_ACTOR_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_ACTOR_NODE))
/**
* ClutterActorNode:
*
* The #ClutterActorNode structure is an opaque
* type whose members cannot be directly accessed.
*/
typedef struct _ClutterActorNode ClutterActorNode;
typedef struct _ClutterActorNode ClutterActorNodeClass;
@ -167,12 +121,6 @@ ClutterPaintNode * clutter_actor_node_new (ClutterActor *actor,
#define CLUTTER_ROOT_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_ROOT_NODE, ClutterRootNode))
#define CLUTTER_IS_ROOT_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_ROOT_NODE))
/**
* ClutterRootNode:
*
* The #ClutterRootNode structure is an opaque
* type whose members cannot be directly accessed.
*/
typedef struct _ClutterRootNode ClutterRootNode;
typedef struct _ClutterPaintNodeClass ClutterRootNodeClass;
@ -188,14 +136,6 @@ ClutterPaintNode * clutter_root_node_new (CoglFramebuffer *
#define CLUTTER_LAYER_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_LAYER_NODE, ClutterLayerNode))
#define CLUTTER_IS_LAYER_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_LAYER_NODE))
/*
* ClutterLayerNode:
*
* The #ClutterLayerNode structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
*/
typedef struct _ClutterLayerNode ClutterLayerNode;
typedef struct _ClutterLayerNodeClass ClutterLayerNodeClass;
@ -218,14 +158,6 @@ ClutterPaintNode * clutter_layer_node_new_to_framebuffer (CoglFramebuffer *frame
#define CLUTTER_TRANSFORM_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_TRANSFORM_NODE, ClutterTransformNode))
#define CLUTTER_IS_TRANSFORM_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_TRANSFORM_NODE))
/*
* ClutterTransformNode:
*
* The #ClutterLayerNode structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
*/
typedef struct _ClutterTransformNode ClutterTransformNode;
typedef struct _ClutterPaintNodeClass ClutterTransformNodeClass;
@ -239,12 +171,6 @@ ClutterPaintNode * clutter_transform_node_new (const graphene_matr
#define CLUTTER_BLIT_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BLIT_NODE, ClutterBlitNode))
#define CLUTTER_IS_BLIT_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BLIT_NODE))
/*
* ClutterBlitNode:
*
* The #ClutterBlitNode structure is an opaque
* type whose members cannot be directly accessed.
*/
typedef struct _ClutterBlitNode ClutterBlitNode;
typedef struct _ClutterPaintNodeClass ClutterBlitNodeClass;
@ -267,12 +193,6 @@ void clutter_blit_node_add_blit_rectangle (ClutterBlitNode *blit_node,
#define CLUTTER_BLUR_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BLUR_NODE, ClutterBlurNode))
#define CLUTTER_IS_BLUR_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BLUR_NODE))
/**
* ClutterBlurNode:
*
* The #ClutterBurNode structure is an opaque
* type whose members cannot be directly accessed.
*/
typedef struct _ClutterBlurNode ClutterBlurNode;
typedef struct _ClutterLayerNodeClass ClutterBlurNodeClass;

20
clutter/clutter/clutter-paint-volume.c
View file

@ -289,13 +289,13 @@ clutter_paint_volume_set_width (ClutterPaintVolume *pv,
* around the volume. It returns the size of that bounding box as
* measured along the x-axis.
*
* If, for example, clutter_actor_get_transformed_paint_volume()
* If, for example, [method@Actor.get_transformed_paint_volume]
* is used to transform a 2D child actor that is 100px wide, 100px
* high and 0px deep into container coordinates then the width might
* not simply be 100px if the child actor has a 3D rotation applied to
* it.
*
* Remember: if clutter_actor_get_transformed_paint_volume() is
* Remember: if [method@Actor.get_transformed_paint_volume] is
* used then a transformed child volume will be defined relative to the
* ancestor container actor and so a 2D child actor can have a 3D
* bounding volume.
@ -381,13 +381,13 @@ clutter_paint_volume_set_height (ClutterPaintVolume *pv,
* around the volume. It returns the size of that bounding box as
* measured along the y-axis.
*
* If, for example, clutter_actor_get_transformed_paint_volume()
* If, for example, [method@Actor.get_transformed_paint_volume]
* is used to transform a 2D child actor that is 100px wide, 100px
* high and 0px deep into container coordinates then the height might
* not simply be 100px if the child actor has a 3D rotation applied to
* it.
*
* Remember: if clutter_actor_get_transformed_paint_volume() is
* Remember: if [method@Actor.get_transformed_paint_volume] is
* used then a transformed child volume will be defined relative to the
* ancestor container actor and so a 2D child actor
* can have a 3D bounding volume.
@ -474,13 +474,13 @@ clutter_paint_volume_set_depth (ClutterPaintVolume *pv,
* around the volume. It returns the size of that bounding box as
* measured along the z-axis.
*
* If, for example, clutter_actor_get_transformed_paint_volume()
* If, for example, [method@Actor.get_transformed_paint_volume]
* is used to transform a 2D child actor that is 100px wide, 100px
* high and 0px deep into container coordinates then the depth might
* not simply be 0px if the child actor has a 3D rotation applied to
* it.
*
* Remember: if clutter_actor_get_transformed_paint_volume() is
* Remember: if [method@Actor.get_transformed_paint_volume] is
* used then the transformed volume will be defined relative to the
* container actor and in container coordinates a 2D child actor
* can have a 3D bounding volume.
@ -607,7 +607,7 @@ done:
*
* Unions the 2D region represented by @box to a #ClutterPaintVolume.
*
* This function is similar to clutter_paint_volume_union(), but it is
* This function is similar to [method@PaintVolume.union], but it is
* specific for 2D regions.
*
* Since: 1.10
@ -985,19 +985,19 @@ _clutter_actor_set_default_paint_volume (ClutterActor *self,
* Sets the #ClutterPaintVolume from the allocation of @actor.
*
* This function should be used when overriding the
* #ClutterActorClass.get_paint_volume() by #ClutterActor sub-classes
* [vfunc@Actor.get_paint_volume] by [class@Actor] sub-classes
* that do not paint outside their allocation.
*
* A typical example is:
*
* |[
* ```c
* static gboolean
* my_actor_get_paint_volume (ClutterActor *self,
* ClutterPaintVolume *volume)
* {
* return clutter_paint_volume_set_from_allocation (volume, self);
* }
* ]|
* ```
*
* Return value: %TRUE if the paint volume was successfully set, and %FALSE
* otherwise

34
clutter/clutter/clutter-pan-action.c
View file

@ -31,21 +31,21 @@
*/
/**
* SECTION:clutter-pan-action
* @Title: ClutterPanAction
* @Short_Description: Action for pan gestures
* ClutterPanAction:
*
* Action for pan gestures
*
* #ClutterPanAction is a sub-class of #ClutterGestureAction that implements
* #ClutterPanAction is a sub-class of [class@GestureAction] that implements
* the logic for recognizing pan gestures.
*
* The simplest usage of #ClutterPanAction consists in adding it to
* a #ClutterActor with a child and setting it as reactive; for instance,
* a [class@Actor] with a child and setting it as reactive; for instance,
* the following code:
*
* |[
* ```c
* clutter_actor_add_action (actor, clutter_pan_action_new ());
* clutter_actor_set_reactive (actor, TRUE);
* ]|
* ```
*
* will automatically result in the actor children to be moved
* when dragging.
@ -551,7 +551,7 @@ clutter_pan_action_class_init (ClutterPanActionClass *klass)
* @is_interpolated: if the event is the result of interpolating
* the motion velocity at the end of the drag
*
* The ::pan signal is emitted to keep track of the motion during
* The signal is emitted to keep track of the motion during
* a pan gesture. @is_interpolated is set to %TRUE during the
* interpolation phase of the pan, after the drag has ended and
* the :interpolate property was set to %TRUE.
@ -576,7 +576,7 @@ clutter_pan_action_class_init (ClutterPanActionClass *klass)
* @action: the #ClutterPanAction that emitted the signal
* @actor: the #ClutterActor attached to the @action
*
* The ::pan-stopped signal is emitted at the end of the interpolation
* The signal is emitted at the end of the interpolation
* phase of the pan action, only when :interpolate is set to %TRUE.
*
* Since: 1.12
@ -648,7 +648,7 @@ clutter_pan_action_set_pan_axis (ClutterPanAction *self,
* clutter_pan_action_get_pan_axis:
* @self: a #ClutterPanAction
*
* Retrieves the axis constraint set by clutter_pan_action_set_pan_axis()
* Retrieves the axis constraint set by [method@PanAction.set_pan_axis]
*
* Return value: the axis constraint
*
@ -801,7 +801,7 @@ clutter_pan_action_get_acceleration_factor (ClutterPanAction *self)
* interpolated event's Y coordinate
*
* Retrieves the coordinates, in stage space, of the latest interpolated
* event, analogous to clutter_gesture_action_get_motion_coords().
* event, analogous to [method@GestureAction.get_motion_coords].
*
* Since: 1.12
*/
@ -832,7 +832,7 @@ clutter_pan_action_get_interpolated_coords (ClutterPanAction *self,
* the latest interpolated event
*
* Retrieves the delta, in stage space, since the latest interpolated
* event, analogous to clutter_gesture_action_get_motion_delta().
* event, analogous to [method@GestureAction.get_motion_delta].
*
* Return value: the distance since the latest interpolated event
*
@ -868,7 +868,7 @@ clutter_pan_action_get_interpolated_delta (ClutterPanAction *self,
*
* Retrieves the delta, in stage space, dependent on the current state
* of the #ClutterPanAction, and respecting the constraint specified by the
* #ClutterPanAction:pan-axis property.
* [property@PanAction:pan-axis] property.
*
* Return value: the distance since last motion event
*
@ -932,10 +932,10 @@ clutter_pan_action_get_constrained_motion_delta (ClutterPanAction *self,
* Retrieves the delta, in stage space, dependent on the current state
* of the #ClutterPanAction. If it is inactive, both fields will be
* set to 0. If it is panning by user action, the values will be equivalent
* to those returned by clutter_gesture_action_get_motion_delta().
* to those returned by [method@GestureAction.get_motion_delta].
* If it is interpolating with some form of kinetic scrolling, the values
* will be equivalent to those returned by
* clutter_pan_action_get_interpolated_delta(). This is a convenience
* [method@PanAction.get_interpolated_delta]. This is a convenience
* method designed to be used in replacement "pan" signal handlers.
*
* Since: 1.14
@ -984,10 +984,10 @@ clutter_pan_action_get_motion_delta (ClutterPanAction *self,
* Retrieves the coordinates, in stage space, dependent on the current state
* of the #ClutterPanAction. If it is inactive, both fields will be
* set to 0. If it is panning by user action, the values will be equivalent
* to those returned by clutter_gesture_action_get_motion_coords().
* to those returned by [method@GestureAction.get_motion_coords].
* If it is interpolating with some form of kinetic scrolling, the values
* will be equivalent to those returned by
* clutter_pan_action_get_interpolated_coords(). This is a convenience
* [method@PanAction.get_interpolated_coords]. This is a convenience
* method designed to be used in replacement "pan" signal handlers.
*
* Since: 1.14

8
clutter/clutter/clutter-pan-action.h
View file

@ -52,14 +52,6 @@ typedef struct _ClutterPanAction ClutterPanAction;
typedef struct _ClutterPanActionPrivate ClutterPanActionPrivate;
typedef struct _ClutterPanActionClass ClutterPanActionClass;
/**
* ClutterPanAction:
*
* The #ClutterPanAction structure contains
* only private data and should be accessed using the provided API
*
* Since: 1.12
*/
struct _ClutterPanAction
{
/*< private >*/

18
clutter/clutter/clutter-path-constraint.c
View file

@ -23,17 +23,17 @@
*/
/**
* SECTION:clutter-path-constraint
* @Title: ClutterPathConstraint
* @Short_Description: A constraint that follows a path
* ClutterPathConstraint:
*
* A constraint that follows a path
*
* #ClutterPathConstraint is a simple constraint that modifies the allocation
* of the #ClutterActor to which it has been applied using a #ClutterPath.
* of the [class@Actor] to which it has been applied using a [class@Path].
*
* By setting the #ClutterPathConstraint:offset property it is possible to
* control how far along the path the #ClutterActor should be.
* By setting the [property@PathConstraint:offset] property it is possible to
* control how far along the path the [class@Actor] should be.
*
* ClutterPathConstraint is available since Clutter 1.6.
* Since: 1.6.
*/
#include "clutter-build-config.h"
@ -244,7 +244,7 @@ clutter_path_constraint_class_init (ClutterPathConstraintClass *klass)
* @actor: the #ClutterActor using the @constraint
* @index: the index of the node that has been reached
*
* The ::node-reached signal is emitted each time a
* The signal is emitted each time a
* #ClutterPathConstraint:offset value results in the actor
* passing a #ClutterPathNode
*
@ -379,7 +379,7 @@ clutter_path_constraint_set_offset (ClutterPathConstraint *constraint,
* clutter_path_constraint_get_offset:
* @constraint: a #ClutterPathConstraint
*
* Retrieves the offset along the #ClutterPath used by @constraint.
* Retrieves the offset along the [class@Path] used by @constraint.
*
* Return value: the offset
*

8
clutter/clutter/clutter-path-constraint.h
View file

@ -38,14 +38,6 @@ G_BEGIN_DECLS
#define CLUTTER_PATH_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PATH_CONSTRAINT, ClutterPathConstraint))
#define CLUTTER_IS_PATH_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PATH_CONSTRAINT))
/**
* ClutterPathConstraint:
*
* #ClutterPathConstraint is an opaque structure
* whose members cannot be directly accessed
*
* Since: 1.6
*/
typedef struct _ClutterPathConstraint ClutterPathConstraint;
typedef struct _ClutterPathConstraintClass ClutterPathConstraintClass;

41
clutter/clutter/clutter-path.c
View file

@ -22,9 +22,9 @@
*/
/**
* SECTION:clutter-path
* @short_description: An object describing a path with straight lines
* and bezier curves.
* ClutterPath:
*
* An object describing a path with straight lines and bezier curves.
*
* A #ClutterPath contains a description of a path consisting of
* straight lines and bezier curves.
@ -42,7 +42,7 @@
* - %CLUTTER_PATH_CURVE_TO, creates a bezier curve. The end of the
* last node is used as the first control point and the three
* subsequent coordinates given in the node as used as the other three.
* -%CLUTTER_PATH_CLOSE, creates a straight line from the last node to
* - %CLUTTER_PATH_CLOSE, creates a straight line from the last node to
* the last %CLUTTER_PATH_MOVE_TO node. This can be used to close a
* path so that it will appear as a loop when animated.
*
@ -53,11 +53,11 @@
* direct screen positions.
*
* You can build a path using the node adding functions such as
* clutter_path_add_line_to(). Alternatively the path can be described
* [method@Path.add_line_to]. Alternatively the path can be described
* in a string using a subset of the SVG path syntax. See
* clutter_path_add_string() for details.
* [method@Path.add_string] for details.
*
* #ClutterPath is available since Clutter 1.0
* Since: 1.0
*/
#include "clutter-build-config.h"
@ -260,7 +260,7 @@ clutter_path_new (void)
* @desc: a string describing the path
*
* Creates a new #ClutterPath instance with the nodes described in
* @desc. See clutter_path_add_string() for details of the format of
* @desc. See [method@Path.add_string] for details of the format of
* the string.
*
* Return value: the newly created #ClutterPath
@ -370,7 +370,7 @@ clutter_path_add_move_to (ClutterPath *path,
* @x: the x coordinate
* @y: the y coordinate
*
* Same as clutter_path_add_move_to() except the coordinates are
* Same as [method@Path.add_move_to] except the coordinates are
* relative to the previous node.
*
* Since: 1.0
@ -412,7 +412,7 @@ clutter_path_add_line_to (ClutterPath *path,
* @x: the x coordinate
* @y: the y coordinate
*
* Same as clutter_path_add_line_to() except the coordinates are
* Same as [method@Path.add_line_to] except the coordinates are
* relative to the previous node.
*
* Since: 1.0
@ -470,7 +470,7 @@ clutter_path_add_curve_to (ClutterPath *path,
* @x_3: the x coordinate of the third control point
* @y_3: the y coordinate of the third control point
*
* Same as clutter_path_add_curve_to() except the coordinates are
* Same as [method@Path.add_curve_to] except the coordinates are
* relative to the previous node.
*
* Since: 1.0
@ -698,9 +698,9 @@ clutter_path_add_nodes (ClutterPath *path,
* For example, to move an actor in a 100 by 100 pixel square centered
* on the point 300,300 you could use the following path:
*
* |[
* ```
* M 250,350 l 0 -100 L 350,250 l 0 100 z
* ]|
* ```
*
* If the path description isn't valid %FALSE will be returned and no
* nodes will be added.
@ -924,11 +924,12 @@ clutter_path_get_node (ClutterPath *path,
* clutter_path_get_nodes:
* @path: a #ClutterPath
*
* Returns a #GSList of #ClutterPathNode<!-- -->s. The list should be
* freed with g_slist_free(). The nodes are owned by the path and
* should not be freed. Altering the path may cause the nodes in the
* list to become invalid so you should copy them if you want to keep
* the list.
* Returns a #GSList of [struct@PathNode]s.
*
* The list should be freed with g_slist_free(). The nodes are owned
* by the path and should not be freed. Altering the path may cause
* the nodes in the list to become invalid so you should copy them
* if you want to keep the list.
*
* Return value: (transfer container) (element-type Clutter.PathNode): a
* list of nodes in the path.
@ -1088,7 +1089,7 @@ clutter_path_replace_node (ClutterPath *path,
* @str: a string describing the path
*
* Replaces all of the nodes in the path with nodes described by
* @str. See clutter_path_add_string() for details of the format.
* @str. See [method@Path.add_string] for details of the format.
*
* If the string is invalid then %FALSE is returned and the path is
* unaltered.
@ -1122,7 +1123,7 @@ clutter_path_set_description (ClutterPath *path,
* @path: a #ClutterPath
*
* Returns a newly allocated string describing the path in the same
* format as used by clutter_path_add_string().
* format as used by [method@Path.add_string].
*
* Return value: a string description of the path. Free with g_free().
*

10
clutter/clutter/clutter-path.h
View file

@ -49,7 +49,7 @@ typedef struct _ClutterPathPrivate ClutterPathPrivate;
* @node: the node
* @data: (closure): optional data passed to the function
*
* This function is passed to clutter_path_foreach() and will be
* This function is passed to [method@Path.foreach] and will be
* called for each node contained in the path.
*
* Since: 1.0
@ -57,14 +57,6 @@ typedef struct _ClutterPathPrivate ClutterPathPrivate;
typedef void (* ClutterPathCallback) (const ClutterPathNode *node,
gpointer data);
/**
* ClutterPath:
*
* The #ClutterPath struct contains only private data and should
* be accessed with the functions below.
*
* Since: 1.0
*/
struct _ClutterPath
{
/*< private >*/

8
clutter/clutter/clutter-pick-context.c
View file

@ -138,7 +138,7 @@ clutter_pick_context_log_overlap (ClutterPickContext *pick_context,
* @box: a #ClutterActorBox
*
* Pushes a clip rectangle defined by @box into the pick stack. Pop with
* clutter_pick_context_pop_clip() when done.
* [method@PickContext.pop_clip] when done.
*/
void
clutter_pick_context_push_clip (ClutterPickContext *pick_context,
@ -152,7 +152,7 @@ clutter_pick_context_push_clip (ClutterPickContext *pick_context,
* @pick_context: a #ClutterPickContext
*
* Pops the current clip rectangle from the clip stack. It is a programming
* error to call this without a corresponding clutter_pick_context_push_clip()
* error to call this without a corresponding [method@PickContext.push_clip]
* call first.
*/
void
@ -167,7 +167,7 @@ clutter_pick_context_pop_clip (ClutterPickContext *pick_context)
* @transform: a #graphene_matrix_t
*
* Pushes @transform into the pick stack. Pop with
* clutter_pick_context_pop_transform() when done.
* [method@PickContext.pop_transform] when done.
*/
void
clutter_pick_context_push_transform (ClutterPickContext *pick_context,
@ -195,7 +195,7 @@ clutter_pick_context_get_transform (ClutterPickContext *pick_context,
* @pick_context: a #ClutterPickContext
*
* Pops the current transform from the clip stack. It is a programming error
* to call this without a corresponding clutter_pick_context_push_transform()
* to call this without a corresponding [method@PickContext.push_transform]
* call first.
*/
void

18
clutter/clutter/clutter-property-transition.c
View file

@ -20,14 +20,14 @@
*/
/**
* SECTION:clutter-property-transition
* @Title: ClutterPropertyTransition
* @Short_Description: Property transitions
* ClutterPropertyTransition:
*
* Property transitions
*
* #ClutterPropertyTransition is a specialized #ClutterTransition that
* can be used to tween a property of a #ClutterAnimatable instance.
* #ClutterPropertyTransition is a specialized [class@Transition] that
* can be used to tween a property of a [iface@Animatable] instance.
*
* #ClutterPropertyTransition is available since Clutter 1.10
* Since: 1.10
*/
#include "clutter-build-config.h"
@ -258,7 +258,7 @@ clutter_property_transition_class_init (ClutterPropertyTransitionClass *klass)
/**
* ClutterPropertyTransition:property-name:
*
* The name of the property of a #ClutterAnimatable to animate.
* The name of the property of a [iface@Animatable] to animate.
*
* Since: 1.10
*/
@ -322,7 +322,7 @@ clutter_property_transition_new (const char *property_name)
* @transition: a #ClutterPropertyTransition
* @property_name: (allow-none): a property name
*
* Sets the #ClutterPropertyTransition:property-name property of @transition.
* Sets the [property@PropertyTransition:property-name] property of @transition.
*
* Since: 1.10
*/
@ -360,7 +360,7 @@ clutter_property_transition_set_property_name (ClutterPropertyTransition *transi
* clutter_property_transition_get_property_name:
* @transition: a #ClutterPropertyTransition
*
* Retrieves the value of the #ClutterPropertyTransition:property-name
* Retrieves the value of the [property@PropertyTransition:property-name]
* property.
*
* Return value: the name of the property being animated, or %NULL if

8
clutter/clutter/clutter-property-transition.h
View file

@ -43,14 +43,6 @@ G_BEGIN_DECLS
typedef struct _ClutterPropertyTransitionPrivate ClutterPropertyTransitionPrivate;
typedef struct _ClutterPropertyTransitionClass ClutterPropertyTransitionClass;
/**
* ClutterPropertyTransition:
*
* The #ClutterPropertyTransition structure contains
* private data and should only be accessed using the provided API.
*
* Since: 1.10
*/
struct _ClutterPropertyTransition
{
/*< private >*/

10
clutter/clutter/clutter-rotate-action.c
View file

@ -23,11 +23,11 @@
*/
/**
* SECTION:clutter-rotate-action
* @Title: ClutterRotateAction
* @Short_Description: Action to rotate an actor
* ClutterRotateAction:
*
* Action to rotate an actor
*
* #ClutterRotateAction is a sub-class of #ClutterGestureAction that implements
* #ClutterRotateAction is a sub-class of [class@GestureAction] that implements
* the logic for recognizing rotate gestures using two touch points.
*
* Since: 1.12
@ -188,7 +188,7 @@ clutter_rotate_action_class_init (ClutterRotateActionClass *klass)
* @angle: the difference of angle of rotation between the initial
* rotation and the current rotation
*
* The ::rotate signal is emitted when a rotate gesture is
* The signal is emitted when a rotate gesture is
* recognized on the attached actor and when the gesture is
* cancelled (in this case with an angle value of 0).
*

8
clutter/clutter/clutter-rotate-action.h
View file

@ -44,14 +44,6 @@ typedef struct _ClutterRotateAction ClutterRotateAction;
typedef struct _ClutterRotateActionPrivate ClutterRotateActionPrivate;
typedef struct _ClutterRotateActionClass ClutterRotateActionClass;
/**
* ClutterRotateAction:
*
* The #ClutterRotateAction structure contains
* only private data and should be accessed using the provided API
*
* Since: 1.12
*/
struct _ClutterRotateAction
{
/*< private >*/

57
clutter/clutter/clutter-script.c
View file

@ -24,8 +24,9 @@
*/
/**
* SECTION:clutter-script
* @short_description: Loads a scene from UI definition data
* ClutterScript:
*
* Loads a scene from UI definition data
*
* #ClutterScript is an object used for loading and building parts or a
* complete scenegraph from external definition data in forms of string
@ -47,7 +48,7 @@
*
* A simple object might be defined as:
*
* <informalexample><programlisting><![CDATA[
* ```json
* {
* "id" : "red-button",
* "type" : "ClutterActor",
@ -55,20 +56,20 @@
* "height" : 100,
* "background-color" : "&num;ff0000ff"
* }
* ]]></programlisting></informalexample>
* ```
*
* This will produce a red #ClutterActor, 100x100 pixels wide, and
* This will produce a red [class@Actor], 100x100 pixels wide, and
* with a ClutterScript id of "red-button"; it can be retrieved by calling:
*
* |[
* ```c
* ClutterActor *red_button;
*
* red_button = CLUTTER_ACTOR (clutter_script_get_object (script, "red-button"));
* ]|
* ```
*
* and then manipulated with the Clutter API. For every object created
* using ClutterScript it is possible to check the id by calling
* clutter_get_script_id().
* [method@Scriptable.get_id].
*
* Packing can be represented using the "children" member, and passing an
* array of objects or ids of objects already defined (but not packed: the
@ -77,9 +78,9 @@
*
* Signal handlers can be defined inside a Clutter UI definition file and
* then autoconnected to their respective signals using the
* clutter_script_connect_signals() function:
* [method@Script.connect_signals] function:
*
* <informalexample><programlisting><![CDATA[
* ```json
* ...
* "signals" : [
* { "name" : "button-press-event", "handler" : "on_button_press" },
@ -90,7 +91,7 @@
* },
* ],
* ...
* ]]></programlisting></informalexample>
* ```
*
* Signal handler definitions must have a "name" and a "handler" members;
* they can also have the "after" and "swapped" boolean members (for the
@ -102,7 +103,7 @@
* through the usual GObject registration process should avoid using these
* names to avoid collisions:
*
* <programlisting><![CDATA[
* ```
* "id" := the unique name of a ClutterScript object
* "type" := the class literal name, also used to infer the type
* function
@ -112,9 +113,9 @@
* "is-default" := a boolean flag used when defining the #ClutterStage;
* if set to "true" the default stage will be used instead
* of creating a new #ClutterStage instance
* ]]></programlisting>
* ```
*
* #ClutterScript is available since Clutter 0.6
* Since: 0.6
*/
#include "clutter-build-config.h"
@ -334,9 +335,9 @@ clutter_script_class_init (ClutterScriptClass *klass)
/**
* ClutterScript:filename-set:
*
* Whether the #ClutterScript:filename property is set. If this property
* Whether the [property@Script:filename] property is set. If this property
* is %TRUE then the currently parsed data comes from a file, and the
* file name is stored inside the #ClutterScript:filename property.
* file name is stored inside the [property@Script:filename] property.
*
* Since: 0.6
*/
@ -350,7 +351,7 @@ clutter_script_class_init (ClutterScriptClass *klass)
/**
* ClutterScript:filename:
*
* The path of the currently parsed file. If #ClutterScript:filename-set
* The path of the currently parsed file. If [property@Script:filename-set]
* is %FALSE then the value of this property is undefined.
*
* Since: 0.6
@ -368,7 +369,7 @@ clutter_script_class_init (ClutterScriptClass *klass)
* The translation domain, used to localize strings marked as translatable
* inside a UI definition.
*
* If #ClutterScript:translation-domain is set to %NULL, #ClutterScript
* If [property@Script:translation-domain] is set to %NULL, #ClutterScript
* will use gettext(), otherwise g_dgettext() will be used.
*
* Since: 1.10
@ -437,7 +438,7 @@ clutter_script_new (void)
*
* Return value: on error, zero is returned and @error is set
* accordingly. On success, the merge id for the UI definitions is
* returned. You can use the merge id with clutter_script_unmerge_objects().
* returned. You can use the merge id with [method@Script.unmerge_objects].
*
* Since: 0.6
*/
@ -486,7 +487,7 @@ clutter_script_load_from_file (ClutterScript *script,
*
* Return value: on error, zero is returned and @error is set
* accordingly. On success, the merge id for the UI definitions is
* returned. You can use the merge id with clutter_script_unmerge_objects().
* returned. You can use the merge id with [method@Script.unmerge_objects].
*
* Since: 0.6
*/
@ -537,7 +538,7 @@ clutter_script_load_from_data (ClutterScript *script,
*
* Return value: on error, zero is returned and @error is set
* accordingly. On success, the merge id for the UI definitions is
* returned. You can use the merge id with clutter_script_unmerge_objects().
* returned. You can use the merge id with [method@Script.unmerge_objects].
*
* Since: 1.10
*/
@ -633,7 +634,7 @@ clutter_script_get_objects_valist (ClutterScript *script,
* names/return location pairs should be listed, with a %NULL pointer
* ending the list, like:
*
* |[
* ```c
* GObject *my_label, *a_button, *main_timeline;
*
* clutter_script_get_objects (script,
@ -641,7 +642,7 @@ clutter_script_get_objects_valist (ClutterScript *script,
* "a-button", &a_button,
* "main-timeline", &main_timeline,
* NULL);
* ]|
* ```
*
* Note: This function does not increment the reference count of the
* returned objects.
@ -883,7 +884,7 @@ clutter_script_default_connect (ClutterScript *script,
* Connects all the signals defined into a UI definition file to their
* handlers.
*
* This method invokes clutter_script_connect_signals_full() internally
* This method invokes [method@Script.connect_signals_full] internally
* and uses #GModule's introspective features (by opening the current
* module's scope) to look at the application's symbol table.
*
@ -994,7 +995,7 @@ connect_each_object (gpointer key,
* names using the native API, but it can also be used on platforms
* that do not support GModule.
*
* Applications should use clutter_script_connect_signals().
* Applications should use [method@Script.connect_signals].
*
* Since: 0.6
*/
@ -1030,7 +1031,7 @@ clutter_script_error_quark (void)
*
* Adds @paths to the list of search paths held by @script.
*
* The search paths are used by clutter_script_lookup_filename(), which
* The search paths are used by [method@Script.lookup_filename], which
* can be used to define search paths for the textures source file name
* or other custom, file-based properties.
*
@ -1157,7 +1158,7 @@ clutter_script_lookup_filename (ClutterScript *script,
* objects it returns.
*
* Return value: (transfer container) (element-type GObject.Object): a list
* of #GObject<!-- -->s, or %NULL. The objects are owned by the
* of `GObject`s, or %NULL. The objects are owned by the
* #ClutterScript instance. Use g_list_free() on the returned list when
* done.
*
@ -1219,7 +1220,7 @@ clutter_script_set_translation_domain (ClutterScript *script,
* @script: a #ClutterScript
*
* Retrieves the translation domain set using
* clutter_script_set_translation_domain().
* [method@Script.set_translation_domain].
*
* Return value: (transfer none): the translation domain, if any is set,
* or %NULL

8
clutter/clutter/clutter-script.h
View file

@ -97,14 +97,6 @@ typedef enum
CLUTTER_EXPORT
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 >*/

17
clutter/clutter/clutter-scriptable.c
View file

@ -25,15 +25,16 @@
*/
/**
* SECTION:clutter-scriptable
* @short_description: Override the UI definition parsing
* ClutterScriptable:
*
* Override the UI definition parsing
*
* The #ClutterScriptableIface interface exposes the UI definition parsing
* The #ClutterScriptable interface exposes the UI definition parsing
* process to external classes. By implementing this interface, a class can
* override the UI definition parsing and transform complex data types into
* GObject properties, or allow custom properties.
* [class@GObject.Object] properties, or allow custom properties.
*
* #ClutterScriptable is available since Clutter 0.6
* Since: 0.6
*/
#include "clutter-build-config.h"
@ -68,7 +69,7 @@ clutter_scriptable_default_init (ClutterScriptableInterface *iface)
*
* This name can be used by user interface designer applications to
* define a unique name for an object constructable using the UI
* definition language parsed by #ClutterScript.
* definition language parsed by [class@Script].
*
* Since: 0.6
*/
@ -95,7 +96,7 @@ clutter_scriptable_set_id (ClutterScriptable *scriptable,
* clutter_scriptable_get_id:
* @scriptable: a #ClutterScriptable
*
* Retrieves the id of @scriptable set using clutter_scriptable_set_id().
* Retrieves the id of @scriptable set using [method@Clutter.Scriptable.set_id].
*
* Return value: the id of the object. The returned string is owned by
* the scriptable object and should never be modified of freed
@ -125,7 +126,7 @@ clutter_scriptable_get_id (ClutterScriptable *scriptable)
* @node: the JSON node to be parsed
*
* Parses the passed JSON node. The implementation must set the type
* of the passed #GValue pointer using g_value_init().
* of the passed [struct@GObject.Value] pointer using g_value_init().
*
* Return value: %TRUE if the node was successfully parsed, %FALSE otherwise.
*

9
clutter/clutter/clutter-scriptable.h
View file

@ -43,15 +43,6 @@ G_BEGIN_DECLS
typedef struct _ClutterScriptable ClutterScriptable;
typedef struct _ClutterScriptableIface ClutterScriptableIface;
/**
* ClutterScriptable:
*
* #ClutterScriptable is an opaque structure whose members cannot be directly
* accessed
*
* Since: 0.6
*/
/**
* ClutterScriptableIface:
* @set_id: virtual function for setting the id of a scriptable object

16
clutter/clutter/clutter-scroll-actor.c
View file

@ -20,17 +20,17 @@
*/
/**
* SECTION:clutter-scroll-actor
* @Title: ClutterScrollActor
* @Short_Description: An actor for displaying a portion of its children
* ClutterScrollActor:
*
* An actor for displaying a portion of its children
*
* #ClutterScrollActor is an actor that can be used to display a portion
* of the contents of its children.
*
* The extent of the area of a #ClutterScrollActor is defined by the size
* of its children; the visible region of the children of a #ClutterScrollActor
* is set by using clutter_scroll_actor_scroll_to_point() or by using
* clutter_scroll_actor_scroll_to_rect() to define a point or a rectangle
* is set by using [method@ScrollActor.scroll_to_point] or by using
* [method@ScrollActor.scroll_to_rect] to define a point or a rectangle
* acting as the origin, respectively.
*
* #ClutterScrollActor does not provide pointer or keyboard event handling,
@ -39,7 +39,7 @@
* See [scroll-actor.c](https://git.gnome.org/browse/clutter/tree/examples/scroll-actor.c?h=clutter-1.18)
* for an example of how to use #ClutterScrollActor.
*
* #ClutterScrollActor is available since Clutter 1.12.
* Since: 1.12.
*/
#include "clutter-build-config.h"
@ -280,7 +280,7 @@ clutter_scroll_actor_new (void)
* @actor: a #ClutterScrollActor
* @mode: a #ClutterScrollMode
*
* Sets the #ClutterScrollActor:scroll-mode property.
* Sets the [property@ScrollActor:scroll-mode] property.
*
* Since: 1.12
*/
@ -306,7 +306,7 @@ clutter_scroll_actor_set_scroll_mode (ClutterScrollActor *actor,
* clutter_scroll_actor_get_scroll_mode:
* @actor: a #ClutterScrollActor
*
* Retrieves the #ClutterScrollActor:scroll-mode property
* Retrieves the [property@ScrollActor:scroll-mode] property
*
* Return value: the scrolling mode
*

8
clutter/clutter/clutter-scroll-actor.h
View file

@ -41,14 +41,6 @@ G_BEGIN_DECLS
typedef struct _ClutterScrollActorPrivate ClutterScrollActorPrivate;
typedef struct _ClutterScrollActorClass ClutterScrollActorClass;
/**
* ClutterScrollActor:
*
* The #ClutterScrollActor structure contains only
* private data, and should be accessed using the provided API.
*
* Since: 1.12
*/
struct _ClutterScrollActor
{
/*< private >*/

47
clutter/clutter/clutter-seat.c
View file

@ -140,7 +140,7 @@ clutter_seat_class_init (ClutterSeatClass *klass)
* @latched_mask: the latched modifier mask from stickykeys
* @locked_mask: the locked modifier mask from stickykeys
*
* The ::kbd-a11y-mods-state-changed signal is emitted each time either the
* The signal is emitted each time either the
* latched modifiers mask or locked modifiers mask are changed as the
* result of keyboard accessibilty's sticky keys operations.
*/
@ -163,9 +163,8 @@ clutter_seat_class_init (ClutterSeatClass *klass)
* @settings_flags: the new ClutterKeyboardA11yFlags configuration
* @changed_mask: the ClutterKeyboardA11yFlags changed
*
* The ::kbd-a11y-flags-changed signal is emitted each time the
* ClutterKeyboardA11yFlags configuration is changed as the result of
* keyboard accessibility operations.
* The signal is emitted each time the ClutterKeyboardA11yFlags
* configuration is changed as the result of keyboard accessibility operations.
*/
signals[KBD_A11Y_FLAGS_CHANGED] =
g_signal_new (I_("kbd-a11y-flags-changed"),
@ -185,9 +184,8 @@ clutter_seat_class_init (ClutterSeatClass *klass)
* @seat: the #ClutterSeat that emitted the signal
* @click_type: the new #ClutterPointerA11yDwellClickType mode
*
* The ::ptr-a11y-dwell-click-type-changed signal is emitted each time
* the ClutterPointerA11yDwellClickType mode is changed as the result
* of pointer accessibility operations.
* The signal is emitted each time the ClutterPointerA11yDwellClickType
* mode is changed as the result of pointer accessibility operations.
*/
signals[PTR_A11Y_DWELL_CLICK_TYPE_CHANGED] =
g_signal_new (I_("ptr-a11y-dwell-click-type-changed"),
@ -204,9 +202,8 @@ clutter_seat_class_init (ClutterSeatClass *klass)
* @timeout_type: the type of timeout #ClutterPointerA11yTimeoutType
* @delay: the delay in ms before secondary-click is triggered.
*
* The ::ptr-a11y-timeout-started signal is emitted when a
* pointer accessibility timeout delay is started, so that upper
* layers can notify the user with some visual feedback.
* The signal is emitted when a pointer accessibility timeout delay is started,
* so that upper layers can notify the user with some visual feedback.
*/
signals[PTR_A11Y_TIMEOUT_STARTED] =
g_signal_new (I_("ptr-a11y-timeout-started"),
@ -229,10 +226,10 @@ clutter_seat_class_init (ClutterSeatClass *klass)
* @timeout_type: the type of timeout #ClutterPointerA11yTimeoutType
* @clicked: %TRUE if the timeout finished and triggered a click
*
* The ::ptr-a11y-timeout-stopped signal is emitted when a running
* pointer accessibility timeout delay is stopped, either because
* it's triggered at the end of the delay or cancelled, so that
* upper layers can notify the user with some visual feedback.
* The signal is emitted when a running pointer accessibility timeout
* delay is stopped, either because it's triggered at the end of
* the delay or cancelled, so that upper layers can notify the user
* with some visual feedback.
*/
signals[PTR_A11Y_TIMEOUT_STOPPED] =
g_signal_new (I_("ptr-a11y-timeout-stopped"),
@ -252,10 +249,10 @@ clutter_seat_class_init (ClutterSeatClass *klass)
* ClutterSeat::is-unfocus-inhibited-changed:
* @seat: the #ClutterSeat that emitted the signal
*
* The ::is-unfocus-inhibited-changed signal is emitted when the
* property to inhibit the unsetting of the focus-surface of the
* #ClutterSeat changed. To get the current state of this property,
* use clutter_seat_is_unfocus_inhibited().
* The signal is emitted when the property to inhibit the unsetting
* of the focus-surface of the #ClutterSeat changed.
*
* To get the current state of this property, use [method@Seat.is_unfocus_inhibited].
*/
signals[IS_UNFOCUS_INHIBITED_CHANGED] =
g_signal_new (I_("is-unfocus-inhibited-changed"),
@ -268,7 +265,7 @@ clutter_seat_class_init (ClutterSeatClass *klass)
* ClutterSeat:touch-mode:
*
* The current touch-mode of the #ClutterSeat, it is set to %TRUE if the
* requirements documented in clutter_seat_get_touch_mode() are fulfilled.
* requirements documented in [method@Seat.get_touch_mode] are fulfilled.
**/
props[PROP_TOUCH_MODE] =
g_param_spec_boolean ("touch-mode",
@ -477,8 +474,8 @@ clutter_seat_set_pointer_a11y_dwell_click_type (ClutterSeat
* Inhibits unsetting of the pointer focus-surface for the #ClutterSeat @seat,
* this allows to keep using the pointer even when it's hidden.
*
* This property is refcounted, so clutter_seat_uninhibit_unfocus() must be
* called the exact same number of times as clutter_seat_inhibit_unfocus()
* This property is refcounted, so [method@Seat.uninhibit_unfocus] must be
* called the exact same number of times as [method@Seat.inhibit_unfocus]
* was called before.
**/
void
@ -501,10 +498,10 @@ clutter_seat_inhibit_unfocus (ClutterSeat *seat)
* @seat: a #ClutterSeat
*
* Disables the inhibiting of unsetting of the pointer focus-surface
* previously enabled by calling clutter_seat_inhibit_unfocus().
* previously enabled by calling [method@Seat.inhibit_unfocus].
*
* This property is refcounted, so clutter_seat_uninhibit_unfocus() must be
* called the exact same number of times as clutter_seat_inhibit_unfocus()
* This property is refcounted, so [method@Seat.uninhibit_unfocus] must be
* called the exact same number of times as [method@Seat.inhibit_unfocus]
* was called before.
**/
void
@ -634,7 +631,7 @@ clutter_seat_warp_pointer (ClutterSeat *seat,
* @seat: a #ClutterSeat
*
* Gets the current touch-mode state of the #ClutterSeat @seat.
* The #ClutterSeat:touch-mode property is set to %TRUE if the following
* The [property@Seat:touch-mode] property is set to %TRUE if the following
* requirements are fulfilled:
*
* - A touchscreen is available

24
clutter/clutter/clutter-settings.c
View file

@ -1,7 +1,7 @@
/**
* SECTION:clutter-settings
* @Title: ClutterSettings
* @Short_Description: Settings configuration
* ClutterSettings:
*
* Settings configuration
*
* Clutter depends on some settings to perform operations like detecting
* multiple button press events, or font options to render text.
@ -14,7 +14,7 @@
* the #ClutterSettings properties when implementing new UI elements,
* for instance the default font name.
*
* #ClutterSettings is available since Clutter 1.4
* Since: 1.4
*/
#include "clutter-build-config.h"
@ -53,14 +53,6 @@ typedef struct
const char *clutter_font_subpixel_order;
} FontSettings;
/**
* ClutterSettings:
*
* `ClutterSettings` is an opaque structure whose
* members cannot be directly accessed.
*
* Since: 1.4
*/
struct _ClutterSettings
{
GObject parent_instance;
@ -787,7 +779,7 @@ clutter_settings_class_init (ClutterSettingsClass *klass)
/**
* ClutterSettings:backend:
*
* A back pointer to the #ClutterBackend
* A back pointer to the [class@Backend]
*
* Since: 1.4
*
@ -854,7 +846,7 @@ clutter_settings_class_init (ClutterSettingsClass *klass)
* ClutterSettings:font-name:
*
* The default font name that should be used by text actors, as
* a string that can be passed to pango_font_description_from_string().
* a string that can be passed to [func@Pango.FontDescription.from_string].
*
* Since: 1.4
*/
@ -971,7 +963,7 @@ clutter_settings_class_init (ClutterSettingsClass *klass)
* Sets the minimum duration for a press to be recognized as a long press
* gesture. The duration is expressed in milliseconds.
*
* See also #ClutterClickAction:long-press-duration.
* See also [property@ClickAction:long-press-duration].
*
* Since: 1.8
*/
@ -995,7 +987,7 @@ clutter_settings_class_init (ClutterSettingsClass *klass)
* ClutterText:password-hint-time:
*
* How long should Clutter show the last input character in editable
* ClutterText actors. The value is in milliseconds. A value of 0
* [class@Text] actors. The value is in milliseconds. A value of 0
* disables showing the password hint. 600 is a good value for
* enabling the hint.
*

55
clutter/clutter/clutter-shader-effect.c
View file

@ -23,29 +23,28 @@
*/
/**
* SECTION:clutter-shader-effect
* @short_description: Base class for shader effects
* @See_Also: #ClutterEffect, #ClutterOffscreenEffect
*
* ClutterShaderEffect:
*
* Base class for shader effects
*
* #ClutterShaderEffect is a class that implements all the plumbing for
* creating #ClutterEffect<!-- -->s using GLSL shaders.
* creating [class@Effect]s using GLSL shaders.
*
* #ClutterShaderEffect creates an offscreen buffer and then applies the
* GLSL shader (after checking whether the compilation and linking were
* successful) to the buffer before painting it on screen.
*
* #ClutterShaderEffect is available since Clutter 1.4
*
* ## Implementing a ClutterShaderEffect
*
* Creating a sub-class of #ClutterShaderEffect requires the
* overriding of the #ClutterOffscreenEffectClass.paint_target() virtual
* function from the #ClutterOffscreenEffect class. It is also convenient
* to implement the #ClutterShaderEffectClass.get_static_shader_source()
* overriding of the [vfunc@OffscreenEffect.paint_target] virtual
* function from the [class@OffscreenEffect] class. It is also convenient
* to implement the [vfunc@ShaderEffect.get_static_shader_source]
* virtual function in case you are planning to create more than one
* instance of the effect.
*
* The #ClutterShaderEffectClass.get_static_shader_source()
* The [vfunc@ShaderEffect.get_static_shader_source]
* function should return a copy of the shader source to use. This
* function is only called once per subclass of #ClutterShaderEffect
* regardless of how many instances of the effect are created. The
@ -53,20 +52,20 @@
* string which is returned from this function via
* g_strdup().
*
* The #ClutterOffscreenEffectClass.paint_target() should set the
* The [vfunc@OffscreenEffect.paint_target] should set the
* shader's uniforms if any. This is done by calling
* clutter_shader_effect_set_uniform_value() or
* clutter_shader_effect_set_uniform(). The sub-class should then
* [method@ShaderEffect.set_uniform_value] or
* [method@ShaderEffect.set_uniform]. The sub-class should then
* chain up to the #ClutterShaderEffect implementation.
*
* ## Setting uniforms on a ClutterShaderEffect
*
* The example below shows a typical implementation of the
* #ClutterShaderEffectClass.get_static_shader_source() and
* #ClutterOffscreenEffectClass.paint_target() virtual functions
* [vfunc@ShaderEffect.get_static_shader_source] and
* [vfunc@OffscreenEffect.paint_target] virtual functions
* for a #ClutterShaderEffect subclass.
*
* |[<!-- language="C" -->
* ```c
* static gchar *
* my_effect_get_static_shader_source (ClutterShaderEffect *effect)
* {
@ -108,7 +107,9 @@
* parent_class = CLUTTER_OFFSCREEN_EFFECT_CLASS (my_effect_parent_class);
* return parent_class->paint_target (effect);
* }
* ]|
* ```
*
* Since: 1.4
*/
#include "clutter-build-config.h"
@ -486,9 +487,9 @@ clutter_shader_effect_init (ClutterShaderEffect *effect)
* or %CLUTTER_VERTEX_SHADER
*
* Creates a new #ClutterShaderEffect, to be applied to an actor using
* clutter_actor_add_effect().
* [method@Actor.add_effect].
*
* The effect will be empty until clutter_shader_effect_set_shader_source()
* The effect will be empty until [method@ShaderEffect.set_shader_source]
* is called.
*
* Return value: the newly created #ClutterShaderEffect.
@ -780,16 +781,16 @@ add_uniform:
* argument, and by the @gtype argument. For instance, a uniform named
* "sampler0" and containing a single integer value is set using:
*
* |[<!-- language="C" -->
* ```c
* clutter_shader_effect_set_uniform (effect, "sampler0",
* G_TYPE_INT, 1,
* 0);
* ]|
* ```
*
* While a uniform named "components" and containing a 3-elements vector
* of floating point values (a "vec3") can be set using:
*
* |[<!-- language="C" -->
* ```c
* gfloat component_r, component_g, component_b;
*
* clutter_shader_effect_set_uniform (effect, "components",
@ -797,28 +798,28 @@ add_uniform:
* component_r,
* component_g,
* component_b);
* ]|
* ```
*
* or can be set using:
*
* |[<!-- language="C" -->
* ```c
* gfloat component_vec[3];
*
* clutter_shader_effect_set_uniform (effect, "components",
* CLUTTER_TYPE_SHADER_FLOAT, 3,
* component_vec);
* ]|
* ```
*
* Finally, a uniform named "map" and containing a matrix can be set using:
*
* |[<!-- language="C" -->
* ```c
* float v[16];
*
* cogl_matrix_to_float (&matrix, v);
* clutter_shader_effect_set_uniform (effect, "map",
* CLUTTER_TYPE_SHADER_MATRIX,
* 1, v);
* ]|
* ```
*
* Since: 1.4
*/

8
clutter/clutter/clutter-shader-effect.h
View file

@ -44,14 +44,6 @@ typedef struct _ClutterShaderEffect ClutterShaderEffect;
typedef struct _ClutterShaderEffectPrivate ClutterShaderEffectPrivate;
typedef struct _ClutterShaderEffectClass ClutterShaderEffectClass;
/**
* ClutterShaderEffect:
*
* The #ClutterShaderEffect structure contains
* only private data and should be accessed using the provided API
*
* Since: 1.4
*/
struct _ClutterShaderEffect
{
/*< private >*/

12
clutter/clutter/clutter-shader-types.c
View file

@ -386,7 +386,7 @@ clutter_shader_matrix_get_type (void)
* @size: number of floating point values in @floats
* @floats: (array length=size): an array of floating point values
*
* Sets @floats as the contents of @value. The passed #GValue
* Sets @floats as the contents of @value. The passed [struct@GObject.Value]
* must have been initialized using %CLUTTER_TYPE_SHADER_FLOAT.
*
* Since: 0.8
@ -416,7 +416,7 @@ clutter_value_set_shader_float (GValue *value,
* @size: number of integer values in @ints
* @ints: (array length=size): an array of integer values
*
* Sets @ints as the contents of @value. The passed #GValue
* Sets @ints as the contents of @value. The passed [struct@GObject.Value]
* must have been initialized using %CLUTTER_TYPE_SHADER_INT.
*
* Since: 0.8
@ -446,7 +446,7 @@ clutter_value_set_shader_int (GValue *value,
* @size: number of floating point values in @floats
* @matrix: (array length=size): a matrix of floating point values
*
* Sets @matrix as the contents of @value. The passed #GValue
* Sets @matrix as the contents of @value. The passed [struct@GObject.Value]
* must have been initialized using %CLUTTER_TYPE_SHADER_MATRIX.
*
* Since: 0.8
@ -477,7 +477,7 @@ clutter_value_set_shader_matrix (GValue *value,
* point values, or %NULL
*
* Retrieves the list of floating point values stored inside
* the passed #GValue. @value must have been initialized with
* the passed [struct@GObject.Value]. @value must have been initialized with
* %CLUTTER_TYPE_SHADER_FLOAT.
*
* Return value: (array length=length): the pointer to a list of
@ -509,7 +509,7 @@ clutter_value_get_shader_float (const GValue *value,
* values, or %NULL
*
* Retrieves the list of integer values stored inside the passed
* #GValue. @value must have been initialized with
* [struct@GObject.Value]. @value must have been initialized with
* %CLUTTER_TYPE_SHADER_INT.
*
* Return value: (array length=length): the pointer to a list of
@ -541,7 +541,7 @@ clutter_value_get_shader_int (const GValue *value,
* point values, or %NULL
*
* Retrieves a matrix of floating point values stored inside
* the passed #GValue. @value must have been initialized with
* the passed [struct@GObject.Value]. @value must have been initialized with
* %CLUTTER_TYPE_SHADER_MATRIX.
*
* Return value: (array length=length) (transfer none): the pointer to a matrix

32
clutter/clutter/clutter-snap-constraint.c
View file

@ -23,16 +23,16 @@
*/
/**
* SECTION:clutter-snap-constraint
* @Title: ClutterSnapConstraint
* @Short_Description: A constraint snapping two actors together
* ClutterSnapConstraint:
*
* A constraint snapping two actors together
*
* #ClutterSnapConstraint is a constraint the snaps the edges of two
* actors together, expanding the actor's allocation if necessary.
*
* An offset can be applied to the constraint, to provide spacing.
*
* #ClutterSnapConstraint is available since Clutter 1.6
* Since: 1.6
*/
#include "clutter-build-config.h"
@ -310,7 +310,7 @@ clutter_snap_constraint_class_init (ClutterSnapConstraintClass *klass)
/**
* ClutterSnapConstraint:source:
*
* The #ClutterActor used as the source for the constraint
* The [class@Actor] used as the source for the constraint
*
* Since: 1.6
*/
@ -324,7 +324,7 @@ clutter_snap_constraint_class_init (ClutterSnapConstraintClass *klass)
/**
* ClutterSnapConstraint:from-edge:
*
* The edge of the #ClutterActor that should be snapped
* The edge of the [class@Actor] that should be snapped
*
* Since: 1.6
*/
@ -339,7 +339,7 @@ clutter_snap_constraint_class_init (ClutterSnapConstraintClass *klass)
/**
* ClutterSnapConstraint:to-edge:
*
* The edge of the #ClutterSnapConstraint:source that should be snapped
* The edge of the [property@SnapConstraint:source] that should be snapped
*
* Since: 1.6
*/
@ -354,8 +354,8 @@ clutter_snap_constraint_class_init (ClutterSnapConstraintClass *klass)
/**
* ClutterSnapConstraint:offset:
*
* The offset, in pixels, between #ClutterSnapConstraint:from-edge
* and #ClutterSnapConstraint:to-edge
* The offset, in pixels, between [property@SnapConstraint:from-edge]
* and [property@SnapConstraint:to-edge]
*
* Since: 1.6
*/
@ -393,7 +393,7 @@ clutter_snap_constraint_init (ClutterSnapConstraint *self)
* @to_edge: the edge of @source to use in the constraint
* @offset: the offset to apply to the constraint, in pixels
*
* Creates a new #ClutterSnapConstraint that will snap a #ClutterActor
* Creates a new #ClutterSnapConstraint that will snap a [class@Actor]
* to the @edge of @source, with the given @offset.
*
* Return value: the newly created #ClutterSnapConstraint
@ -421,7 +421,7 @@ clutter_snap_constraint_new (ClutterActor *source,
* @constraint: a #ClutterSnapConstraint
* @source: (allow-none): a #ClutterActor, or %NULL to unset the source
*
* Sets the source #ClutterActor for the constraint
* Sets the source [class@Actor] for the constraint
*
* Since: 1.6
*/
@ -469,7 +469,7 @@ clutter_snap_constraint_set_source (ClutterSnapConstraint *constraint,
* clutter_snap_constraint_get_source:
* @constraint: a #ClutterSnapConstraint
*
* Retrieves the #ClutterActor set using clutter_snap_constraint_set_source()
* Retrieves the [class@Actor] set using [method@SnapConstraint.set_source]
*
* Return value: (transfer none): a pointer to the source actor
*
@ -491,9 +491,9 @@ clutter_snap_constraint_get_source (ClutterSnapConstraint *constraint)
*
* Sets the edges to be used by the @constraint
*
* The @from_edge is the edge on the #ClutterActor to which @constraint
* has been added. The @to_edge is the edge of the #ClutterActor inside
* the #ClutterSnapConstraint:source property.
* The @from_edge is the edge on the [class@Actor] to which @constraint
* has been added. The @to_edge is the edge of the [class@Actor] inside
* the [property@SnapConstraint:source] property.
*
* Since: 1.6
*/
@ -587,7 +587,7 @@ clutter_snap_constraint_set_offset (ClutterSnapConstraint *constraint,
* clutter_snap_constraint_get_offset:
* @constraint: a #ClutterSnapConstraint
*
* Retrieves the offset set using clutter_snap_constraint_set_offset()
* Retrieves the offset set using [method@SnapConstraint.set_offset]
*
* Return value: the offset, in pixels
*

8
clutter/clutter/clutter-snap-constraint.h
View file

@ -37,14 +37,6 @@ G_BEGIN_DECLS
#define CLUTTER_SNAP_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_SNAP_CONSTRAINT, ClutterSnapConstraint))
#define CLUTTER_IS_SNAP_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_SNAP_CONSTRAINT))
/**
* ClutterSnapConstraint:
*
* #ClutterSnapConstraint is an opaque structure
* whose members cannot be directly accesses
*
* Since: 1.6
*/
typedef struct _ClutterSnapConstraint ClutterSnapConstraint;
typedef struct _ClutterSnapConstraintClass ClutterSnapConstraintClass;

17
clutter/clutter/clutter-stage-manager.c
View file

@ -22,18 +22,19 @@
*/
/**
* SECTION:clutter-stage-manager
* @short_description: Maintains the list of stages
* ClutterStageManager:
*
* Maintains the list of stages
*
* #ClutterStageManager is a singleton object, owned by Clutter, which
* maintains the list of currently active stages
*
* Every newly-created #ClutterStage will cause the emission of the
* #ClutterStageManager::stage-added signal; once a #ClutterStage has
* been destroyed, the #ClutterStageManager::stage-removed signal will
* Every newly-created [class@Stage] will cause the emission of the
* [signal@StageManager::stage-added] signal; once a [class@Stage] has
* been destroyed, the [signal@StageManager::stage-removed] signal will
* be emitted
*
* #ClutterStageManager is available since Clutter 0.8
* Since: 0.8
*/
#include "clutter-build-config.h"
@ -122,7 +123,7 @@ clutter_stage_manager_class_init (ClutterStageManagerClass *klass)
* @stage_manager: the object which received the signal
* @stage: the added stage
*
* The ::stage-added signal is emitted each time a new #ClutterStage
* The signal is emitted each time a new #ClutterStage
* has been added to the stage manager.
*
* Since: 0.8
@ -140,7 +141,7 @@ clutter_stage_manager_class_init (ClutterStageManagerClass *klass)
* @stage_manager: the object which received the signal
* @stage: the removed stage
*
* The ::stage-removed signal is emitted each time a #ClutterStage
* The signal is emitted each time a #ClutterStage
* has been removed from the stage manager.
*
* Since: 0.8

Some files were not shown because too many files have changed in this diff Show more