From dfcb399f0593f8696ff0ecae82967d99be72419c Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@gnome.org>
Date: Wed, 20 Nov 2013 14:58:39 +0000
Subject: docs: Add annotations to RestProxyAuth pausing methods

Both pause() and unpause() are referenced elsewhere in the API
reference, but have no formal documentation annotations.

https://bugzilla.gnome.org/show_bug.cgi?id=712747
---
 rest/rest-proxy-auth.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/rest/rest-proxy-auth.c b/rest/rest-proxy-auth.c
index 86cd197..0cb6d7c 100644
--- a/rest/rest-proxy-auth.c
+++ b/rest/rest-proxy-auth.c
@@ -89,6 +89,15 @@ rest_proxy_auth_new (RestProxy *proxy,
   return rest_auth;
 }
 
+/**
+ * rest_proxy_auth_pause:
+ * @auth: a #RestProxyAuth
+ *
+ * Pauses @auth.
+ *
+ * If @auth is already paused, this function does not
+ * do anything.
+ */
 void
 rest_proxy_auth_pause (RestProxyAuth *auth)
 {
@@ -101,6 +110,12 @@ rest_proxy_auth_pause (RestProxyAuth *auth)
   soup_session_pause_message (auth->priv->session, auth->priv->message);
 }
 
+/**
+ * rest_proxy_auth_unpause:
+ * @auth: a paused #RestProxyAuth
+ *
+ * Unpauses a paused #RestProxyAuth instance.
+ */
 void
 rest_proxy_auth_unpause (RestProxyAuth *auth)
 {
-- 
cgit v1.2.1