summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2013-11-20 13:55:06 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2014-03-10 16:58:42 +0000
commit3796b68023229ddfdf1686847c526db6e965dbaf (patch)
treeffa3a2f9a7c507dc5f74a6409c5cf72642bc67e4
parent9509fdfdf18a18c1a1624019c51433053c381b0a (diff)
downloadlibrest-3796b68023229ddfdf1686847c526db6e965dbaf.tar.gz
docs: Add missing gtk-doc annotations
https://bugzilla.gnome.org/show_bug.cgi?id=712747
-rw-r--r--rest-extras/youtube-proxy.c2
-rw-r--r--rest/rest-proxy-call.c4
-rw-r--r--rest/rest-proxy.h39
3 files changed, 42 insertions, 3 deletions
diff --git a/rest-extras/youtube-proxy.c b/rest-extras/youtube-proxy.c
index 28698e2..be0cf08 100644
--- a/rest-extras/youtube-proxy.c
+++ b/rest-extras/youtube-proxy.c
@@ -343,7 +343,7 @@ _message_wrote_data_cb (SoupMessage *msg,
* @fields: fields
* @incomplete: incomplete
* @callback: (scope async): callback to invoke upon completion
- * @weak_object:
+ * @weak_object: an object instance used to tie the life cycle of the proxy to
* @user_data: user data to pass to the callback
* @error: a #GError pointer, or %NULL
*
diff --git a/rest/rest-proxy-call.c b/rest/rest-proxy-call.c
index 9e15aa3..6e553bd 100644
--- a/rest/rest-proxy-call.c
+++ b/rest/rest-proxy-call.c
@@ -295,7 +295,7 @@ rest_proxy_call_add_header (RestProxyCall *call,
/**
* rest_proxy_call_add_headers:
* @call: The #RestProxyCall
- * @Varargs: Header name and value pairs, followed by %NULL.
+ * @...: Header name and value pairs, followed by %NULL.
*
* Add the specified header name and value pairs to the call. If a header
* already exists, the new value will replace the old.
@@ -419,7 +419,7 @@ rest_proxy_call_add_param_full (RestProxyCall *call, RestParam *param)
/**
* rest_proxy_call_add_params:
* @call: The #RestProxyCall
- * @Varargs: Parameter name and value pairs, followed by %NULL.
+ * @...: Parameter name and value pairs, followed by %NULL.
*
* Add the specified parameter name and value pairs to the call. If a parameter
* already exists, the new value will replace the old.
diff --git a/rest/rest-proxy.h b/rest/rest-proxy.h
index 9c60189..8c3dd68 100644
--- a/rest/rest-proxy.h
+++ b/rest/rest-proxy.h
@@ -63,6 +63,7 @@ struct _RestProxy {
* @bind_valist: Virtual function called to bind parameters.
* @new_call: Virtual function called to construct a new #RestProxyCall.
* @simple_run_valist: Virtual function called when making a "simple" call.
+ * @authenticate: class handler for the #RestProxy::authenticate signal
*
* Class structure for #RestProxy for subclasses to implement specialised
* behaviour.
@@ -89,6 +90,44 @@ struct _RestProxyClass {
/**
* RestProxyError:
+ * @REST_PROXY_ERROR_CANCELLED: Cancelled
+ * @REST_PROXY_ERROR_RESOLUTION: Resolution
+ * @REST_PROXY_ERROR_CONNECTION: Connection
+ * @REST_PROXY_ERROR_SSL: SSL
+ * @REST_PROXY_ERROR_IO: Input/Output
+ * @REST_PROXY_ERROR_FAILED: Failure
+ * @REST_PROXY_ERROR_HTTP_MULTIPLE_CHOICES: HTTP/Multiple choices
+ * @REST_PROXY_ERROR_HTTP_MOVED_PERMANENTLY: HTTP/Moved permanently
+ * @REST_PROXY_ERROR_HTTP_FOUND: HTTP/Found
+ * @REST_PROXY_ERROR_HTTP_SEE_OTHER: HTTP/See other
+ * @REST_PROXY_ERROR_HTTP_NOT_MODIFIED: HTTP/Not modified
+ * @REST_PROXY_ERROR_HTTP_USE_PROXY: HTTP/Use proxy
+ * @REST_PROXY_ERROR_HTTP_THREEOHSIX: HTTP/306
+ * @REST_PROXY_ERROR_HTTP_TEMPORARY_REDIRECT: HTTP/Temporary redirect
+ * @REST_PROXY_ERROR_HTTP_BAD_REQUEST: HTTP/Bad request
+ * @REST_PROXY_ERROR_HTTP_UNAUTHORIZED: HTTP/Unauthorized
+ * @REST_PROXY_ERROR_HTTP_FOUROHTWO: HTTP/402
+ * @REST_PROXY_ERROR_HTTP_FORBIDDEN: HTTP/Forbidden
+ * @REST_PROXY_ERROR_HTTP_NOT_FOUND: HTTP/Not found
+ * @REST_PROXY_ERROR_HTTP_METHOD_NOT_ALLOWED: HTTP/Method not allowed
+ * @REST_PROXY_ERROR_HTTP_NOT_ACCEPTABLE: HTTP/Not acceptable
+ * @REST_PROXY_ERROR_HTTP_PROXY_AUTHENTICATION_REQUIRED: HTTP/Proxy authentication required
+ * @REST_PROXY_ERROR_HTTP_REQUEST_TIMEOUT: HTTP/Request timeout
+ * @REST_PROXY_ERROR_HTTP_CONFLICT: HTTP/Conflict
+ * @REST_PROXY_ERROR_HTTP_GONE: HTTP/Gone
+ * @REST_PROXY_ERROR_HTTP_LENGTH_REQUIRED: HTTP/Length required
+ * @REST_PROXY_ERROR_HTTP_PRECONDITION_FAILED: HTTP/Precondition failed
+ * @REST_PROXY_ERROR_HTTP_REQUEST_ENTITY_TOO_LARGE: HTTP/Request entity too large
+ * @REST_PROXY_ERROR_HTTP_REQUEST_URI_TOO_LONG: HTTP/Request URI too long
+ * @REST_PROXY_ERROR_HTTP_UNSUPPORTED_MEDIA_TYPE: HTTP/Unsupported media type
+ * @REST_PROXY_ERROR_HTTP_REQUESTED_RANGE_NOT_SATISFIABLE: HTTP/Requested range not satisfiable
+ * @REST_PROXY_ERROR_HTTP_EXPECTATION_FAILED: HTTP/Expectation failed
+ * @REST_PROXY_ERROR_HTTP_INTERNAL_SERVER_ERROR: HTTP/Internal server error
+ * @REST_PROXY_ERROR_HTTP_NOT_IMPLEMENTED: HTTP/Not implemented
+ * @REST_PROXY_ERROR_HTTP_BAD_GATEWAY: HTTP/Bad gateway
+ * @REST_PROXY_ERROR_HTTP_SERVICE_UNAVAILABLE: HTTP/Service unavailable
+ * @REST_PROXY_ERROR_HTTP_GATEWAY_TIMEOUT: HTTP/Gateway timeout
+ * @REST_PROXY_ERROR_HTTP_HTTP_VERSION_NOT_SUPPORTED: HTTP/Version not supported
*
* Error domain used when returning errors from a #RestProxy.
*/