From 9686266fd3024fd323fb232d2a8e46baf5d86b37 Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@openedhand.com>
Date: Tue, 7 Aug 2007 14:03:08 +0000
Subject: [PATCH] Documentation fixes

---
 clutter/clutter-actor.h            | 39 ++++++++++++++++++++++++++++++
 clutter/clutter-alpha.h            | 18 +++++++++++++-
 doc/reference/clutter-sections.txt |  4 +--
 3 files changed, 58 insertions(+), 3 deletions(-)

diff --git a/clutter/clutter-actor.h b/clutter/clutter-actor.h
index 01bfde4ed..09cb14c6b 100644
--- a/clutter/clutter-actor.h
+++ b/clutter/clutter-actor.h
@@ -63,6 +63,13 @@ typedef struct _ClutterActorClass    ClutterActorClass;
 typedef struct _ClutterActorBox      ClutterActorBox;
 typedef struct _ClutterActorPrivate  ClutterActorPrivate;
 
+/**
+ * ClutterCallback:
+ * @actor: a #ClutterActor
+ * @data: user data
+ *
+ * Generic callback
+ */
 typedef void (*ClutterCallback) (ClutterActor *actor, gpointer data);
 #define CLUTTER_CALLBACK(f)	((ClutterCallback) (f))
 
@@ -122,10 +129,42 @@ struct _ClutterActor
   ClutterActorPrivate *priv;
 };
 
+/**
+ * ClutterActorClass:
+ * @show: signal class handler for the ClutterActor::show signal
+ * @show_all: virtual function for containers and composite actors, to
+ *   determine which children should be shown when calling
+ *   clutter_actor_show_all() on the actor. Defaults to calling
+ *   clutter_actor_show().
+ * @hide: signal class handler for the ClutterActor::hide signal
+ * @hide_all: virtual function for containers and composite actors, to
+ *   determine which children should be shown when calling
+ *   clutter_actor_hide_all() on the actor. Defaults to calling
+ *   clutter_actor_show().
+ * @realize: virtual function, used to allocate resources for the actor;
+ *   it should chain up to the parent's implementation
+ * @unrealize: virtual function, used to deallocate resources allocated
+ *   in ::realized; it should chain up to the parent's implementation
+ * @paint: virtual function, used to paint the actor
+ * @request_coords: virtual function, used when setting the coordinates
+ *   of an actor
+ * @query_coords: virtual function, used when querying the actor for
+ *   its coordinates
+ * @set_depth: virtual function, used when setting the depth
+ * @get_depth: virtual function, used when getting the depth
+ * @parent_set: signal class closure for the ClutterActor::parent-set
+ *   signal
+ * @destroy: signal class closure for the ClutterActor::destroy signal
+ * @pick: virtual functions, used to draw an outline of the actor
+ *
+ * Base class for actors.
+ */
 struct _ClutterActorClass
 {
+  /*< private >*/
   GInitiallyUnownedClass parent_class;
 
+  /*< public >*/
   void (* show)            (ClutterActor        *actor);
   void (* show_all)        (ClutterActor        *actor);
   void (* hide)            (ClutterActor        *actor);
diff --git a/clutter/clutter-alpha.h b/clutter/clutter-alpha.h
index c6a65b0f4..242f21242 100644
--- a/clutter/clutter-alpha.h
+++ b/clutter/clutter-alpha.h
@@ -61,6 +61,16 @@ typedef struct _ClutterAlpha        ClutterAlpha;
 typedef struct _ClutterAlphaClass   ClutterAlphaClass; 
 typedef struct _ClutterAlphaPrivate ClutterAlphaPrivate;
 
+/**
+ * ClutterAlphaFunc:
+ * @alpha: a #ClutterAlpha
+ * @user_data: user data passed to the function
+ *
+ * A function of time, which returns a value between 0 and
+ * %CLUTTER_ALPHA_MAX_ALPHA
+ *
+ * Since: 0.2
+ */
 typedef guint32 (*ClutterAlphaFunc) (ClutterAlpha *alpha,
                                      gpointer      user_data); 
 
@@ -82,7 +92,13 @@ struct _ClutterAlphaClass
   void (*_clutter_alpha_5) (void);
 }; 
 
-
+/**
+ * CLUTTER_ALPHA_MAX_ALPHA:
+ *
+ * Maximum value returned by #ClutterAlphaFunc
+ *
+ * Since: 0.2
+ */
 #define CLUTTER_ALPHA_MAX_ALPHA 0xffff
 
 GType clutter_alpha_get_type (void) G_GNUC_CONST;
diff --git a/doc/reference/clutter-sections.txt b/doc/reference/clutter-sections.txt
index cf1b2bc2b..36d42f84c 100644
--- a/doc/reference/clutter-sections.txt
+++ b/doc/reference/clutter-sections.txt
@@ -111,8 +111,6 @@ clutter_behaviour_get_type
 <SECTION>
 <FILE>clutter-alpha</FILE>
 <TITLE>ClutterAlpha</TITLE>
-ClutterAlpha
-ClutterAlphaClass
 clutter_alpha_new
 clutter_alpha_new_full
 clutter_alpha_get_alpha
@@ -152,6 +150,8 @@ CLUTTER_TYPE_ALPHA
 CLUTTER_ALPHA_CLASS
 CLUTTER_IS_ALPHA_CLASS
 CLUTTER_ALPHA_GET_CLASS
+ClutterAlpha
+ClutterAlphaClass
 <SUBSECTION Private>
 ClutterAlphaPrivate
 clutter_alpha_get_type