From ac9f536fb83161b88678575ce6250c1cf5f8b176 Mon Sep 17 00:00:00 2001
From: Diego Escalante Urrelo <diegoe@gnome.org>
Date: Tue, 1 Dec 2009 21:05:24 -0500
Subject: docs: ephy-tree-model-sort

Also disable incomplete documentation.

Bug #503852
---
 lib/widgets/ephy-tree-model-sort.c | 30 ++++++++++++++++++++++++++++++
 lib/widgets/ephy-tree-model-sort.h | 10 ++++++----
 2 files changed, 36 insertions(+), 4 deletions(-)

(limited to 'lib')

diff --git a/lib/widgets/ephy-tree-model-sort.c b/lib/widgets/ephy-tree-model-sort.c
index 6f67c6d21..263d7dc30 100644
--- a/lib/widgets/ephy-tree-model-sort.c
+++ b/lib/widgets/ephy-tree-model-sort.c
@@ -29,6 +29,14 @@
 #include "ephy-marshal.h"
 #include "ephy-debug.h"
 
+/**
+ * SECTION:ephy-tree-model-sort
+ * @short_description: A #GtkTreeModelSort wrapper
+ *
+ * #EphyTreeModelSort is a simple wrapper for models, it implements some extra
+ * functionalities like drag and dropping, mostly relevant to Epiphany only.
+ */
+
 static void ephy_tree_model_sort_class_init (EphyTreeModelSortClass *klass);
 static void ephy_tree_model_sort_init (EphyTreeModelSort *ma);
 static void ephy_tree_model_sort_finalize (GObject *object);
@@ -121,6 +129,14 @@ ephy_tree_model_sort_finalize (GObject *object)
 	G_OBJECT_CLASS (parent_class)->finalize (object);
 }
 
+/**
+ * ephy_tree_model_sort_new:
+ * @child_model: model to wrap
+ *
+ * Creates a new #EphyTreeModelSort around @child_model.
+ *
+ * Returns: a new #EphyTreeModelSort, as a #GtkWidget
+ **/
 GtkTreeModel*
 ephy_tree_model_sort_new (GtkTreeModel *child_model)
 {
@@ -149,6 +165,13 @@ ephy_tree_model_sort_multi_row_draggable (EggTreeMultiDragSource *drag_source, G
 	return (EPHY_TREE_MODEL_SORT (drag_source)->priv->base_drag_column_id >= 0);
 }
 
+/**
+ * ephy_tree_model_sort_set_base_drag_column_id:
+ * @ms: an #EphyTreeModelSort
+ * @id: base drag column id
+ *
+ * Sets @id as the column for the base drag data
+ **/
 void
 ephy_tree_model_sort_set_base_drag_column_id (EphyTreeModelSort *ms,
 				              int id)
@@ -156,6 +179,13 @@ ephy_tree_model_sort_set_base_drag_column_id (EphyTreeModelSort *ms,
 	ms->priv->base_drag_column_id = id;
 }
 
+/**
+ * ephy_tree_model_sort_set_extra_drag_column_id:
+ * @ms: an #EphyTreeModelSort
+ * @id: extra drag column id
+ *
+ * Sets @id as the column for extra drag data.
+ **/
 void
 ephy_tree_model_sort_set_extra_drag_column_id (EphyTreeModelSort *ms,
 					       int id)
diff --git a/lib/widgets/ephy-tree-model-sort.h b/lib/widgets/ephy-tree-model-sort.h
index a21f31b87..4044704ee 100644
--- a/lib/widgets/ephy-tree-model-sort.h
+++ b/lib/widgets/ephy-tree-model-sort.h
@@ -36,22 +36,24 @@ G_BEGIN_DECLS
 #define EPHY_IS_TREE_MODEL_SORT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EPHY_TYPE_TREE_MODEL_SORT))
 #define EPHY_TREE_MODEL_SORT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EPHY_TYPE_TREE_MODEL_SORT, EphyTreeModelSortClass))
 
+typedef struct _EphyTreeModelSort EphyTreeModelSort;
+typedef struct _EphyTreeModelSortClass EphyTreeModelSortClass;
 typedef struct _EphyTreeModelSortPrivate EphyTreeModelSortPrivate;
 
-typedef struct
+struct _EphyTreeModelSort
 {
 	GtkTreeModelSort parent;
 
 	/*< private >*/
 	EphyTreeModelSortPrivate *priv;
-} EphyTreeModelSort;
+};
 
-typedef struct
+struct _EphyTreeModelSortClass
 {
 	GtkTreeModelSortClass parent_class;
 
 	void (*node_from_iter) (EphyTreeModelSort *model, GtkTreeIter *iter, void **node);
-} EphyTreeModelSortClass;
+};
 
 GType		ephy_tree_model_sort_get_type		      (void);
 
-- 
cgit v1.2.3