luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-12 13:49:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Match up parameter names

Browse Source 
and similar cleanups to make gtk-doc happy.
This commit is contained in:
Matthias Clasen 2010-05-11 20:57:44 -04:00
parent 1d43e4140b
commit e4b1e48fca
5 changed files with 71 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/gio/gio-sections.txt
View File

@ -2196,7 +2196,6 @@ g_unix_credentials_message_get_type
<TITLE>GCredentials</TITLE> <TITLE>GCredentials</TITLE>
GCredentials GCredentials
GCredentialsClass GCredentialsClass
GCredentialType
g_credentials_new g_credentials_new
g_credentials_to_string g_credentials_to_string
g_credentials_get_native g_credentials_get_native

17
gio/gdbusconnection.c
View File

@ -1435,6 +1435,7 @@ g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
/** /**
* g_dbus_connection_send_message_with_reply_finish: * g_dbus_connection_send_message_with_reply_finish:
* @connection: a #GDBusConnection
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply(). * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
* @error: Return location for error or %NULL. * @error: Return location for error or %NULL.
* *
@ -1949,7 +1950,7 @@ async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
* @stream: A #GIOStream. * @stream: A #GIOStream.
* @guid: The GUID to use if a authenticating as a server or %NULL. * @guid: The GUID to use if a authenticating as a server or %NULL.
* @flags: Flags describing how to make the connection. * @flags: Flags describing how to make the connection.
* @authentication_observer: A #GDBusAuthObserver or %NULL. * @observer: A #GDBusAuthObserver or %NULL.
* @cancellable: A #GCancellable or %NULL. * @cancellable: A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied. * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
* @user_data: The data to pass to @callback. * @user_data: The data to pass to @callback.
@ -1958,7 +1959,7 @@ async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
* with the end represented by @stream. * with the end represented by @stream.
* *
* If %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER is set in @flags, * If %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER is set in @flags,
* @auth_observer (if not %NULL) is used to assist in the client * @observer (if not %NULL) is used to assist in the client
* authentication process. * authentication process.
* *
* When the operation is finished, @callback will be invoked. You can * When the operation is finished, @callback will be invoked. You can
@ -1975,7 +1976,7 @@ void
g_dbus_connection_new (GIOStream *stream, g_dbus_connection_new (GIOStream *stream,
const gchar *guid, const gchar *guid,
GDBusConnectionFlags flags, GDBusConnectionFlags flags,
GDBusAuthObserver *authentication_observer, GDBusAuthObserver *observer,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
gpointer user_data) gpointer user_data)
@ -1989,7 +1990,7 @@ g_dbus_connection_new (GIOStream *stream,
"stream", stream, "stream", stream,
"guid", guid, "guid", guid,
"flags", flags, "flags", flags,
"authentication-observer", authentication_observer, "authentication-observer", observer,
NULL); NULL);
} }
@ -2031,7 +2032,7 @@ g_dbus_connection_new_finish (GAsyncResult *res,
* @stream: A #GIOStream. * @stream: A #GIOStream.
* @guid: The GUID to use if a authenticating as a server or %NULL. * @guid: The GUID to use if a authenticating as a server or %NULL.
* @flags: Flags describing how to make the connection. * @flags: Flags describing how to make the connection.
* @authentication_observer: A #GDBusAuthObserver or %NULL. * @observer: A #GDBusAuthObserver or %NULL.
* @cancellable: A #GCancellable or %NULL. * @cancellable: A #GCancellable or %NULL.
* @error: Return location for error or %NULL. * @error: Return location for error or %NULL.
* *
@ -2039,7 +2040,7 @@ g_dbus_connection_new_finish (GAsyncResult *res,
* with the end represented by @stream. * with the end represented by @stream.
* *
* If %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER is set in @flags, * If %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER is set in @flags,
* @auth_observer (if not %NULL) is used to assist in the client * @observer (if not %NULL) is used to assist in the client
* authentication process. * authentication process.
* *
* This is a synchronous failable constructor. See * This is a synchronous failable constructor. See
@ -2053,7 +2054,7 @@ GDBusConnection *
g_dbus_connection_new_sync (GIOStream *stream, g_dbus_connection_new_sync (GIOStream *stream,
const gchar *guid, const gchar *guid,
GDBusConnectionFlags flags, GDBusConnectionFlags flags,
GDBusAuthObserver *authentication_observer, GDBusAuthObserver *observer,
GCancellable *cancellable, GCancellable *cancellable,
GError **error) GError **error)
{ {
@ -2065,7 +2066,7 @@ g_dbus_connection_new_sync (GIOStream *stream,
"stream", stream, "stream", stream,
"guid", guid, "guid", guid,
"flags", flags, "flags", flags,
"authentication-observer", authentication_observer, "authentication-observer", observer,
NULL); NULL);
} }

4
gio/gdbusconnection.h
View File

@ -102,7 +102,7 @@ GDBusConnection *g_bus_get_sync (GBusType bus_type,
void g_dbus_connection_new (GIOStream *stream, void g_dbus_connection_new (GIOStream *stream,
const gchar *guid, const gchar *guid,
GDBusConnectionFlags flags, GDBusConnectionFlags flags,
GDBusAuthObserver *auth_observer, GDBusAuthObserver *observer,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
gpointer user_data); gpointer user_data);
@ -111,7 +111,7 @@ GDBusConnection *g_dbus_connection_new_finish (GAsyncResult
GDBusConnection *g_dbus_connection_new_sync (GIOStream *stream, GDBusConnection *g_dbus_connection_new_sync (GIOStream *stream,
const gchar *guid, const gchar *guid,
GDBusConnectionFlags flags, GDBusConnectionFlags flags,
GDBusAuthObserver *auth_observer, GDBusAuthObserver *observer,
GCancellable *cancellable, GCancellable *cancellable,
GError **error); GError **error);

82
gio/gdbusintrospection.c
View File

@ -879,11 +879,11 @@ g_dbus_interface_info_generate_xml (const GDBusInterfaceInfo *info,
/** /**
* g_dbus_node_info_generate_xml: * g_dbus_node_info_generate_xml:
* @node_info: A #GDBusNodeInfo. * @info: A #GDBusNodeInfo.
* @indent: Indentation level. * @indent: Indentation level.
* @string_builder: A #GString to to append XML data to. * @string_builder: A #GString to to append XML data to.
* *
* Appends an XML representation of @node_info (and its children) to @string_builder. * Appends an XML representation of @info (and its children) to @string_builder.
* *
* This function is typically used for generating introspection XML documents at run-time for * This function is typically used for generating introspection XML documents at run-time for
* handling the <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> method. * handling the <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> method.
@ -891,17 +891,17 @@ g_dbus_interface_info_generate_xml (const GDBusInterfaceInfo *info,
* Since: 2.26 * Since: 2.26
*/ */
void void
g_dbus_node_info_generate_xml (const GDBusNodeInfo *node_info, g_dbus_node_info_generate_xml (const GDBusNodeInfo *info,
guint indent, guint indent,
GString *string_builder) GString *string_builder)
{ {
guint n; guint n;
g_string_append_printf (string_builder, "%*s<node", indent, ""); g_string_append_printf (string_builder, "%*s<node", indent, "");
if (node_info->path != NULL) if (info->path != NULL)
g_string_append_printf (string_builder, " name=\"%s\"", node_info->path); g_string_append_printf (string_builder, " name=\"%s\"", info->path);
if (node_info->interfaces == NULL && node_info->nodes == NULL && node_info->annotations == NULL) if (info->interfaces == NULL && info->nodes == NULL && info->annotations == NULL)
{ {
g_string_append (string_builder, "/>\n"); g_string_append (string_builder, "/>\n");
} }
@ -909,18 +909,18 @@ g_dbus_node_info_generate_xml (const GDBusNodeInfo *node_info,
{ {
g_string_append (string_builder, ">\n"); g_string_append (string_builder, ">\n");
for (n = 0; node_info->annotations != NULL && node_info->annotations[n] != NULL; n++) for (n = 0; info->annotations != NULL && info->annotations[n] != NULL; n++)
g_dbus_annotation_info_generate_xml (node_info->annotations[n], g_dbus_annotation_info_generate_xml (info->annotations[n],
indent + 2, indent + 2,
string_builder); string_builder);
for (n = 0; node_info->interfaces != NULL && node_info->interfaces[n] != NULL; n++) for (n = 0; info->interfaces != NULL && info->interfaces[n] != NULL; n++)
g_dbus_interface_info_generate_xml (node_info->interfaces[n], g_dbus_interface_info_generate_xml (info->interfaces[n],
indent + 2, indent + 2,
string_builder); string_builder);
for (n = 0; node_info->nodes != NULL && node_info->nodes[n] != NULL; n++) for (n = 0; info->nodes != NULL && info->nodes[n] != NULL; n++)
g_dbus_node_info_generate_xml (node_info->nodes[n], g_dbus_node_info_generate_xml (info->nodes[n],
indent + 2, indent + 2,
string_builder); string_builder);
@ -931,7 +931,8 @@ g_dbus_node_info_generate_xml (const GDBusNodeInfo *node_info,
/* ---------------------------------------------------------------------------------------------------- */ /* ---------------------------------------------------------------------------------------------------- */
static GDBusAnnotationInfo ** static GDBusAnnotationInfo **
parse_data_steal_annotations (ParseData *data, guint *out_num_elements) parse_data_steal_annotations (ParseData *data,
guint *out_num_elements)
{ {
GDBusAnnotationInfo **ret; GDBusAnnotationInfo **ret;
if (out_num_elements != NULL) if (out_num_elements != NULL)
@ -948,7 +949,8 @@ parse_data_steal_annotations (ParseData *data, guint *out_num_elements)
} }
static GDBusArgInfo ** static GDBusArgInfo **
parse_data_steal_args (ParseData *data, guint *out_num_elements) parse_data_steal_args (ParseData *data,
guint *out_num_elements)
{ {
GDBusArgInfo **ret; GDBusArgInfo **ret;
if (out_num_elements != NULL) if (out_num_elements != NULL)
@ -965,7 +967,8 @@ parse_data_steal_args (ParseData *data, guint *out_num_elements)
} }
static GDBusArgInfo ** static GDBusArgInfo **
parse_data_steal_out_args (ParseData *data, guint *out_num_elements) parse_data_steal_out_args (ParseData *data,
guint *out_num_elements)
{ {
GDBusArgInfo **ret; GDBusArgInfo **ret;
if (out_num_elements != NULL) if (out_num_elements != NULL)
@ -982,7 +985,8 @@ parse_data_steal_out_args (ParseData *data, guint *out_num_elements)
} }
static GDBusMethodInfo ** static GDBusMethodInfo **
parse_data_steal_methods (ParseData *data, guint *out_num_elements) parse_data_steal_methods (ParseData *data,
guint *out_num_elements)
{ {
GDBusMethodInfo **ret; GDBusMethodInfo **ret;
if (out_num_elements != NULL) if (out_num_elements != NULL)
@ -999,7 +1003,8 @@ parse_data_steal_methods (ParseData *data, guint *out_num_elements)
} }
static GDBusSignalInfo ** static GDBusSignalInfo **
parse_data_steal_signals (ParseData *data, guint *out_num_elements) parse_data_steal_signals (ParseData *data,
guint *out_num_elements)
{ {
GDBusSignalInfo **ret; GDBusSignalInfo **ret;
if (out_num_elements != NULL) if (out_num_elements != NULL)
@ -1016,7 +1021,8 @@ parse_data_steal_signals (ParseData *data, guint *out_num_elements)
} }
static GDBusPropertyInfo ** static GDBusPropertyInfo **
parse_data_steal_properties (ParseData *data, guint *out_num_elements) parse_data_steal_properties (ParseData *data,
guint *out_num_elements)
{ {
GDBusPropertyInfo **ret; GDBusPropertyInfo **ret;
if (out_num_elements != NULL) if (out_num_elements != NULL)
@ -1033,7 +1039,8 @@ parse_data_steal_properties (ParseData *data, guint *out_num_elements)
} }
static GDBusInterfaceInfo ** static GDBusInterfaceInfo **
parse_data_steal_interfaces (ParseData *data, guint *out_num_elements) parse_data_steal_interfaces (ParseData *data,
guint *out_num_elements)
{ {
GDBusInterfaceInfo **ret; GDBusInterfaceInfo **ret;
if (out_num_elements != NULL) if (out_num_elements != NULL)
@ -1050,7 +1057,8 @@ parse_data_steal_interfaces (ParseData *data, guint *out_num_elements)
} }
static GDBusNodeInfo ** static GDBusNodeInfo **
parse_data_steal_nodes (ParseData *data, guint *out_num_elements) parse_data_steal_nodes (ParseData *data,
guint *out_num_elements)
{ {
GDBusNodeInfo **ret; GDBusNodeInfo **ret;
if (out_num_elements != NULL) if (out_num_elements != NULL)
@ -1151,7 +1159,8 @@ parse_data_free_nodes (ParseData *data)
/* ---------------------------------------------------------------------------------------------------- */ /* ---------------------------------------------------------------------------------------------------- */
static GDBusAnnotationInfo * static GDBusAnnotationInfo *
parse_data_get_annotation (ParseData *data, gboolean create_new) parse_data_get_annotation (ParseData *data,
gboolean create_new)
{ {
if (create_new) if (create_new)
g_ptr_array_add (data->annotations, g_new0 (GDBusAnnotationInfo, 1)); g_ptr_array_add (data->annotations, g_new0 (GDBusAnnotationInfo, 1));
@ -1159,7 +1168,8 @@ parse_data_get_annotation (ParseData *data, gboolean create_new)
} }
static GDBusArgInfo * static GDBusArgInfo *
parse_data_get_arg (ParseData *data, gboolean create_new) parse_data_get_arg (ParseData *data,
gboolean create_new)
{ {
if (create_new) if (create_new)
g_ptr_array_add (data->args, g_new0 (GDBusArgInfo, 1)); g_ptr_array_add (data->args, g_new0 (GDBusArgInfo, 1));
@ -1167,7 +1177,8 @@ parse_data_get_arg (ParseData *data, gboolean create_new)
} }
static GDBusArgInfo * static GDBusArgInfo *
parse_data_get_out_arg (ParseData *data, gboolean create_new) parse_data_get_out_arg (ParseData *data,
gboolean create_new)
{ {
if (create_new) if (create_new)
g_ptr_array_add (data->out_args, g_new0 (GDBusArgInfo, 1)); g_ptr_array_add (data->out_args, g_new0 (GDBusArgInfo, 1));
@ -1175,7 +1186,8 @@ parse_data_get_out_arg (ParseData *data, gboolean create_new)
} }
static GDBusMethodInfo * static GDBusMethodInfo *
parse_data_get_method (ParseData *data, gboolean create_new) parse_data_get_method (ParseData *data,
gboolean create_new)
{ {
if (create_new) if (create_new)
g_ptr_array_add (data->methods, g_new0 (GDBusMethodInfo, 1)); g_ptr_array_add (data->methods, g_new0 (GDBusMethodInfo, 1));
@ -1183,7 +1195,8 @@ parse_data_get_method (ParseData *data, gboolean create_new)
} }
static GDBusSignalInfo * static GDBusSignalInfo *
parse_data_get_signal (ParseData *data, gboolean create_new) parse_data_get_signal (ParseData *data,
gboolean create_new)
{ {
if (create_new) if (create_new)
g_ptr_array_add (data->signals, g_new0 (GDBusSignalInfo, 1)); g_ptr_array_add (data->signals, g_new0 (GDBusSignalInfo, 1));
@ -1191,7 +1204,8 @@ parse_data_get_signal (ParseData *data, gboolean create_new)
} }
static GDBusPropertyInfo * static GDBusPropertyInfo *
parse_data_get_property (ParseData *data, gboolean create_new) parse_data_get_property (ParseData *data,
gboolean create_new)
{ {
if (create_new) if (create_new)
g_ptr_array_add (data->properties, g_new0 (GDBusPropertyInfo, 1)); g_ptr_array_add (data->properties, g_new0 (GDBusPropertyInfo, 1));
@ -1199,7 +1213,8 @@ parse_data_get_property (ParseData *data, gboolean create_new)
} }
static GDBusInterfaceInfo * static GDBusInterfaceInfo *
parse_data_get_interface (ParseData *data, gboolean create_new) parse_data_get_interface (ParseData *data,
gboolean create_new)
{ {
if (create_new) if (create_new)
g_ptr_array_add (data->interfaces, g_new0 (GDBusInterfaceInfo, 1)); g_ptr_array_add (data->interfaces, g_new0 (GDBusInterfaceInfo, 1));
@ -1207,7 +1222,8 @@ parse_data_get_interface (ParseData *data, gboolean create_new)
} }
static GDBusNodeInfo * static GDBusNodeInfo *
parse_data_get_node (ParseData *data, gboolean create_new) parse_data_get_node (ParseData *data,
gboolean create_new)
{ {
if (create_new) if (create_new)
g_ptr_array_add (data->nodes, g_new0 (GDBusNodeInfo, 1)); g_ptr_array_add (data->nodes, g_new0 (GDBusNodeInfo, 1));
@ -2024,27 +2040,27 @@ g_dbus_interface_info_lookup_property (const GDBusInterfaceInfo *info,
/** /**
* g_dbus_node_info_lookup_interface: * g_dbus_node_info_lookup_interface:
* @node_info: A #GDBusNodeInfo. * @info: A #GDBusNodeInfo.
* @name: A D-Bus interface name. * @name: A D-Bus interface name.
* *
* Looks up information about an interface. * Looks up information about an interface.
* *
* This cost of this function is O(n) in number of interfaces. * This cost of this function is O(n) in number of interfaces.
* *
* Returns: A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @node_info. * Returns: A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info.
* *
* Since: 2.26 * Since: 2.26
*/ */
const GDBusInterfaceInfo * const GDBusInterfaceInfo *
g_dbus_node_info_lookup_interface (const GDBusNodeInfo *node_info, g_dbus_node_info_lookup_interface (const GDBusNodeInfo *info,
const gchar *name) const gchar *name)
{ {
guint n; guint n;
const GDBusInterfaceInfo *result; const GDBusInterfaceInfo *result;
for (n = 0; node_info->interfaces != NULL && node_info->interfaces[n] != NULL; n++) for (n = 0; info->interfaces != NULL && info->interfaces[n] != NULL; n++)
{ {
const GDBusInterfaceInfo *i = node_info->interfaces[n]; const GDBusInterfaceInfo *i = info->interfaces[n];
if (g_strcmp0 (i->name, name) == 0) if (g_strcmp0 (i->name, name) == 0)
{ {

2
gio/gunixcredentialsmessage.c
View File

@ -300,7 +300,7 @@ g_unix_credentials_message_new (void)
} }
/** /**
* g_unix_credentials_message_new: * g_unix_credentials_message_new_with_credentials:
* @credentials: A #GCredentials object. * @credentials: A #GCredentials object.
* *
* Creates a new #GUnixCredentialsMessage holding @credentials. * Creates a new #GUnixCredentialsMessage holding @credentials.