From c6f67bf872ec2b51951a554e0351e6d7615d28ce Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@linux.intel.com>
Date: Wed, 16 Sep 2009 11:10:38 +0100
Subject: [PATCH] [layout, docs] Document FixedLayout

---
 clutter/clutter-fixed-layout.c | 45 ++++++++++++++++++++++++++++++++++
 clutter/clutter-fixed-layout.h | 42 +++++++++++++++++++++++++++++++
 2 files changed, 87 insertions(+)

diff --git a/clutter/clutter-fixed-layout.c b/clutter/clutter-fixed-layout.c
index f3e3d385d..f558c132d 100644
--- a/clutter/clutter-fixed-layout.c
+++ b/clutter/clutter-fixed-layout.c
@@ -1,3 +1,39 @@
+/*
+ * Clutter.
+ *
+ * An OpenGL based 'interactive canvas' library.
+ *
+ * Copyright (C) 2009  Intel Corporation.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author:
+ *   Emmanuele Bassi <ebassi@linux.intel.com>
+ *
+ * Based on the fixed layout code inside clutter-group.c
+ */
+
+/**
+ * SECTION:clutter-fixed-layout
+ * @short_description: A fixed layout manager
+ *
+ * #ClutterFixedLayout is a layout manager implementing the same
+ * layout policies as #ClutterGroup.
+ *
+ * #ClutterFixedLayout is available since Clutter 1.2
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -210,6 +246,15 @@ clutter_fixed_layout_init (ClutterFixedLayout *self)
 {
 }
 
+/**
+ * clutter_fixed_layout_new:
+ *
+ * Creates a new #ClutterFixedLayout
+ *
+ * Return value: the newly created #ClutterFixedLayout
+ *
+ * Since: 1.2
+ */
 ClutterLayoutManager *
 clutter_fixed_layout_new (void)
 {
diff --git a/clutter/clutter-fixed-layout.h b/clutter/clutter-fixed-layout.h
index b8075172a..32273bc00 100644
--- a/clutter/clutter-fixed-layout.h
+++ b/clutter/clutter-fixed-layout.h
@@ -1,3 +1,27 @@
+/*
+ * Clutter.
+ *
+ * An OpenGL based 'interactive canvas' library.
+ *
+ * Copyright (C) 2009  Intel Corporation.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author:
+ *   Emmanuele Bassi <ebassi@linux.intel.com>
+ */
+
 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
 #error "Only <clutter/clutter.h> can be included directly."
 #endif
@@ -19,13 +43,31 @@ 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 >*/
   ClutterLayoutManager parent_instance;
 };
 
+/**
+ * ClutterFixedLayoutClass:
+ *
+ * The #ClutterFixedLayoutClass structure contains only private data
+ * and it should be accessed using the provided API
+ *
+ * Since: 1.2
+ */
 struct _ClutterFixedLayoutClass
 {
+  /*< private >*/
   ClutterLayoutManagerClass parent_class;
 };