GNOME.org
 

[epiphany] docs: ephy-tree-model-sort

commit ac9f536fb83161b88678575ce6250c1cf5f8b176
Author: Diego Escalante Urrelo <diegoe gnome org>
Date:   Tue Dec 1 21:05:24 2009 -0500

    docs: ephy-tree-model-sort
    
    Also disable incomplete documentation.
    
    Bug #503852

 doc/reference/Makefile.am           |    2 -
 doc/reference/epiphany-docs.sgml    |   11 +--
 doc/reference/epiphany-sections.txt |  250 +++++------------------------------
 doc/reference/epiphany.types        |   32 +----
 lib/widgets/ephy-tree-model-sort.c  |   30 ++++
 lib/widgets/ephy-tree-model-sort.h  |   10 +-
 6 files changed, 75 insertions(+), 260 deletions(-)
---
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index e081436..13232a3 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -50,8 +50,6 @@ IGNORE_HFILES = \
 	ephy-stock-icons.h \
 	ephy-string.h \
 	ephy-zoom.h \
-	ephy-tree-model-node.h \
-	ephy-tree-model-sort.h \
 	downloader-view.h \
 	ephy-embed-dialog.h \
 	ephy-embed-event.h \
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index 1c69fb7..ccddd27 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -8,13 +8,6 @@
 
   <chapter>
     <title>Epiphany</title>
-    <xi:include href="xml/ephy-permission-manager.xml"/>
-    <xi:include href="xml/ephy-window.xml"/>
-    <xi:include href="xml/ephy-embed.xml"/>
-    <xi:include href="xml/ephy-embed-single.xml"/>
-    <xi:include href="xml/ephy-embed-persist.xml"/>
-    <xi:include href="xml/ephy-node-db.xml"/>
-    <xi:include href="xml/ephy-extensions-manager.xml"/>
   </chapter>
   <chapter>
     <title>Widgets</title>
@@ -22,14 +15,12 @@
     <xi:include href="xml/ephy-node-view.xml"/>
     <xi:include href="xml/ephy-search-entry.xml"/>
     <xi:include href="xml/ephy-spinner.xml"/>
+    <xi:include href="xml/ephy-tree-model-sort.xml"/>
     <xi:include href="xml/ephy-zoom-action.xml"/>
     <xi:include href="xml/ephy-zoom-control.xml"/>
   </chapter>
   <chapter>
     <title>Incomplete</title>
-    <xi:include href="xml/ephy-password-manager.xml"/>
-    <xi:include href="xml/ephy-session.xml"/>
-    <xi:include href="xml/ephy-shell.xml"/>
   </chapter>
 
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index 1ffd495..9faeac8 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -1,191 +1,4 @@
 <SECTION>
