GNOME.org
 

[libgda/gtk3] Documentation: removed the tmpl/ dir used by GtkDoc for GdaBrowser's doc

commit 80991b23ff8c87836b6d739387cb1834b53a0d73
Author: Vivien Malerba <malerba gnome-db org>
Date:   Sun Mar 13 17:25:15 2011 +0100

    Documentation: removed the tmpl/ dir used by GtkDoc for GdaBrowser's doc

 tools/browser/browser-connection.h                 |   18 +-
 tools/browser/browser-core.h                       |   17 +-
 tools/browser/browser-favorites.h                  |   16 +-
 tools/browser/browser-page.h                       |   17 +-
 tools/browser/browser-perspective.h                |   15 +-
 tools/browser/browser-window.h                     |   15 +-
 tools/browser/common/ui-formgrid.h                 |    9 +-
 .../data-manager/data-manager-perspective.h        |   12 +-
 tools/browser/doc/tmpl/browser-connection.sgml     |  433 --------------------
 tools/browser/doc/tmpl/browser-core.sgml           |  180 --------
 tools/browser/doc/tmpl/browser-favorites.sgml      |  200 ---------
 tools/browser/doc/tmpl/browser-page.sgml           |  112 -----
 tools/browser/doc/tmpl/browser-perspective.sgml    |  106 -----
 tools/browser/doc/tmpl/browser-window.sgml         |  145 -------
 tools/browser/doc/tmpl/cc-gray-bar.sgml            |  117 ------
 .../browser/doc/tmpl/data-manager-perspective.sgml |   62 ---
 tools/browser/doc/tmpl/mgr-favorites.sgml          |   79 ----
 tools/browser/doc/tmpl/popup-container.sgml        |   22 -
 tools/browser/doc/tmpl/query-exec-perspective.sgml |   44 --
 .../doc/tmpl/schema-browser-perspective.sgml       |   64 ---
 tools/browser/doc/tmpl/support.sgml                |  166 --------
 tools/browser/doc/tmpl/ui-formgrid.sgml            |  117 ------
 tools/browser/mgr-favorites.h                      |   10 +-
 tools/browser/query-exec/query-exec-perspective.h  |   10 +-
 .../schema-browser/schema-browser-perspective.h    |   10 +-
 tools/browser/support.h                            |    8 +
 26 files changed, 137 insertions(+), 1867 deletions(-)
---
diff --git a/tools/browser/browser-connection.h b/tools/browser/browser-connection.h
index ad0dfa0..9c0784e 100644
--- a/tools/browser/browser-connection.h
+++ b/tools/browser/browser-connection.h
@@ -1,8 +1,8 @@
 /* 
  * Copyright (C) 2009 - 2011 Vivien Malerba
  *
- * This Library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public License as
+ * This Program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
@@ -17,7 +17,6 @@
  * Boston, MA 02111-1307, USA.
  */
 
-
 #ifndef __BROWSER_CONNECTION_H_
 #define __BROWSER_CONNECTION_H_
 
@@ -57,6 +56,19 @@ struct _BrowserConnectionClass
 							      const gchar *attr_name, const gchar *value);
 };
 
+/**
+ * SECTION:browser-connection
+ * @short_description: An opened connection
+ * @title: BrowserConnection
+ * @stability: Stable
+ * @see_also:
+ *
+ * The #BrowserConnection object wraps a #GdaConnection with some
+ * additionnal features. The wrapped #GdaConnection is only accessible from within
+ * the #BrowserConnection object, so to use a connection, you have to use the
+ * #BrowserConnection's methods.
+ */
+
 GType               browser_connection_get_type               (void) G_GNUC_CONST;
 
 BrowserConnection  *browser_connection_new                    (GdaConnection *cnc);
