Fix documentation issues

Gtk-doc is unhappy if the parameter names don't match between header
and source.
This commit is contained in:
Matthias Clasen 2010-08-21 15:34:40 -04:00
parent 4831a102e5
commit b876e47e3b
2 changed files with 12 additions and 10 deletions

View File

@ -340,6 +340,7 @@ g_network_service_get_scheme (GNetworkService *srv)
/** /**
* g_network_service_set_scheme: * g_network_service_set_scheme:
* @srv: a #GNetworkService * @srv: a #GNetworkService
* @scheme: a URI scheme
* *
* Set's the URI scheme used to resolve proxies. By default, the service name * Set's the URI scheme used to resolve proxies. By default, the service name
* is used as scheme. * is used as scheme.
@ -347,7 +348,8 @@ g_network_service_get_scheme (GNetworkService *srv)
* Since: 2.26 * Since: 2.26
*/ */
void void
g_network_service_set_scheme (GNetworkService *srv, const gchar *scheme) g_network_service_set_scheme (GNetworkService *srv,
const gchar *scheme)
{ {
g_return_if_fail (G_IS_NETWORK_SERVICE (srv)); g_return_if_fail (G_IS_NETWORK_SERVICE (srv));

View File

@ -82,25 +82,25 @@ g_proxy_get_default_for_protocol (const gchar *protocol)
/** /**
* g_proxy_connect: * g_proxy_connect:
* @proxy: a #GProxy * @proxy: a #GProxy
* @io_stream: a #GIOStream * @connection: a #GIOStream
* @proxy_address: a #GProxyAddress * @proxy_address: a #GProxyAddress
* @cancellable: a #GCancellable * @cancellable: a #GCancellable
* @error: return #GError * @error: return #GError
* *
* Given @io_stream to communicate with a proxy (eg, a * Given @connection to communicate with a proxy (eg, a
* #GSocketConnection that is connected to the proxy server), this * #GSocketConnection that is connected to the proxy server), this
* does the necessary handshake to connect to @proxy_address, and if * does the necessary handshake to connect to @proxy_address, and if
* required, wraps the #GIOStream to handle proxy payload. * required, wraps the #GIOStream to handle proxy payload.
* *
* Return value: a #GIOStream that will replace @io_stream. This might * Return value: a #GIOStream that will replace @connection. This might
* be the same as @io_stream, in which case a reference * be the same as @connection, in which case a reference
* will be added. * will be added.
* *
* Since: 2.26 * Since: 2.26
*/ */
GIOStream * GIOStream *
g_proxy_connect (GProxy *proxy, g_proxy_connect (GProxy *proxy,
GIOStream *io_stream, GIOStream *connection,
GProxyAddress *proxy_address, GProxyAddress *proxy_address,
GCancellable *cancellable, GCancellable *cancellable,
GError **error) GError **error)
@ -112,7 +112,7 @@ g_proxy_connect (GProxy *proxy,
iface = G_PROXY_GET_IFACE (proxy); iface = G_PROXY_GET_IFACE (proxy);
return (* iface->connect) (proxy, return (* iface->connect) (proxy,
io_stream, connection,
proxy_address, proxy_address,
cancellable, cancellable,
error); error);
@ -121,7 +121,7 @@ g_proxy_connect (GProxy *proxy,
/** /**
* g_proxy_connect_async: * g_proxy_connect_async:
* @proxy: a #GProxy * @proxy: a #GProxy
* @io-stream: a #GIOStream * @connection: a #GIOStream
* @proxy_address: a #GProxyAddress * @proxy_address: a #GProxyAddress
* @cancellable: a #GCancellable * @cancellable: a #GCancellable
* @callback: a #GAsyncReadyCallback * @callback: a #GAsyncReadyCallback
@ -133,7 +133,7 @@ g_proxy_connect (GProxy *proxy,
*/ */
void void
g_proxy_connect_async (GProxy *proxy, g_proxy_connect_async (GProxy *proxy,
GIOStream *io_stream, GIOStream *connection,
GProxyAddress *proxy_address, GProxyAddress *proxy_address,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
@ -146,7 +146,7 @@ g_proxy_connect_async (GProxy *proxy,
iface = G_PROXY_GET_IFACE (proxy); iface = G_PROXY_GET_IFACE (proxy);
(* iface->connect_async) (proxy, (* iface->connect_async) (proxy,
io_stream, connection,
proxy_address, proxy_address,
cancellable, cancellable,
callback, callback,