gtktreestore: Move documentation to inline comments

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index ff1846495fcdea9e76ce5f1a5f5386648f8af06f..9d74162e5ba900bd91ed5e28c101cf0e98030041 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -50,5 +50,6 @@ gtktoolbar.sgml
 gtktoolitem.sgml
 gtktooltip.sgml
 gtktreednd.sgml
+gtktreestore.sgml
 gtktypeutils.sgml
 gtkwindow.sgml

diff --git a/docs/reference/gtk/tmpl/gtktreestore.sgml b/docs/reference/gtk/tmpl/gtktreestore.sgml
deleted file mode 100644 (file)
index efa8455..0000000
--- a/docs/reference/gtk/tmpl/gtktreestore.sgml
+++ /dev/null
@@ -1,296 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkTreeStore
-
-<!-- ##### SECTION Short_Description ##### -->
-A tree-like data structure that can be used with the GtkTreeView
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The #GtkTreeStore object is a list model for use with a #GtkTreeView
-widget.  It implements the #GtkTreeModel interface, and consequentialy,
-can use all of the methods available there.  It also implements the
-#GtkTreeSortable interface so it can be sorted by the view.  Finally,
-it also implements the tree <link linkend="gtktreednd">drag and
-drop</link> interfaces.
-</para>
-
-<refsect2 id="GtkTreeStore-BUILDER-UI">
-<title>GtkTreeStore as GtkBuildable</title>
-<para>
-The GtkTreeStore implementation of the GtkBuildable interface allows
-to specify the model columns with a &lt;columns&gt; element that may
-contain multiple &lt;column&gt; elements, each specifying one model
-column. The "type" attribute specifies the data type for the column.
-</para>
-<example>
-<title>A UI Definition fragment for a tree store</title>
-<programlisting><![CDATA[
-<object class="GtkTreeStore">
-  <columns>
-    <column type="gchararray"/>
-    <column type="gchararray"/>
-    <column type="gint"/>
-  </columns>
-</object>
-]]></programlisting>
-</example>
-</refsect2>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GtkTreeModel, #GtkTreeStore
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkTreeStore ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gtk_tree_store_new ##### -->
-<para>
-
-</para>
-
-@n_columns: 
-@Varargs: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_newv ##### -->
-<para>
-
-</para>
-
-@n_columns: 
-@types: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_set_column_types ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@n_columns: 
-@types: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_set_value ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@column: 
-@value: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_set ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@Varargs: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_set_valist ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@var_args: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_set_valuesv ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@columns: 
-@values: 
-@n_values: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_remove ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_insert ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@parent: 
-@position: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_insert_before ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@parent: 
-@sibling: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_insert_after ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@parent: 
-@sibling: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_insert_with_values ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@parent: 
-@position: 
-@Varargs: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_insert_with_valuesv ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@parent: 
-@position: 
-@columns: 
-@values: 
-@n_values: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_prepend ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@parent: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_append ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@parent: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_is_ancestor ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@descendant: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_iter_depth ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_clear ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_iter_is_valid ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_reorder ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@parent: 
-@new_order: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_swap ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@a: 
-@b: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_move_before ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@position: 
-
-
-<!-- ##### FUNCTION gtk_tree_store_move_after ##### -->
-<para>
-
-</para>
-
-@tree_store: 
-@iter: 
-@position: 
-
-

diff --git a/gtk/gtktreestore.c b/gtk/gtktreestore.c
index c7f0087cd32ed8b1bef1ce37d0b1c721fbe4387f..05567396a0edaa16e232b7c83199f85c0619f58b 100644 (file)
--- a/gtk/gtktreestore.c
+++ b/gtk/gtktreestore.c
@@ -28,6 +28,41 @@
 #include "gtkintl.h"
 
 
+/**
+ * SECTION:gtktreestore
+ * @Short_description: A tree-like data structure that can be used with the GtkTreeView
+ * @Title: GtkTreeStore
+ * @See_also: #GtkTreeModel
+ *
+ * The #GtkTreeStore object is a list model for use with a #GtkTreeView
+ * widget.  It implements the #GtkTreeModel interface, and consequentialy,
+ * can use all of the methods available there.  It also implements the
+ * #GtkTreeSortable interface so it can be sorted by the view.  Finally,
+ * it also implements the tree <link linkend="gtktreednd">drag and
+ * drop</link> interfaces.
+ *
+ * <refsect2 id="GtkTreeStore-BUILDER-UI">
+ * <title>GtkTreeStore as GtkBuildable</title>
+ * The GtkTreeStore implementation of the #GtkBuildable interface allows
+ * to specify the model columns with a &lt;columns&gt; element that may
+ * contain multiple &lt;column&gt; elements, each specifying one model
+ * column. The "type" attribute specifies the data type for the column.
+ * <example>
+ * <title>A UI Definition fragment for a tree store</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkTreeStore">
+ *   <columns>
+ *     <column type="gchararray"/>
+ *     <column type="gchararray"/>
+ *     <column type="gint"/>
+ *   </columns>
+ * </object>
+ * ]]></programlisting>
+ * </example>
+ * </refsect2>
+ */
+
+
 #define G_NODE(node) ((GNode *)node)
 #define GTK_TREE_STORE_IS_SORTED(tree) (((GtkTreeStore*)(tree))->sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
 #define VALID_ITER(iter, tree_store) ((iter)!= NULL && (iter)->user_data != NULL && ((GtkTreeStore*)(tree_store))->stamp == (iter)->stamp)