diff --git a/tools/browser/browser-core.h b/tools/browser/browser-core.h
index 3822ff1..2110686 100644
--- a/tools/browser/browser-core.h
+++ b/tools/browser/browser-core.h
@@ -1,8 +1,8 @@
 /* 
- * Copyright (C) 2009 Vivien Malerba
+ * Copyright (C) 2009 - 2011 Vivien Malerba
  *
- * This Library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public License as
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
@@ -52,6 +52,17 @@ struct _BrowserCoreClass
 	void    (*connection_removed) (BrowserCore *bcore, BrowserConnection *bcnc);
 };
 
+/**
+ * SECTION:browser-core
+ * @short_description: Singleton holding the global browser information
+ * @title: BrowserCore
+ * @stability: Stable
+ * @see_also:
+ *
+ * A single instance of a #BrowserCore is created when the browser is started,
+ * accessible using browser_core_get().
+ */
+
 GType           browser_core_get_type               (void) G_GNUC_CONST;
 gboolean        browser_core_exists                 (void);
 BrowserCore    *browser_core_get                    (void);
diff --git a/tools/browser/browser-favorites.h b/tools/browser/browser-favorites.h
index 65e3756..79e234b 100644
--- a/tools/browser/browser-favorites.h
+++ b/tools/browser/browser-favorites.h
@@ -2,7 +2,7 @@
  * Copyright (C) 2009 - 2011 Vivien Malerba
  *
  * This Library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public License as
+ * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
@@ -39,6 +39,9 @@ typedef struct _BrowserFavoritesPrivate BrowserFavoritesPrivate;
  * BrowserFavoritesType:
  * @BROWSER_FAVORITES_TABLES: a database's table favorite
  * @BROWSER_FAVORITES_DIAGRAMS: a diagram favorite
+ * @BROWSER_FAVORITES_QUERIES:
+ * @BROWSER_FAVORITES_DATA_MANAGERS:
+ * @BROWSER_FAVORITES_ACTIONS:
  *
  * Enum to identify favorite's types.
  */
@@ -82,6 +85,17 @@ struct _BrowserFavoritesClass
 	void                    (*favorites_changed) (BrowserFavorites *bfav);
 };
 
+/**
+ * SECTION:browser-favorites
+ * @short_description: Favorites management
+ * @title: BrowserFavorites
+ * @stability: Stable
+ * @see_also:
+ *
+ * Each connection uses a single #BrowserFavorites object to manage its favorites,
+ * see browser_connection_get_favorites().
+ */
+
 GType               browser_favorites_get_type               (void) G_GNUC_CONST;
 
 BrowserFavorites   *browser_favorites_new                    (GdaMetaStore *store);
diff --git a/tools/browser/browser-page.h b/tools/browser/browser-page.h
index 937ea26..caecd90 100644
--- a/tools/browser/browser-page.h
+++ b/tools/browser/browser-page.h
@@ -1,11 +1,11 @@
 /*
- * Copyright (C) 2009 The GNOME Foundation.
+ * Copyright (C) 2009 - 2011 The GNOME Foundation.
  *
  * AUTHORS:
  *      Vivien Malerba <malerba gnome-db org>
  *
  * This Library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public License as
+ * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
@@ -43,6 +43,19 @@ struct _BrowserPageIface {
 	GtkWidget           *(* i_get_tab_label) (BrowserPage *page, GtkWidget **out_close_button);
 };
 
+/**
+ * SECTION:browser-page
+ * @short_description: A "page" within a #BrowserPerspective widget
+ * @title: BrowserPage
+ * @stability: Stable
+ * @see_also:
+ *
+ * Some widgets packed within a #BrowserPerspective can implement
+ * the #BrowserPage interface to specify their specific actions and menu and
+ * toolbar customizations. When they are packed in a notebook, they can also
+ * request some specific tab labels.
+ */
+
 GType               browser_page_get_type          (void) G_GNUC_CONST;
 
 GtkActionGroup     *browser_page_get_actions_group (BrowserPage *page);
