[libgda] GdaBrowser: hacking guide updates

[Vivien Malerba <vivien src gnome org>]

commit cc04f46d123f744b002d3228857d12a6171a1dbf
Author: Vivien Malerba <malerba gnome-db org>
Date:   Fri Sep 4 21:57:30 2009 +0200

    GdaBrowser: hacking guide updates

 tools/browser/doc/Makefile.am                 |    2 +-
 tools/browser/doc/gda-browser-sections.txt    |  311 ++++++++++---------------
 tools/browser/doc/tmpl/browser-core.sgml      |   16 --
 tools/browser/doc/tmpl/browser-favorites.sgml |   25 ++-
 4 files changed, 137 insertions(+), 217 deletions(-)
---
diff --git a/tools/browser/doc/Makefile.am b/tools/browser/doc/Makefile.am
index a1d1019..5af137d 100644
--- a/tools/browser/doc/Makefile.am
+++ b/tools/browser/doc/Makefile.am
@@ -22,7 +22,7 @@ HFILE_GLOB=
 CFILE_GLOB=
 
 # Header files to ignore when scanning
-IGNORE_HFILES= marshal.h canvas dummy-perspective schema-browser
+IGNORE_HFILES= marshal.h canvas dummy-perspective schema-browser query-exec
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 # if $(DOC_MODULE).types is non-empty.
diff --git a/tools/browser/doc/gda-browser-sections.txt b/tools/browser/doc/gda-browser-sections.txt
index f9272fd..41b6f39 100644
--- a/tools/browser/doc/gda-browser-sections.txt
+++ b/tools/browser/doc/gda-browser-sections.txt
@@ -1,27 +1,15 @@
 <SECTION>
-<FILE>browser-core</FILE>
-BrowserCorePrivate
-BrowserCoreInitFactories
-<TITLE>BrowserCore</TITLE>
-BrowserCore
-browser_core_exists
-browser_core_get
-browser_core_take_window
-browser_core_get_windows
-browser_core_close_window
-browser_core_take_connection
-browser_core_get_connections
-browser_core_close_connection
-browser_core_quit
-browser_core_get_default_factory
-browser_core_set_default_factory
-browser_core_get_factories
+<FILE>browser-variable</FILE>
+BrowserVariablePrivate
+<TITLE>BrowserVariable</TITLE>
+BrowserVariable
+browser_variable_new
 <SUBSECTION Standard>
-BROWSER_CORE
-BROWSER_IS_CORE
-BROWSER_TYPE_CORE
-browser_core_get_type
-BROWSER_CORE_CLASS
+BROWSER_VARIABLE
+BROWSER_IS_VARIABLE
+BROWSER_TYPE_VARIABLE
+browser_variable_get_type
+BROWSER_VARIABLE_CLASS
 </SECTION>
 
 <SECTION>
@@ -44,6 +32,24 @@ BROWSER_SPINNER_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>browser-window</FILE>
+BrowserWindowPrivate
+<TITLE>BrowserWindow</TITLE>
+BrowserWindow
+browser_window_new
+browser_window_get_connection
+browser_window_push_status
+browser_window_pop_status
+browser_window_customize_perspective_ui
+<SUBSECTION Standard>
+BROWSER_WINDOW
+BROWSER_IS_WINDOW
+BROWSER_TYPE_WINDOW
+browser_window_get_type
+BROWSER_WINDOW_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>auth-dialog</FILE>
 AuthDialogPrivate
 auth_dialog_error_quark
@@ -65,40 +71,51 @@ AUTH_DIALOG_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>browser-favorites</FILE>
-BrowserFavoritesPrivate
-BrowserFavoritesType
-BROWSER_FAVORITES_NB_TYPES
-BrowserFavoritesAttributes
-<TITLE>BrowserFavorites</TITLE>
-BrowserFavorites
-browser_favorites_new
-browser_favorites_add
-browser_favorites_list
-browser_favorites_delete
-browser_favorites_free_list
-browser_favorites_reset_attributes
-browser_favorites_get
+<FILE>browser-core</FILE>
+BrowserCorePrivate
+BrowserCoreInitFactories
+<TITLE>BrowserCore</TITLE>
+BrowserCore
+browser_core_exists
+browser_core_get
+browser_core_take_window
+browser_core_get_windows
+browser_core_close_window
+browser_core_take_connection
+browser_core_get_connections
+browser_core_close_connection
+browser_core_quit
+browser_core_get_default_factory
+browser_core_set_default_factory
+browser_core_get_factories
 <SUBSECTION Standard>
