[gnome-shell/wip/gdm-shell: 1/16] st-box-layout: Document insertion apis

[Ray Strode <halfline src gnome org>]

commit 02e498d52041dd4fcd5f0d06a58797262d44783e
Author: Ray Strode <rstrode redhat com>
Date:   Fri Aug 19 13:41:08 2011 -0400

    st-box-layout: Document insertion apis
    
    This commit just adds some brief doc comments
    to st_box_layout_insert_actor() and
    st_box_layout_insert_before()

 src/st/st-box-layout.c |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
---
diff --git a/src/st/st-box-layout.c b/src/st/st-box-layout.c
index e0b6043..453a3c2 100644
--- a/src/st/st-box-layout.c
+++ b/src/st/st-box-layout.c
@@ -1206,6 +1206,17 @@ st_box_layout_get_pack_start (StBoxLayout *box)
   return box->priv->is_pack_start;
 }
 
+/**
+ * st_box_layout_insert_actor:
+ * @self: A #StBoxLayout
+ * @actor: A #ClutterActor
+ * @pos: position to insert actor
+ *
+ * Adds @actor to @self at position @pos.  If @pos is
+ * negative or larger than the number of elements in the
+ * list then @actor is added after all the others previously
+ * added.
+ */
 void
 st_box_layout_insert_actor (StBoxLayout  *self,
                             ClutterActor *actor,
@@ -1215,6 +1226,16 @@ st_box_layout_insert_actor (StBoxLayout  *self,
   st_container_move_child (ST_CONTAINER (self), actor, pos);
 }
 
+/**
+ * st_box_layout_insert_before:
+ * @self: A #StBoxLayout
+ * @actor: A #ClutterActor
+ * @sibling: A previously added #ClutterActor
+ *
+ * Adds @actor to @self at the position before @sibling.
+ * @sibling cannot be %NULL and must be already a child
+ * of @self.
+ */
 void
 st_box_layout_insert_before (StBoxLayout  *self,
                              ClutterActor *actor,