diff --git a/tools/browser/browser-perspective.h b/tools/browser/browser-perspective.h
index e6e865b..c1f8289 100644
--- a/tools/browser/browser-perspective.h
+++ b/tools/browser/browser-perspective.h
@@ -1,11 +1,11 @@
 /*
- * Copyright (C) 2009 - 2010 The GNOME Foundation.
+ * Copyright (C) 2009 - 2011 The GNOME Foundation.
  *
  * AUTHORS:
  *      Vivien Malerba <malerba gnome-db org>
  *
  * This Library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public License as
+ * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
@@ -46,6 +46,17 @@ struct _BrowserPerspectiveIface {
 	void                 (* i_page_tab_label_change) (BrowserPerspective *perspective, BrowserPage *page);
 };
 
+/**
+ * SECTION:browser-perspective
+ * @short_description: A "perspective" in a #BrowserWindow window
+ * @title: BrowserPerspective
+ * @stability: Stable
+ * @see_also:
+ *
+ * #BrowserPerspective is an interface used by the #BrowserWindow object to switch
+ * between the activities ("perspectives"); it requires the #GtkWidget.
+ */
+
 GType           browser_perspective_get_type          (void) G_GNUC_CONST;
 
 GtkActionGroup *browser_perspective_get_actions_group (BrowserPerspective *perspective);
diff --git a/tools/browser/browser-window.h b/tools/browser/browser-window.h
index 4797953..542d288 100644
--- a/tools/browser/browser-window.h
+++ b/tools/browser/browser-window.h
@@ -1,8 +1,8 @@
 /* 
- * Copyright (C) 2009 Vivien Malerba
+ * Copyright (C) 2009 - 2011 Vivien Malerba
  *
  * This Library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public License as
+ * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
@@ -51,6 +51,17 @@ struct _BrowserWindowClass
 	void                (*fullscreen_changed) (BrowserWindow *bwin, gboolean fullscreen);
 };
 
+/**
+ * SECTION:browser-window
+ * @short_description: A top level browser window
+ * @title: BrowserWindow
+ * @stability: Stable
+ * @see_also:
+ *
+ * Each top level browser window is represented by a #BrowserWindow object, and uses
+ * a single #BrowserConnection connection object.
+ */
+
 GType               browser_window_get_type               (void) G_GNUC_CONST;
 BrowserWindow      *browser_window_new                    (BrowserConnection *bcnc, BrowserPerspectiveFactory *factory);
 BrowserConnection  *browser_window_get_connection         (BrowserWindow *bwin);
diff --git a/tools/browser/common/ui-formgrid.h b/tools/browser/common/ui-formgrid.h
index 6216b45..20dafc7 100644
--- a/tools/browser/common/ui-formgrid.h
+++ b/tools/browser/common/ui-formgrid.h
@@ -53,9 +53,14 @@ struct _UiFormGridClass
 	GtkVBoxClass       parent_class;
 };
 
-/* 
- * Generic widget's methods 
+/**
+ * SECTION:ui-formgrid
+ * @short_description: Widget embedding both a form and a grid to display a #GdaDataModel's contents
+ * @title: UiFormgrid
+ * @stability: Stable
+ * @see_also:
  */
+
 GType             ui_formgrid_get_type            (void);
 
 GtkWidget        *ui_formgrid_new                 (GdaDataModel *model, GdauiDataProxyInfoFlag flags);
diff --git a/tools/browser/data-manager/data-manager-perspective.h b/tools/browser/data-manager/data-manager-perspective.h
index 91cd8ab..209566b 100644
--- a/tools/browser/data-manager/data-manager-perspective.h
+++ b/tools/browser/data-manager/data-manager-perspective.h
@@ -1,8 +1,8 @@
 /* 
- * Copyright (C) 2009 - 2010 Vivien Malerba
+ * Copyright (C) 2009 - 2011 Vivien Malerba
  *
  * This Library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public License as
+ * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
@@ -48,6 +48,14 @@ struct _DataManagerPerspectiveClass
 	GtkVBoxClass                parent_class;
 };
 
+/**
+ * SECTION:data-manager-perspective
+ * @short_description: Perspective to manipulate data contained in the database
+ * @title: Data Manager perspective
+ * @stability: Stable
+ * @see_also:
+ */
+
 GType                data_manager_perspective_get_type (void) G_GNUC_CONST;
 BrowserPerspective  *data_manager_perspective_new      (BrowserWindow *bwin);
 void                 data_manager_perspective_new_tab  (DataManagerPerspective *dmp, const gchar *xml_spec);