-BROWSER_FAVORITES
-BROWSER_IS_FAVORITES
-BROWSER_TYPE_FAVORITES
-browser_favorites_get_type
-BROWSER_FAVORITES_CLASS
+BROWSER_CORE
+BROWSER_IS_CORE
+BROWSER_TYPE_CORE
+browser_core_get_type
+BROWSER_CORE_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>browser-connections-list</FILE>
-BrowserConnectionsListPrivate
-<TITLE>BrowserConnectionsList</TITLE>
-BrowserConnectionsList
-browser_connections_list_show
+<FILE>cc-gray-bar</FILE>
+CcGrayBarPrivate
+<TITLE>CcGrayBar</TITLE>
+CcGrayBar
+cc_gray_bar_new
+cc_gray_bar_get_text
+cc_gray_bar_set_text
+cc_gray_bar_set_icon_from_pixbuf
+cc_gray_bar_set_icon_from_file
+cc_gray_bar_set_icon_from_stock
+cc_gray_bar_set_show_icon
+cc_gray_bar_get_show_icon
 <SUBSECTION Standard>
-BROWSER_CONNECTIONS_LIST
-BROWSER_IS_CONNECTIONS_LIST
-BROWSER_TYPE_CONNECTIONS_LIST
-browser_connections_list_get_type
-BROWSER_CONNECTIONS_LIST_CLASS
+CC_GRAY_BAR
+CC_IS_GRAY_BAR
+CC_TYPE_GRAY_BAR
+cc_gray_bar_get_type
+CC_GRAY_BAR_CLASS
+CC_IS_GRAY_BAR_CLASS
 </SECTION>
 
 <SECTION>
@@ -120,20 +137,6 @@ LOGIN_DIALOG_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>browser-variable</FILE>
-BrowserVariablePrivate
-<TITLE>BrowserVariable</TITLE>
-BrowserVariable
-browser_variable_new
-<SUBSECTION Standard>
-BROWSER_VARIABLE
-BROWSER_IS_VARIABLE
-BROWSER_TYPE_VARIABLE
-browser_variable_get_type
-BROWSER_VARIABLE_CLASS
-</SECTION>
-
-<SECTION>
 <FILE>browser-connection</FILE>
 BrowserConnectionPrivate
 <TITLE>BrowserConnection</TITLE>
@@ -157,84 +160,56 @@ BROWSER_CONNECTION_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>browser-window</FILE>
-BrowserWindowPrivate
-<TITLE>BrowserWindow</TITLE>
-BrowserWindow
-browser_window_new
-browser_window_get_connection
-browser_window_push_status
-browser_window_pop_status
-browser_window_customize_perspective_ui
+<FILE>browser-connections-list</FILE>
+BrowserConnectionsListPrivate
+<TITLE>BrowserConnectionsList</TITLE>
+BrowserConnectionsList
+browser_connections_list_show
 <SUBSECTION Standard>
-BROWSER_WINDOW
-BROWSER_IS_WINDOW
-BROWSER_TYPE_WINDOW
-browser_window_get_type
-BROWSER_WINDOW_CLASS
+BROWSER_CONNECTIONS_LIST
+BROWSER_IS_CONNECTIONS_LIST
+BROWSER_TYPE_CONNECTIONS_LIST
+browser_connections_list_get_type
+BROWSER_CONNECTIONS_LIST_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>cc-gray-bar</FILE>
-CcGrayBarPrivate
-<TITLE>CcGrayBar</TITLE>
-CcGrayBar
-cc_gray_bar_new
-cc_gray_bar_get_text
-cc_gray_bar_set_text
-cc_gray_bar_set_icon_from_pixbuf
-cc_gray_bar_set_icon_from_file
-cc_gray_bar_set_icon_from_stock
-cc_gray_bar_set_show_icon
-cc_gray_bar_get_show_icon
+<FILE>browser-favorites</FILE>
+BrowserFavoritesPrivate
+BrowserFavoritesType
+BROWSER_FAVORITES_NB_TYPES
+BrowserFavoritesAttributes
+<TITLE>BrowserFavorites</TITLE>
+BrowserFavorites
+browser_favorites_new
+browser_favorites_add
+browser_favorites_list
+browser_favorites_delete
+browser_favorites_free_list
+browser_favorites_reset_attributes
+browser_favorites_get
 <SUBSECTION Standard>