-<FILE>ephy-permission-manager</FILE>
-<TITLE>EphyPermissionManager</TITLE>
-EphyPermissionInfo
-EphyPermission
-ephy_permission_info_free
-<SUBSECTION Standard>
-EPHY_PERMISSION_MANAGER
-EPHY_IS_PERMISSION_MANAGER
-EPHY_TYPE_PERMISSION_MANAGER
-EPHY_TYPE_PERMISSION_INFO
-ephy_permission_info_get_type
-EPHY_PERMISSION_MANAGER_GET_IFACE
-EPHY_IS_PERMISSION_MANAGER_IFACE
-EPHY_PERMISSION_MANAGER_IFACE
-ephy_permission_manager_get_type
-</SECTION>
-
-<SECTION>
-<FILE>ephy-window</FILE>
-<TITLE>EphyWindow</TITLE>
-EphyWindow
-ephy_window_new
-ephy_window_new_with_chrome
-ephy_window_get_notebook
-ephy_window_get_toolbar
-ephy_window_get_statusbar
-ephy_window_set_zoom
-ephy_window_activate_location
-ephy_window_load_url
-<SUBSECTION Standard>
-EPHY_WINDOW
-EPHY_IS_WINDOW
-EPHY_TYPE_WINDOW
-ephy_window_get_type
-EPHY_WINDOW_CLASS
-EPHY_IS_WINDOW_CLASS
-EPHY_WINDOW_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>ephy-embed</FILE>
-<TITLE>EphyEmbed</TITLE>
-EphyEmbed
-<SUBSECTION Standard>
-ephy_embed_get_type
-EPHY_EMBED
-EPHY_IS_EMBED
-EPHY_TYPE_EMBED
-</SECTION>
-
-<SECTION>
-<FILE>ephy-embed-single</FILE>
-<TITLE>EphyEmbedSingle</TITLE>
-ephy_embed_single_clear_cache
-ephy_embed_single_clear_auth_cache
-ephy_embed_single_open_window
-<SUBSECTION Standard>
-EPHY_EMBED_SINGLE
-EPHY_IS_EMBED_SINGLE
-EPHY_TYPE_EMBED_SINGLE
-ephy_embed_single_get_type
-EPHY_EMBED_SINGLE_GET_IFACE
-EPHY_EMBED_SINGLE_IFACE
-EPHY_IS_EMBED_SINGLE_IFACE
-</SECTION>
-
-<SECTION>
-<FILE>ephy-embed-persist</FILE>
-<TITLE>EphyEmbedPersist</TITLE>
-ephy_embed_persist_set_dest
-ephy_embed_persist_set_embed
-ephy_embed_persist_set_fc_title
-ephy_embed_persist_set_fc_parent
-ephy_embed_persist_set_flags
-ephy_embed_persist_set_max_size
-ephy_embed_persist_set_persist_key
-ephy_embed_persist_set_source
-ephy_embed_persist_get_dest
-ephy_embed_persist_get_embed
-ephy_embed_persist_get_fc_title
-ephy_embed_persist_get_fc_parent
-ephy_embed_persist_get_flags
-ephy_embed_persist_get_max_size
-ephy_embed_persist_get_persist_key
-ephy_embed_persist_get_source
-ephy_embed_persist_save
-ephy_embed_persist_cancel
-ephy_embed_persist_to_string
-<SUBSECTION Standard>
-EPHY_EMBED_PERSIST
-EPHY_IS_EMBED_PERSIST
-EPHY_TYPE_EMBED_PERSIST
-ephy_embed_persist_get_type
-EPHY_EMBED_PERSIST_CLASS
-EPHY_IS_EMBED_PERSIST_CLASS
-EPHY_EMBED_PERSIST_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>ephy-node-db</FILE>
-<TITLE>EphyNodeDb</TITLE>
-EphyNodeDb
-ephy_node_db_new
-ephy_node_db_load_from_file
-ephy_node_db_write_to_xml_safe
-ephy_node_db_get_name
-ephy_node_db_is_immutable
-ephy_node_db_set_immutable
-ephy_node_db_get_node_from_id
-<SUBSECTION Standard>
-EPHY_NODE_DB
-EPHY_IS_NODE_DB
-EPHY_TYPE_NODE_DB
-ephy_node_db_get_type
-EPHY_NODE_DB_CLASS
-EPHY_IS_NODE_DB_CLASS
-EPHY_NODE_DB_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>ephy-extensions-manager</FILE>
-<TITLE>EphyExtensionsManager</TITLE>
-ephy_extensions_manager_load
-ephy_extensions_manager_unload
-<SUBSECTION Standard>
-EPHY_EXTENSIONS_MANAGER
-EPHY_IS_EXTENSIONS_MANAGER
-EPHY_TYPE_EXTENSIONS_MANAGER
-ephy_extensions_manager_get_type
-EPHY_EXTENSIONS_MANAGER_CLASS
-EPHY_IS_EXTENSIONS_MANAGER_CLASS
-EPHY_EXTENSIONS_MANAGER_GET_CLASS
-</SECTION>
-
-
-
-<SECTION>
-<FILE>ephy-session</FILE>
-ephy_session_get_active_window
-ephy_session_save
-ephy_session_load
-ephy_session_close
-ephy_session_get_windows
-ephy_session_add_window
-ephy_session_remove_window
-<SUBSECTION Standard>
-EPHY_SESSION
-EPHY_IS_SESSION
-EPHY_TYPE_SESSION
-ephy_session_get_type
-EPHY_SESSION_CLASS
-EPHY_IS_SESSION_CLASS
-EPHY_SESSION_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>ephy-shell</FILE>
-ephy_shell
-EphyNewTabFlags
-ephy_shell_new_tab
-ephy_shell_get_session
-ephy_shell_get_bookmarks
-ephy_shell_get_toolbars_model
-ephy_shell_get_extensions_manager
-ephy_shell_get_bookmarks_editor
-ephy_shell_get_history_window
-ephy_shell_get_pdm_dialog
-ephy_shell_get_prefs_dialog
-<SUBSECTION Standard>
-EPHY_SHELL
-EPHY_IS_SHELL
-EPHY_TYPE_SHELL
-ephy_shell_get_type
-EPHY_SHELL_CLASS
-EPHY_IS_SHELL_CLASS
-EPHY_SHELL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>ephy-password-manager</FILE>
-EPHY_TYPE_PASSWORD_INFO
-ephy_password_info_new
-<SUBSECTION Standard>
-ephy_password_info_get_type
-</SECTION>
-
-<SECTION>
 <FILE>ephy-location-entry</FILE>
 <TITLE>EphyLocationEntry</TITLE>
 EphyLocationEntry
@@ -207,6 +20,28 @@ ephy_location_entry_set_match_func
 </SECTION>
 
 <SECTION>
