[gtk+/wip/session: 6/6] Documentation updates

[Matthias Clasen <matthiasc src gnome org>]

commit 2a02a2d3b4cbe8a759e52c50aa3643b54a1b95cb
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Jan 6 01:05:31 2012 -0500

    Documentation updates

 gtk/gtkapplication.c |   36 +++++++++++++++++++++++-------------
 1 files changed, 23 insertions(+), 13 deletions(-)
---
diff --git a/gtk/gtkapplication.c b/gtk/gtkapplication.c
index 58576b0..e08a5ba 100644
--- a/gtk/gtkapplication.c
+++ b/gtk/gtkapplication.c
@@ -100,17 +100,18 @@
  * </programlisting>
  * </example>
  *
- * GtkApplication automatically registers with a session manager
- * of the users session (unless you use the %GTK_APPLICATION_NO_SESSION
+ * GtkApplication optionally registers with a session manager
+ * of the users session (if you use the  %GTK_APPLICATION_INTERACTS_SESSION
  * flag) and allows to intercept the session end by connecting to
- * the #GtkApplication::quit-requested signal. An application can
- * block various ways to end the session with the gtk_application_inhibit()
- * function. Typical use cases for this kind of inhibiting are
- * long-running, uninterruptible operations, such as burning a CD
- * or performing a disk backup. The session manager may not honor
- * the inhibitor, but it can be expected to inform the user about
- * the negative consequences of ending the session while inhibitors
- * are present.
+ * the #GtkApplication::quit-requested signal.
+ *
+ * An application can block various ways to end the session with
+ * the gtk_application_inhibit() function. Typical use cases for
+ * this kind of inhibiting are long-running, uninterruptible operations,
+ * such as burning a CD or performing a disk backup. The session
+ * manager may not honor the inhibitor, but it can be expected to
+ * inform the user about the negative consequences of ending the
+ * session while inhibitors are present.
  */
 
 enum {
@@ -585,8 +586,9 @@ gtk_application_class_init (GtkApplicationClass *class)
    * #GApplication::quit or #GtkApplication::quit-cancelled signals is
    * emitted.
    *
-   * If the application does not connect to this signal, then
-   * #GtkApplication will automatically return %TRUE on its behalf.
+   * To receive this signal, you need to pass the
+   * %GTK_APPLICATION_INTERACTS_SESSION flag when creating the application
+   * object.
    *
    * Since: 3.4
    */
@@ -604,6 +606,10 @@ gtk_application_class_init (GtkApplicationClass *class)
    * signal, the application can go back to what it was doing before
    * receiving the #GtkApplication::quit-requested signal.
    *
+   * To receive this signal, you need to pass the
+   * %GTK_APPLICATION_INTERACTS_SESSION flag when creating the application
+   * object.
+   *
    * Since: 3.4
    */
   gtk_application_signals[QUIT_CANCELLED] =
@@ -626,6 +632,10 @@ gtk_application_class_init (GtkApplicationClass *class)
    * session manager may decide to end the session without giving
    * applications a chance to object.
    *
+   * To receive this signal, you need to pass the
+   * %GTK_APPLICATION_INTERACTS_SESSION flag when creating the application
+   * object.
+   *
    * Since: 3.4
    */
   gtk_application_signals[QUIT] =
@@ -952,7 +962,7 @@ gtk_application_get_menubar (GtkApplication *application)
 
 /**
  * GtkApplicationFlags:
- * @Gtk_APPLICATION_NO_SESSION: Don't register with the session manager.
+ * @Gtk_APPLICATION_INTERACTS_SESSION: Register with the session manager.
  *
  * Flags that can be used in addition to #GApplicationFlags when creating
  * a #GtkApplication.