-CC_GRAY_BAR
-CC_IS_GRAY_BAR
-CC_TYPE_GRAY_BAR
-cc_gray_bar_get_type
-CC_GRAY_BAR_CLASS
-CC_IS_GRAY_BAR_CLASS
+BROWSER_FAVORITES
+BROWSER_IS_FAVORITES
+BROWSER_TYPE_FAVORITES
+browser_favorites_get_type
+BROWSER_FAVORITES_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>query-editor</FILE>
-QueryEditorPrivate
-<TITLE>QueryEditor</TITLE>
-QueryEditor
-QueryEditorHistoryItem
-query_editor_history_item_new
-query_editor_history_item_ref
-query_editor_history_item_unref
-QueryEditorHistoryBatch
-query_editor_history_batch_new
-query_editor_history_batch_ref
-query_editor_history_batch_unref
-query_editor_history_batch_add_item
-query_editor_history_batch_del_item
-QueryEditorMode
-query_editor_new
-query_editor_set_mode
-query_editor_get_mode
-query_editor_get_all_text
-query_editor_load_from_file
-query_editor_save_to_file
-query_editor_copy_clipboard
-query_editor_cut_clipboard
-query_editor_paste_clipboard
-query_editor_set_text
-query_editor_start_history_batch
-query_editor_add_history_item
-query_editor_get_current_history_item
-query_editor_get_current_history_batch
-query_editor_del_current_history_item
-query_editor_del_history_batch
-<SUBSECTION Standard>
-QUERY_EDITOR
-QUERY_IS_EDITOR
-QUERY_TYPE_EDITOR
-query_editor_get_type
-QUERY_EDITOR_CLASS
-QUERY_IS_EDITOR_CLASS
+<FILE>decl</FILE>
+BrowserCore
+BrowserVariable
+BrowserConnection
+BrowserWindow
+BrowserData
+BrowserPerspectiveIface
+BrowserPerspective
+BrowserPageIface
+BrowserPage
+BrowserPerspectiveFactory
+BROWSER_PERSPECTIVE_FACTORY
+ORDER_KEY_SCHEMA
 </SECTION>
 
 <SECTION>
@@ -251,19 +226,7 @@ browser_perspective_page_tab_label_change
 </SECTION>
 
 <SECTION>
-<FILE>decl</FILE>
-BrowserCore
-BrowserVariable
-BrowserConnection
-BrowserWindow
-BrowserData
-BrowserPerspectiveIface
-BrowserPerspective
-BrowserPageIface
-BrowserPage
-BrowserPerspectiveFactory
-BROWSER_PERSPECTIVE_FACTORY
-ORDER_KEY_SCHEMA
+<FILE>dnd</FILE>
 </SECTION>
 
 <SECTION>
@@ -298,21 +261,6 @@ MGR_FAVORITES_TYPE_ATT_NAME
 </SECTION>
 
 <SECTION>
-<FILE>dnd</FILE>
-</SECTION>
-
-<SECTION>
-<FILE>browser-stock-icons</FILE>
-BROWSER_STOCK_HISTORY
-BROWSER_STOCK_BOOKMARKS
-STOCK_NEW_WINDOW
-STOCK_ADD_BOOKMARK
-STOCK_PRINT_SETUP
-STOCK_CONSOLE
-browser_stock_icons_init
-</SECTION>
-
-<SECTION>
 <FILE>support</FILE>
 browser_connection_open
 browser_connection_close
