Move GtkTreeModel docs inline

1 files changed, 41 insertions, 1 deletions

diff --git a/gtk/gtktreemodel.h b/gtk/gtktreemodel.h
index b290f83c1e..45bc7cebf4 100644
--- a/gtk/gtktreemodel.h
+++ b/gtk/gtktreemodel.h
@@ -42,15 +42,55 @@ typedef struct _GtkTreePath         GtkTreePath;
 typedef struct _GtkTreeRowReference GtkTreeRowReference;
 typedef struct _GtkTreeModel        GtkTreeModel; /* Dummy typedef */
 typedef struct _GtkTreeModelIface   GtkTreeModelIface;
-typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
 
+/**
+ * GtkTreeModelForeachFunc:
+ * @model: the #GtkTreeModel being iterated
+ * @path: the current #GtkTreePath
+ * @iter: the current #GtkTreeIter
+ * @data: The user data passed to gtk_tree_model_foreach()
+ *
+ * Type of the callback passed to gtk_tree_model_foreach() to
+ * iterate over the rows in a tree model.
+ *
+ * Return value: %TRUE to stop iterating, %FALSE to continue
+ *
+ */
+typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
 
+/**
+ * GtkTreeModelFlags:
+ * @GTK_TREE_MODEL_ITERS_PERSIST: iterators survive all signals
+ *     emitted by the tree
+ * @GTK_TREE_MODEL_LIST_ONLY: the model is a list only, and never
+ *     has children
+ *
+ * These flags indicate various properties of a #GtkTreeModel.
+ *
+ * They are returned by gtk_tree_model_get_flags(), and must be
+ * static for the lifetime of the object. A more complete description
+ * of #GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of
+ * this section.
+ */
 typedef enum
 {
   GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
   GTK_TREE_MODEL_LIST_ONLY = 1 << 1
 } GtkTreeModelFlags;
 
+/**
+ * GtkTreeIter:
+ * @stamp: a unique stamp to catch invalid iterators
+ * @user_data: model-specific data
+ * @user_data2: model-specific data
+ * @user_data3: model-specific data
+ *
+ * The <structname>GtkTreeIter</structname> is the primary structure
+ * for accessing a #GtkTreeModel. Models are expected to put a unique
+ * integer in the <structfield>stamp</structfield> member, and put
+ * model-specific data in the three <structfield>user_data</structfield>
+ * members.
+ */
 struct _GtkTreeIter
 {
   gint stamp;