+<FILE>ephy-node-view</FILE>
+<TITLE>EphyNodeView</TITLE>
+EphyNodeView
+EphyNodeViewPriority
+EphyNodeViewFlags
+ephy_node_view_new
+ephy_node_view_add_toggle
+ephy_node_view_add_column
+ephy_node_view_add_data_column
+ephy_node_view_set_sort
+ephy_node_view_set_priority
+ephy_node_view_remove
+ephy_node_view_get_selection
+ephy_node_view_select_node
+ephy_node_view_enable_drag_source
+ephy_node_view_enable_drag_dest
+ephy_node_view_edit
+ephy_node_view_is_target
+ephy_node_view_popup
+</SECTION>
+
+<SECTION>
 <FILE>ephy-search-entry</FILE>
 <TITLE>EphySearchEntry</TITLE>
 EphySearchEntry
@@ -215,14 +50,6 @@ ephy_search_entry_clear
 </SECTION>
 
 <SECTION>
-<FILE>ephy-zoom-control</FILE>
-<TITLE>EphyZoomControl</TITLE>
-EphyZoomControl
-ephy_zoom_control_set_zoom_level
-ephy_zoom_control_get_zoom_level
-</SECTION>
-
-<SECTION>
 <FILE>ephy-spinner</FILE>
 <TITLE>EphySpinner</TITLE>
 EphySpinner
@@ -233,6 +60,15 @@ ephy_spinner_set_size
 </SECTION>
 
 <SECTION>
+<FILE>ephy-tree-model-sort</FILE>
+<TITLE>EphyTreeModelSort</TITLE>
+EphyTreeModelSort
+ephy_tree_model_sort_new
+ephy_tree_model_sort_set_base_drag_column_id
+ephy_tree_model_sort_set_extra_drag_column_id
+</SECTION>
+
+<SECTION>
 <FILE>ephy-zoom-action</FILE>
 <TITLE>EphyZoomAction</TITLE>
 EphyZoomAction
@@ -241,23 +77,9 @@ ephy_zoom_action_get_zoom_level
 </SECTION>
 
 <SECTION>
-<FILE>ephy-node-view</FILE>
-<TITLE>EphyNodeView</TITLE>
-EphyNodeView
-EphyNodeViewPriority
-EphyNodeViewFlags
-ephy_node_view_new
-ephy_node_view_add_toggle
-ephy_node_view_add_column
-ephy_node_view_add_data_column
-ephy_node_view_set_sort
-ephy_node_view_set_priority
-ephy_node_view_remove
-ephy_node_view_get_selection
-ephy_node_view_select_node
-ephy_node_view_enable_drag_source
-ephy_node_view_enable_drag_dest
-ephy_node_view_edit
-ephy_node_view_is_target
-ephy_node_view_popup
+<FILE>ephy-zoom-control</FILE>
+<TITLE>EphyZoomControl</TITLE>
+EphyZoomControl
+ephy_zoom_control_set_zoom_level
+ephy_zoom_control_get_zoom_level
 </SECTION>
diff --git a/doc/reference/epiphany.types b/doc/reference/epiphany.types
index a690abf..160214b 100644
--- a/doc/reference/epiphany.types
+++ b/doc/reference/epiphany.types
@@ -1,45 +1,17 @@
-#include <ephy-dialog.h>
-#include <ephy-file-chooser.h>
-#include <ephy-node-db.h>
-#include <ephy-node-filter.h>
 #include <ephy-node-view.h>
 #include <ephy-location-entry.h>
 #include <ephy-search-entry.h>
 #include <ephy-spinner.h>
+#include <ephy-tree-model-sort.h>
 #include <ephy-zoom-action.h>
 #include <ephy-zoom-control.h>
 
-ephy_dialog_get_type
-ephy_file_chooser_get_type
-ephy_node_db_get_type
-ephy_node_filter_get_type
 ephy_node_view_get_type
 ephy_location_entry_get_type
 ephy_search_entry_get_type
 ephy_spinner_get_type
+ephy_tree_model_sort_get_type
 ephy_zoom_action_get_type
 ephy_zoom_control_get_type
 
-#include <ephy-embed.h>
-#include <downloader-view.h>
-#include <ephy-embed-dialog.h>
-#include <ephy-embed-event.h>
-#include <ephy-embed-persist.h>
-#include <ephy-embed-single.h>
-#include <ephy-permission-manager.h>
 
-ephy_embed_get_type
-downloader_view_get_type
-ephy_embed_dialog_get_type
-ephy_embed_event_get_type
-ephy_embed_persist_get_type
-ephy_embed_single_get_type
-ephy_permission_manager_get_type
-
-#include <ephy-window.h>
-#include <ephy-shell.h>
-#include <ephy-session.h>
-
-ephy_window_get_type
-ephy_shell_get_type
-ephy_session_get_type
diff --git a/lib/widgets/ephy-tree-model-sort.c b/lib/widgets/ephy-tree-model-sort.c
index 6f67c6d..263d7dc 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 a21f31b..4044704 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);
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]