@@ -325,35 +273,14 @@ browser_get_pixbuf_icon
 </SECTION>
 
 <SECTION>
-<FILE>query-exec-perspective</FILE>
-TYPE_QUERY_EXEC_PERSPECTIVE
-QUERY_EXEC_PERSPECTIVE
-QUERY_EXEC_PERSPECTIVE_CLASS
-IS_QUERY_EXEC_PERSPECTIVE
-QueryExecPerspectivePrivate
-<TITLE>QueryExecPerspective</TITLE>
-QueryExecPerspective
-query_exec_perspective_get_type
-query_exec_perspective_new
-</SECTION>
-
-<SECTION>
-<FILE>query-console</FILE>
-QUERY_CONSOLE_TYPE
-QUERY_CONSOLE
-QUERY_CONSOLE_CLASS
-IS_QUERY_CONSOLE
-IS_QUERY_CONSOLE_CLASS
-QueryConsolePrivate
-<TITLE>QueryConsole</TITLE>
-QueryConsole
-query_console_get_type
-query_console_new
-</SECTION>
-
-<SECTION>
-<FILE>perspective-main</FILE>
-query_exec_perspective_get_factory
+<FILE>browser-stock-icons</FILE>
+BROWSER_STOCK_HISTORY
+BROWSER_STOCK_BOOKMARKS
+STOCK_NEW_WINDOW
+STOCK_ADD_BOOKMARK
+STOCK_PRINT_SETUP
+STOCK_CONSOLE
+browser_stock_icons_init
 </SECTION>
 
 <SECTION>
diff --git a/tools/browser/doc/tmpl/browser-core.sgml b/tools/browser/doc/tmpl/browser-core.sgml
index fc91e9b..4148dae 100644
--- a/tools/browser/doc/tmpl/browser-core.sgml
+++ b/tools/browser/doc/tmpl/browser-core.sgml
@@ -125,22 +125,6 @@ Singleton holding the global browser information
 
 
 
-<!-- ##### STRUCT BrowserPerspectiveFactory ##### -->
-<para>
-
-</para>
-
- perspective_name: 
- perspective_create: 
-
-<!-- ##### MACRO BROWSER_PERSPECTIVE_FACTORY ##### -->
-<para>
-
-</para>
-
- x: 
-
-
 <!-- ##### FUNCTION browser_core_get_default_factory ##### -->
 <para>
 
diff --git a/tools/browser/doc/tmpl/browser-favorites.sgml b/tools/browser/doc/tmpl/browser-favorites.sgml
index e976124..0bb3b00 100644
--- a/tools/browser/doc/tmpl/browser-favorites.sgml
+++ b/tools/browser/doc/tmpl/browser-favorites.sgml
@@ -34,18 +34,12 @@ Favorites management
 @BROWSER_FAVORITES_TABLES: 
 @BROWSER_FAVORITES_DIAGRAMS: 
 
-<!-- ##### STRUCT BrowserFavorites ##### -->
+<!-- ##### MACRO BROWSER_FAVORITES_NB_TYPES ##### -->
 <para>
 
 </para>
 
 
-<!-- ##### SIGNAL BrowserFavorites::favorites-changed ##### -->
-<para>
-
-</para>
-
- browserfavorites: the object which received the signal.
 
 <!-- ##### STRUCT BrowserFavoritesAttributes ##### -->
 <para>
@@ -58,12 +52,27 @@ Favorites management
 @descr: 
 @contents: 
 
-<!-- ##### MACRO ORDER_KEY_SCHEMA ##### -->
+<!-- ##### STRUCT BrowserFavorites ##### -->
 <para>
 
 </para>
 
 
+<!-- ##### SIGNAL BrowserFavorites::favorites-changed ##### -->
+<para>
+
+</para>
+
+ browserfavorites: the object which received the signal.
+
+<!-- ##### FUNCTION browser_favorites_new ##### -->
+<para>
+
+</para>
+
+ store: 
+ Returns: 
+
 
 <!-- ##### FUNCTION browser_favorites_add ##### -->
 <para>