[gtk+] GtkApplication: documentation additions



commit e7d6400149e05d6f9643c33292b5e9d18bfb6b53
Author: Matthias Clasen <mclasen redhat com>
Date:   Tue Jan 24 22:22:08 2012 -0500

    GtkApplication: documentation additions
    
    Document that startup() needs to chain up first.

 gtk/gtkapplication.c |   10 +++++++---
 1 files changed, 7 insertions(+), 3 deletions(-)
---
diff --git a/gtk/gtkapplication.c b/gtk/gtkapplication.c
index d2aabc4..1109015 100644
--- a/gtk/gtkapplication.c
+++ b/gtk/gtkapplication.c
@@ -104,7 +104,7 @@
  * </example>
  *
  * GtkApplication optionally registers with a session manager
- * of the users session (if you set the #GtkApplication::register-session
+ * of the users session (if you set the #GtkApplication:register-session
  * property) and offers various functionality related to the session
  * life-cycle.
  *
@@ -767,7 +767,7 @@ gtk_application_class_init (GtkApplicationClass *class)
    * applications a chance to object.
    *
    * To receive this signal, you need to set the
-   * #GtkApplication::register-session property
+   * #GtkApplication:register-session property
    * when creating the application object.
    *
    * Since: 3.4
@@ -778,7 +778,7 @@ gtk_application_class_init (GtkApplicationClass *class)
                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 
   /**
-   * GtkApplication::register-session:
+   * GtkApplication:register-session:
    *
    * Set this property to %TRUE to register with the session manager
    * and receive the #GtkApplication::quit signal when the session
@@ -817,6 +817,10 @@ gtk_application_class_init (GtkApplicationClass *class)
  * This function calls g_type_init() for you. gtk_init() is called
  * as soon as the application gets registered as the primary instance.
  *
+ * Concretely, gtk_init() is called in the default handler for the
+ * startup() signal. Therefore, #GtkApplication subclasses should
+ * chain up in their startup() handler before using any GTK+ API.
+ *
  * Note that commandline arguments are not passed to gtk_init().
  * All GTK+ functionality that is available via commandline arguments
  * can also be achieved by setting suitable environment variables



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]