From f687ec6a226fa3914c6cf81fbad6b43786a2e1dc Mon Sep 17 00:00:00 2001
From: Chris Lord <chris@linux.intel.com>
Date: Wed, 24 Nov 2010 16:34:21 +0000
Subject: [PATCH] docs: Update documentation to reflect automatic
 map/unmap/etc.

Update the ClutterActor documentation to reflect the new automatic
map/unmap/realize/unrealize implementations.
---
 clutter/clutter-actor.h                            |  6 ++++--
 doc/reference/clutter/subclassing-ClutterActor.xml | 10 +---------
 2 files changed, 5 insertions(+), 11 deletions(-)

diff --git a/clutter/clutter-actor.h b/clutter/clutter-actor.h
index 46eaac430..036f24268 100644
--- a/clutter/clutter-actor.h
+++ b/clutter/clutter-actor.h
@@ -173,9 +173,11 @@ struct _ClutterActor
  * @unrealize: virtual function, used to deallocate resources allocated
  *   in ::realize; it should chain up to the parent's implementation
  * @map: virtual function for containers and composite actors, to
- *   map their children; it must chain up to the parent's implementation
+ *   map their children; it must chain up to the parent's implementation.
+ *   Overriding this function is optional.
  * @unmap: virtual function for containers and composite actors, to
- *   unmap their children; it must chain up to the parent's implementation
+ *   unmap their children; it must chain up to the parent's implementation.
+ *   Overriding this function is optional.
  * @paint: virtual function, used to paint the actor
  * @get_preferred_width: virtual function, used when querying the minimum
  *   and natural widths of an actor for a given height; it is used by
diff --git a/doc/reference/clutter/subclassing-ClutterActor.xml b/doc/reference/clutter/subclassing-ClutterActor.xml
index 068ac1ac5..a9ef7b4e8 100644
--- a/doc/reference/clutter/subclassing-ClutterActor.xml
+++ b/doc/reference/clutter/subclassing-ClutterActor.xml
@@ -80,15 +80,7 @@ foo_actor_init (FooActor *actor)
         <listitem><para>used by containers and composite actors to
         determine whether their children should allocate (and deallocate)
         specific resources associated with being added to the #ClutterStage,
-        and whether their children should be painted or not. A
-        #ClutterContainer implementation should not care about overriding
-        the <classname>ClutterActor</classname>::realize(),
-        <classname>ClutterActor</classname>::unrealize(),
-        <classname>ClutterActor</classname>::map() and
-        <classname>ClutterActor</classname>::unmap() virtual functions, but
-        composite actors with private children MUST implement at least
-        <classname>ClutterActor</classname>::map() and
-        <classname>ClutterActor</classname>::unmap().</para></listitem>
+        and whether their children should be painted or not.</para></listitem>
       </varlistentry>
 
     </variablelist>