[glib] [GApplication] Tweak docs a bit
- From: Colin Walters <walters src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] [GApplication] Tweak docs a bit
- Date: Thu, 10 Jun 2010 13:24:49 +0000 (UTC)
commit 8cab5e46934554d899274dd96e6a1d5fbbbc9ea6
Author: Colin Walters <walters verbum org>
Date: Wed Jun 9 17:17:14 2010 -0400
[GApplication] Tweak docs a bit
gio/gapplication.c | 34 ++++++++++++++++++++++++----------
1 files changed, 24 insertions(+), 10 deletions(-)
---
diff --git a/gio/gapplication.c b/gio/gapplication.c
index 7ba5f43..5981e9b 100644
--- a/gio/gapplication.c
+++ b/gio/gapplication.c
@@ -45,18 +45,32 @@
* @title: GApplication
* @short_description: Core application class
*
- * A #GApplication is the foundation of an application, unique for
- * a given application identifier. The #GApplication wraps some
- * low-level platform-specific services; it's expected that most
- * software will use a higher-level application class such as
- * #GtkApplication or #MxApplication.
+ * A #GApplication is the foundation of an application, unique for a
+ * given application identifier. The #GApplication wraps some
+ * low-level platform-specific services and is intended to act as the
+ * foundation for higher-level application classes such as
+ * #GtkApplication or #MxApplication. In general, you should not use
+ * this class outside of a higher level framework. By default,
+ * g_application_register_with_data() will invoke g_error() if it is
+ * run in a context where it cannot support its core features. Note
+ * that g_error() is by default fatal.
*
- * In addition to single-instance-ness, #GApplication provides support
- * for 'actions', which can be presented to the user in a platform-specific
- * way (e.g. Windows 7 jump lists). Note that these are just simple actions
- * without parameters. For more flexible scriptability, implementing a
- * a separate D-Bus interface is recommended, see e.g.
+ * One of the core features that #GApplication provides is process
+ * uniqueness, in the context of a "session". The session concept is
+ * platform-dependent, but corresponds roughly to a graphical desktop
+ * login. When your application is launched again, its arguments
+ * are passed through platform communication to the already running
+ * program.
+ *
+ * In addition, #GApplication provides support for 'actions', which
+ * can be presented to the user in a platform-specific way
+ * (e.g. Windows 7 jump lists). Note that these are just simple
+ * actions without parameters. For more flexible scriptability,
+ * implementing a a separate D-Bus interface is recommended, see e.g.
* <xref linkend="gdbus-convenience"/>.
+ *
+ * Finally, #GApplication acts as a basic lifecycle root; see the
+ * g_application_run() and g_application_quit_with_data() methods.
*
* Before using #GApplication, you must choose an "application identifier".
* The expected form of an application identifier is very close to that of
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]