[glib/wip/gapplication] Add docs about which apis can be called remotely

[Matthias Clasen <matthiasc src gnome org>]

commit 47a28a45024c4f3e196a8c73136e0774c4f8fc50
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat Jun 5 02:09:00 2010 -0400

    Add docs about which apis can be called remotely

 gio/gapplication.c |   45 ++++++++++++++++++++++++++++++++++++---------
 1 files changed, 36 insertions(+), 9 deletions(-)
---
diff --git a/gio/gapplication.c b/gio/gapplication.c
index 60c275b..5e62c9b 100644
--- a/gio/gapplication.c
+++ b/gio/gapplication.c
@@ -435,6 +435,9 @@ g_application_new_and_register (const char  *appid,
  *
  * Adds an action @name to the list of exported actions of @application.
  *
+ * It is an error to call this function if @application is a proxy for
+ * a remote application.
+ *
  * You can invoke an action using g_application_invoke_action().
  *
  * The newly added action is enabled by default; you can call
@@ -472,7 +475,10 @@ g_application_add_action (GApplication *application,
  * @application: a #GApplication
  * @name: the name of the action to remove
  *
- * Removes the action @name from the list of actions of @application
+ * Removes the action @name from the list of exported actions of @application.
+ *
+ * It is an error to call this function if @application is a proxy for
+ * a remote application.
  *
  * Since: 2.26
  */
@@ -510,8 +516,9 @@ g_application_remove_action (GApplication *application,
  * be emitted.
  *
  * If @application is a proxy, then the specified action will be invoked
- * in the remote process.  It is not necessary to call g_application_add_action()
- * in the current process in order to invoke one remotely.
+ * in the remote process. It is not necessary to call
+ * g_application_add_action() in the current process in order to invoke
+ * one remotely.
  *
  * Since: 2.26
  */
@@ -549,7 +556,10 @@ g_application_invoke_action (GApplication *application,
  * g_application_list_actions:
  * @application: a #GApplication
  *
- * Retrieves the list of action names currently exposed by @application
+ * Retrieves the list of action names currently exported by @application.
+ *
+ * It is an error to call this function if @application is a proxy for
+ * a remote application.
  *
  * Return value: (transfer full): a newly allocation, %NULL-terminated array
  *   of strings containing action names; use g_strfreev() to free the
@@ -592,6 +602,9 @@ g_application_list_actions (GApplication *application)
  * Sets whether the action @name inside @application should be enabled
  * or disabled.
  *
+ * It is an error to call this function if @application is a proxy for
+ * a remote application.
+ *
  * Invoking a disabled action will not result in the #GApplication::action
  * signal being emitted.
  *
@@ -599,7 +612,7 @@ g_application_list_actions (GApplication *application)
  */
 void
 g_application_set_action_enabled (GApplication *application,
-                                  const char   *name,
+                                  const gchar  *name,
                                   gboolean      enabled)
 {
   GApplicationAction *action;
@@ -625,14 +638,19 @@ g_application_set_action_enabled (GApplication *application,
  * g_application_get_action_description:
  * @application: a #GApplication
  * @name: Action name
- * 
+ *
+ * Gets the description of the action @name.
+ *
+ * It is an error to call this function if @application is a proxy for
+ * a remote application.
+ *
  * Returns: Description for the given action named @name
  *
  * Since: 2.26
  */
 G_CONST_RETURN gchar *
 g_application_get_action_description (GApplication *application,
-                                      const char   *name)
+                                      const gchar  *name)
 {
   GApplicationAction *action;
   
@@ -656,13 +674,16 @@ g_application_get_action_description (GApplication *application,
  *
  * See g_application_set_action_enabled().
  *
+ * It is an error to call this function if @application is a proxy for
+ * a remote application.
+ *
  * Return value: %TRUE if the action was enabled, and %FALSE otherwise
  *
  * Since: 2.26
  */
 gboolean
 g_application_get_action_enabled (GApplication *application,
-                                  const char   *name)
+                                  const gchar  *name)
 {
   GApplicationAction *action;
 
@@ -685,6 +706,9 @@ g_application_get_action_enabled (GApplication *application,
  * The default implementation of this virtual function will simply run
  * a main loop.
  *
+ * It is an error to call this function if @application is a proxy for
+ * a remote application.
+ *
  * Since: 2.26
  */
 void
@@ -698,7 +722,7 @@ g_application_run (GApplication *application)
 
 /**
  * g_application_quit:
- * @app: a #GApplication
+ * @application: a #GApplication
  * @timestamp: Platform-specific event timestamp, may be 0 for default
  *
  * Request that the application quits.
@@ -706,6 +730,9 @@ g_application_run (GApplication *application)
  * The default implementation will quit the main loop created by
  * g_application_run().
  *
+ * It is an error to call this function if @application is a proxy for
+ * a remote application.
+ *
  * Returns: %TRUE if the application accepted the request, %FALSE otherwise
  *
  * Since: 2.26