[Xfce4-commits] <midori:master> Clarify MidoriApp signal documentation

[Christian Dywan]

Updating branch refs/heads/master
         to 3682b7755e9eaa90fdd2640fffbf1e115e5e4677 (commit)
       from b4a18b2aef4d5be2ff84d4ee08262ff4021c6069 (commit)

commit 3682b7755e9eaa90fdd2640fffbf1e115e5e4677
Author: Christian Dywan <christian at twotoasts.de>
Date:   Fri Mar 19 20:13:36 2010 +0100

    Clarify MidoriApp signal documentation

 midori/midori-app.c |   20 ++++++++++++++++++--
 1 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/midori/midori-app.c b/midori/midori-app.c
index 52716ee..2991003 100644
--- a/midori/midori-app.c
+++ b/midori/midori-app.c
@@ -227,6 +227,14 @@ midori_app_class_init (MidoriAppClass* class)
 {
     GObjectClass* gobject_class;
 
+    /**
+     * MidoriApp::add-browser:
+     * @app: the object on which the signal is emitted
+     * @browser: a #MidoriBrowser
+     *
+     * A new browser is being added to the app,
+     * see midori_app_add_browser().
+     */
     signals[ADD_BROWSER] = g_signal_new (
         "add-browser",
         G_TYPE_FROM_CLASS (class),
@@ -243,7 +251,8 @@ midori_app_class_init (MidoriAppClass* class)
      * @app: the object on which the signal is emitted
      * @browser: a #MidoriBrowser
      *
-     * A new browser is being added to the app.
+     * A browser is being removed from the app because it
+     * was destroyed.
      *
      * Since: 0.1.7
      */
@@ -258,6 +267,13 @@ midori_app_class_init (MidoriAppClass* class)
         G_TYPE_NONE, 1,
         MIDORI_TYPE_BROWSER);
 
+    /**
+     * MidoriApp::quit:
+     * @app: the object on which the signal is emitted
+     * @browser: a #MidoriBrowser
+     *
+     * The app is being quit, see midori_app_quit().
+     */
     signals[QUIT] = g_signal_new (
         "quit",
         G_TYPE_FROM_CLASS (class),
@@ -1135,7 +1151,7 @@ midori_app_create_browser (MidoriApp* app)
  * midori_app_quit:
  * @app: a #MidoriApp
  *
- * Quits the #MidoriApp singleton.
+ * Quits the #MidoriApp.
  *
  * Since 0.1.2 the "quit" signal is always emitted before quitting.
  **/