diff --git a/tools/browser/mgr-favorites.h b/tools/browser/mgr-favorites.h
index 46c4740..11b4320 100644
--- a/tools/browser/mgr-favorites.h
+++ b/tools/browser/mgr-favorites.h
@@ -1,5 +1,5 @@
 /* 
- * Copyright (C) 2009 The GNOME Foundation.
+ * Copyright (C) 2009 - 2011 The GNOME Foundation.
  *
  * AUTHORS:
  *      Vivien Malerba <malerba gnome-db org>
@@ -47,6 +47,14 @@ struct _MgrFavoritesClass {
 	GdaTreeManagerClass object_class;
 };
 
+/**
+ * SECTION:mgr-favorites
+ * @short_description: A #GdaTreeManager for the stored favorites
+ * @title: MgrFavorites
+ * @stability: Stable
+ * @see_also:
+ */
+
 GType           mgr_favorites_get_type                 (void) G_GNUC_CONST;
 GdaTreeManager* mgr_favorites_new                      (BrowserConnection *bcnc, BrowserFavoritesType type,
 							gint order_key);
diff --git a/tools/browser/query-exec/query-exec-perspective.h b/tools/browser/query-exec/query-exec-perspective.h
index 0e6edaa..3dd4558 100644
--- a/tools/browser/query-exec/query-exec-perspective.h
+++ b/tools/browser/query-exec/query-exec-perspective.h
@@ -1,5 +1,5 @@
 /* 
- * Copyright (C) 2009 Vivien Malerba
+ * Copyright (C) 2009 - 2011 Vivien Malerba
  *
  * This Library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public License as
@@ -48,6 +48,14 @@ struct _QueryExecPerspectiveClass
 	GtkVBoxClass         parent_class;
 };
 
+/**
+ * SECTION:query-exec-perspective
+ * @short_description: Perspective to execute SQL commands
+ * @title: Query Exec perspective
+ * @stability: Stable
+ * @see_also:
+ */
+
 GType                query_exec_perspective_get_type               (void) G_GNUC_CONST;
 BrowserPerspective  *query_exec_perspective_new                    (BrowserWindow *bwin);
 
diff --git a/tools/browser/schema-browser/schema-browser-perspective.h b/tools/browser/schema-browser/schema-browser-perspective.h
index 6e8d060..1d894ef 100644
--- a/tools/browser/schema-browser/schema-browser-perspective.h
+++ b/tools/browser/schema-browser/schema-browser-perspective.h
@@ -1,5 +1,5 @@
 /* 
- * Copyright (C) 2009 Vivien Malerba
+ * Copyright (C) 2009 - 2011 Vivien Malerba
  *
  * This Library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public License as
@@ -48,6 +48,14 @@ struct _SchemaBrowserPerspectiveClass
 	GtkVBoxClass         parent_class;
 };
 
+/**
+ * SECTION:schema-browser-perspective
+ * @short_description: Perspective to analyse the database's schema
+ * @title: Schema Browser perspective
+ * @stability: Stable
+ * @see_also:
+ */
+
 GType                schema_browser_perspective_get_type               (void) G_GNUC_CONST;
 BrowserPerspective  *schema_browser_perspective_new                    (BrowserWindow *bwin);
 void                 schema_browser_perspective_display_table_info     (SchemaBrowserPerspective *bpers,
diff --git a/tools/browser/support.h b/tools/browser/support.h
index eec7e75..d1af082 100644
--- a/tools/browser/support.h
+++ b/tools/browser/support.h
@@ -33,6 +33,14 @@ extern GtkOSXApplication *theApp;
 
 G_BEGIN_DECLS
 
+/**
+ * SECTION:support
+ * @short_description: Misc. functions for various situations
+ * @title: Support functions
+ * @stability: Stable
+ * @see_also:
+ */
+
 BrowserConnection *browser_connection_open (GError **error);
 gboolean           browser_connection_close (GtkWindow *parent, BrowserConnection *bcnc);
 void               browser_show_error (GtkWindow *parent, const gchar *format, ...);
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]