Assorted documentation fixes

This commit is contained in:
Matthias Clasen 2012-01-30 15:59:38 -05:00
parent 9902a5e064
commit 49eeaa9bbd
5 changed files with 39 additions and 9 deletions

View File

@ -2948,10 +2948,6 @@ g_dbus_connection_unexport_action_group
GDBusActionGroup
g_dbus_action_group_get
<SUBSECTION>
g_dbus_action_group_activate_action_full
g_dbus_action_group_change_action_state_full
<SUBSECTION Standard>
G_TYPE_DBUS_ACTION_GROUP
G_DBUS_ACTION_GROUP
@ -3783,7 +3779,6 @@ g_resource_lookup_data
g_resource_open_stream
g_resource_enumerate_children
g_resource_get_info
g_resource_set_module
<SUBSECTION Global>
g_resources_register

View File

@ -1661,7 +1661,6 @@ static GApplication *default_app;
/**
* g_application_get_default:
* @returns: (transfer none): the default application for this process, or %NULL
*
* Returns the default #GApplication instance for this process.
*
@ -1671,6 +1670,8 @@ static GApplication *default_app;
*
* If there is no default application then %NULL is returned.
*
* Returns: (transfer none): the default application for this process, or %NULL
*
* Since: 2.32
**/
GApplication *

View File

@ -402,7 +402,7 @@ g_inet_socket_address_get_flowinfo (GInetSocketAddress *address)
}
/**
* g_inet_address_get_scope_id:
* g_inet_socket_address_get_scope_id:
* @address: a %G_SOCKET_FAMILY_IPV6 #GInetAddress
*
* Gets the <literal>sin6_scope_id</literal> field from @address,

View File

@ -35,6 +35,10 @@
* @title: GNetworkMonitor
* @short_description: Network status monitor
* @include: gio/gio.h
*
* #GNetworkMonitor provides an easy-to-use cross-platform API
* for monitoring network connectivity. On Linux, the implementation
* is based on the kernels netlink interface.
*/
/**
@ -158,6 +162,25 @@ g_network_monitor_real_can_reach_async (GNetworkMonitor *monitor,
g_object_unref (simple);
}
/**
* g_network_monitor_can_reach_async:
* @monitor: a #GNetworkMonitor
* @connectable: a #GSocketConnectable
* @cancellable: a #GCancellable, or %NULL
* @callback: (scope async): a #GAsyncReadyCallback to call when the
* request is satisfied
* @user_data: (closure): the data to pass to callback function
*
* Asynchronously attempts to determine whether or not the host
* pointed to by @connectable can be reached, without actually
* trying to connect to it.
*
* For more details, see g_network_monitor_can_reach().
*
* When the operation is finished, @callback will be called.
* You can then call g_network_monitor_can_reach_finish()
* to get the result of the operation.
*/
void
g_network_monitor_can_reach_async (GNetworkMonitor *monitor,
GSocketConnectable *connectable,
@ -187,6 +210,17 @@ g_network_monitor_real_can_reach_finish (GNetworkMonitor *monitor,
return g_simple_async_result_get_op_res_gboolean (simple);
}
/**
* g_network_monitor_can_reach_finish:
* @monitor: a #GNetworkMonitor
* @result: a #GAsyncResult
* @error: return location for errors, or %NULL
*
* Finishes an async network connectivity test.
* See g_network_monitor_can_reach_async().
*
* Return value: %TRUE if network is reachable, %FALSE if not.
*/
gboolean
g_network_monitor_can_reach_finish (GNetworkMonitor *monitor,
GAsyncResult *result,

View File

@ -79,7 +79,7 @@ g_remote_action_group_default_init (GRemoteActionGroupInterface *iface)
/**
* g_remote_action_group_activate_action_full:
* @action_group: a #GDBusActionGroup
* @remote: a #GDBusActionGroup
* @action_name: the name of the action to activate
* @parameter: (allow none): the optional parameter to the activation
* @platform_data: the platform data to send
@ -107,7 +107,7 @@ g_remote_action_group_activate_action_full (GRemoteActionGroup *remote,
}
/**
* g_remote_action_group_activate_action_full:
* g_remote_action_group_change_action_state_full:
* @remote: a #GRemoteActionGroup
* @action_name: the name of the action to change the state of
* @value: the new requested value for the state