[gtk+] gtktreeviewcolumn: Move documentation to inline comments

[Javier Jardón <jjardon src gnome org>]

commit 16cf23959f17c240b5b1faf7802cffd1f51363ab
Author: Javier Jardón <jjardon gnome org>
Date:   Fri Oct 22 21:59:08 2010 +0200

    gtktreeviewcolumn: Move documentation to inline comments

 docs/reference/gtk/tmpl/.gitignore             |    1 +
 docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml |  624 ------------------------
 gtk/gtktreeviewcolumn.c                        |   18 +
 gtk/gtktreeviewcolumn.h                        |   31 +-
 4 files changed, 47 insertions(+), 627 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 9d74162..66a2821 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -51,5 +51,6 @@ gtktoolitem.sgml
 gtktooltip.sgml
 gtktreednd.sgml
 gtktreestore.sgml
+gtktreeviewcolumn.sgml
 gtktypeutils.sgml
 gtkwindow.sgml
diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c
index ad576f6..a62165b 100644
--- a/gtk/gtktreeviewcolumn.c
+++ b/gtk/gtktreeviewcolumn.c
@@ -36,6 +36,24 @@
 #include "gtkintl.h"
 
 
+/**
+ * SECTION:gtktreeviewcolumn
+ * @Short_description: A visible column in a GtkTreeView widget
+ * @Title: GtkTreeViewColumn
+ * @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable,
+ *   #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable,
+ *   #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
+ *
+ * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
+ * It allows to set properties of the column header, and functions as a holding pen for
+ * the cell renderers which determine how the data in the column is displayed.
+ *
+ * Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
+ * for an overview of all the objects and data types related to the tree widget and how
+ * they work together.
+ */
+
+
 enum
 {
   PROP_0,
diff --git a/gtk/gtktreeviewcolumn.h b/gtk/gtktreeviewcolumn.h
index a19adf2..6c0b3a1 100644
--- a/gtk/gtktreeviewcolumn.h
+++ b/gtk/gtktreeviewcolumn.h
@@ -39,6 +39,19 @@ G_BEGIN_DECLS
 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW_COLUMN))
 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
 
+typedef struct _GtkTreeViewColumn      GtkTreeViewColumn;
+typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
+
+/**
+ * GtkTreeViewColumnSizing:
+ * @GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model
+ * @GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes.
+ * @GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide.
+ *
+ * The sizing method the column uses to determine its width.  Please note
+ * that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and
+ * can make columns appear choppy.
+ */
 typedef enum
 {
   GTK_TREE_VIEW_COLUMN_GROW_ONLY,
@@ -46,9 +59,21 @@ typedef enum
   GTK_TREE_VIEW_COLUMN_FIXED
 } GtkTreeViewColumnSizing;
 
-typedef struct _GtkTreeViewColumn      GtkTreeViewColumn;
-typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
-
+/**
+ * GtkTreeCellDataFunc:
+ * @tree_column: A #GtkTreeColumn
+ * @cell: The #GtkCellRenderer that is being rendered by @tree_column
+ * @tree_model: The #GtkTreeModel being rendered
+ * @iter: A #GtkTreeIter of the current row rendered
+ * @data: user data
+ *
+ * A function to set the properties of a cell instead of just using the
+ * straight mapping between the cell and the model.  This is useful for
+ * customizing the cell renderer.  For example, a function might get an
+ * integer from the @tree_model, and render it to the "text" attribute of
+ * "cell" by converting it to its written equivilent.  This is set by
+ * calling gtk_tree_view_column_set_cell_data_func()
+ */
 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
 				      GtkCellRenderer   *cell,
 				      GtkTreeModel      *tree_model,