[glib] Documentation fixups
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Documentation fixups
- Date: Thu, 17 Jun 2010 20:09:13 +0000 (UTC)
commit 8a105625b0261e2e3f45241e2892475fa7b45b88
Author: Matthias Clasen <mclasen redhat com>
Date: Thu Jun 17 16:07:52 2010 -0400
Documentation fixups
docs/reference/gio/gio-sections.txt | 10 +++++-----
gio/gapplication.c | 10 ++++++----
gio/gapplication.h | 6 +++---
gio/gunixconnection.c | 8 ++++----
4 files changed, 18 insertions(+), 16 deletions(-)
---
diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index 8dfb742..2771250 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -2128,7 +2128,7 @@ GSettingsBackendPrivate
GSettings
g_settings_new
g_settings_new_with_path
-g_settings_new_with_backend_
+g_settings_new_with_backend
g_settings_new_with_backend_and_path
g_settings_sync
g_settings_get_value
@@ -2624,9 +2624,9 @@ GApplication
GApplicationClass
g_application_new
-g_application_new_and_register
-g_application_register_with_data
-g_application_format_activation_data
+g_application_register
+g_application_try_new
+g_application_unregistered_try_new
g_application_get_instance
g_application_get_id
g_application_add_action
@@ -2637,7 +2637,7 @@ g_application_get_action_enabled
g_application_get_action_description
g_application_invoke_action
g_application_run
-g_application_quit
+g_application_quit_with_data
g_application_is_remote
<SUBSECTION Standard>
G_TYPE_APPLICATION
diff --git a/gio/gapplication.c b/gio/gapplication.c
index 1414b53..950d3ae 100644
--- a/gio/gapplication.c
+++ b/gio/gapplication.c
@@ -536,8 +536,8 @@ g_application_unregistered_try_new (const gchar *appid,
/**
* g_application_register:
- * @app: a #GApplication
- *
+ * @application: a #GApplication
+ *
* By default, #GApplication ensures process uniqueness when
* initialized, but this behavior is controlled by the
* GApplication:register property. If it was given as %FALSE at
@@ -547,13 +547,13 @@ g_application_unregistered_try_new (const gchar *appid,
* Returns: %TRUE if registration was successful
*/
gboolean
-g_application_register (GApplication *app)
+g_application_register (GApplication *application)
{
gboolean unique;
g_return_val_if_fail (G_IS_APPLICATION (app), FALSE);
g_return_val_if_fail (app->priv->is_remote, FALSE);
-
+
if (!_g_application_platform_register (app, &unique, NULL, NULL))
return FALSE;
return unique;
@@ -951,6 +951,8 @@ g_application_get_id (GApplication *application)
* g_application_is_remote:
* @application: a #GApplication
*
+ * Returns whether the object represents a proxy for a remote application.
+ *
* Returns: %TRUE if this object represents a proxy for a remote application.
*/
gboolean
diff --git a/gio/gapplication.h b/gio/gapplication.h
index 206f599..20cc4ea 100644
--- a/gio/gapplication.h
+++ b/gio/gapplication.h
@@ -62,8 +62,8 @@ struct _GApplication
/**
* GApplicationClass:
- * @action: class handler for the #GApplication::action signal
- * @quit: class handler for the #GApplication::quit signal
+ * @action_with_data: class handler for the #GApplication::action-with-data signal
+ * @quit_with_data: class handler for the #GApplication::quit-with-data signal
* @prepare_activation: class handler for the #GApplication::prepare-activation signal
* @run: virtual function, called by g_application_run()
*
@@ -139,7 +139,7 @@ void g_application_invoke_action (GApplication
GVariant *platform_data);
void g_application_run (GApplication *application);
-gboolean g_application_quit_with_data (GApplication *app,
+gboolean g_application_quit_with_data (GApplication *application,
GVariant *platform_data);
gboolean g_application_is_remote (GApplication *application);
diff --git a/gio/gunixconnection.c b/gio/gunixconnection.c
index acd94bb..574b368 100644
--- a/gio/gunixconnection.c
+++ b/gio/gunixconnection.c
@@ -64,8 +64,8 @@ G_DEFINE_TYPE_WITH_CODE (GUnixConnection, g_unix_connection,
* g_unix_connection_send_fd:
* @connection: a #GUnixConnection
* @fd: a file descriptor
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: #GError for error reporting, or %NULL to ignore.
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @error: (allow-none): #GError for error reporting, or %NULL to ignore.
*
* Passes a file descriptor to the recieving side of the
* connection. The recieving end has to call g_unix_connection_receive_fd()
@@ -118,8 +118,8 @@ g_unix_connection_send_fd (GUnixConnection *connection,
/**
* g_unix_connection_receive_fd:
* @connection: a #GUnixConnection
- * @cancellable: optional #GCancellable object, %NULL to ignore
- * @error: #GError for error reporting, or %NULL to ignore
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
+ * @error: (allow-none): #GError for error reporting, or %NULL to ignore
*
* Receives a file descriptor from the sending end of the connection.
* The sending end has to call g_unix_connection_send_fd() for this
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]