gtktreeviewcolumn: Move documentation to inline comments

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 9d74162e5ba900bd91ed5e28c101cf0e98030041..66a28214a31708689f395e82fa4feb65382fc98a 100644 (file)
--- 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/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
deleted file mode 100644 (file)
index 5340150..0000000
--- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
+++ /dev/null
@@ -1,624 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkTreeViewColumn
-
-<!-- ##### SECTION Short_Description ##### -->
-A visible column in a GtkTreeView widget
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-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.
-</para>
-
-<para>
-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.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### ENUM GtkTreeViewColumnSizing ##### -->
-<para>
-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.
-</para>
-
-@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.
-
-<!-- ##### USER_FUNCTION GtkTreeCellDataFunc ##### -->
-<para>
-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()
-</para>
-
-@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
-
-
-<!-- ##### STRUCT GtkTreeViewColumn ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GtkTreeViewColumn::clicked ##### -->
-<para>
-
-</para>
-
-@treeviewcolumn: the object which received the signal.
-
-<!-- ##### ARG GtkTreeViewColumn:alignment ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:clickable ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:expand ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:fixed-width ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:max-width ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:min-width ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:reorderable ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:resizable ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:sizing ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:sort-column-id ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:sort-indicator ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:sort-order ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:spacing ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:title ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:visible ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:widget ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTreeViewColumn:width ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_tree_view_column_new ##### -->
-<para>
-
-</para>
-
-@void: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_new_with_attributes ##### -->
-<para>
-
-</para>
-
-@title: 
-@cell: 
-@Varargs: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_pack_start ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell: 
-@expand: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_pack_end ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell: 
-@expand: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_clear ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_add_attribute ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell_renderer: 
-@attribute: 
-@column: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_attributes ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell_renderer: 
-@Varargs: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_cell_data_func ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell_renderer: 
-@func: 
-@func_data: 
-@destroy: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_clear_attributes ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell_renderer: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_spacing ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@spacing: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_spacing ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_visible ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@visible: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_visible ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_resizable ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@resizable: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_resizable ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_sizing ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@type: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_sizing ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_width ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_fixed_width ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_fixed_width ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@fixed_width: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_min_width ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@min_width: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_min_width ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_max_width ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@max_width: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_max_width ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_clicked ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_title ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@title: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_title ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_expand ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@expand: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_expand ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_clickable ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@clickable: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_clickable ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_widget ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@widget: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_widget ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_alignment ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@xalign: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_alignment ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_reorderable ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@reorderable: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_reorderable ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_sort_column_id ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@sort_column_id: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_sort_column_id ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_sort_indicator ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@setting: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_sort_indicator ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_set_sort_order ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@order: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_sort_order ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_cell_set_cell_data ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@tree_model: 
-@iter: 
-@is_expander: 
-@is_expanded: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_cell_get_size ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell_area: 
-@x_offset: 
-@y_offset: 
-@width: 
-@height: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_cell_get_position ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell_renderer: 
-@start_pos: 
-@width: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_cell_is_visible ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_focus_cell ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@cell: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_queue_resize ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-
-
-<!-- ##### FUNCTION gtk_tree_view_column_get_tree_view ##### -->
-<para>
-
-</para>
-
-@tree_column: 
-@Returns: 
-
-

diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c
index ad576f68f33d137cfba8fb4b315e32fbf9f520b7..a62165b28178e9499a76a8228e4c38a65fe6422d 100644 (file)
--- 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 a19adf2360134cd57505844f16048917bfaf42f0..6c0b3a1e8833dec94d63f309d4ed4fb6ffc561b2 100644 (file)
--- 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,