[evolution-data-server] Correct developer documentation in e-oauth2-service/s



commit a3b030d143b154eddab8f59083811010b043333b
Author: Milan Crha <mcrha redhat com>
Date:   Wed Jan 24 09:28:49 2018 +0100

    Correct developer documentation in e-oauth2-service/s

 src/libedataserver/e-oauth2-service.c  |   13 +++++++------
 src/libedataserver/e-oauth2-services.c |    2 +-
 2 files changed, 8 insertions(+), 7 deletions(-)
---
diff --git a/src/libedataserver/e-oauth2-service.c b/src/libedataserver/e-oauth2-service.c
index 25ed1fe..b3f6219 100644
--- a/src/libedataserver/e-oauth2-service.c
+++ b/src/libedataserver/e-oauth2-service.c
@@ -1211,8 +1211,8 @@ eos_lookup_token_sync (EOAuth2Service *service,
  * @service: an #EOAuth2Service
  * @source: an #ESource
  * @authorization_code: authorization code provided by the server
- * @ref_source: an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
- * @ref_source_user_data: user data for @ref_source
+ * @ref_source: (scope call): an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
+ * @ref_source_user_data user data for @ref_source
  * @cancellable: optional #GCancellable object, or %NULL
  * @error: return location for a #GError, or %NULL
  *
@@ -1299,14 +1299,15 @@ e_oauth2_service_receive_and_store_token_sync (EOAuth2Service *service,
  * e_oauth2_service_refresh_and_store_token_sync:
  * @service: an #EOAuth2Service
  * @source: an #ESource
- * @authorization_code: authorization code provided by the server
- * @ref_source: an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
+ * @refresh_token: refresh token as provided by the server
+ * @ref_source: (scope call): an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
  * @ref_source_user_data: user data for @ref_source
  * @cancellable: optional #GCancellable object, or %NULL
  * @error: return location for a #GError, or %NULL
  *
  * Queries @service at e_oauth2_service_get_refresh_uri() with a request to refresh
- * existing @refresh_token and stores it into the secret store on success.
+ * existing access token with provided @refresh_token and stores it into the secret
+ * store on success.
  *
  * Returns: whether succeeded
  *
@@ -1435,7 +1436,7 @@ e_oauth2_service_delete_token_sync (EOAuth2Service *service,
  * e_oauth2_service_get_access_token_sync:
  * @service: an #EOAuth2Service
  * @source: an #ESource
- * @ref_source: an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
+ * @ref_source: (scope call): an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
  * @ref_source_user_data: user data for @ref_source
  * @out_access_token: (out) (transfer full): return location for the access token
  * @out_expires_in: (out): how many seconds the access token expires in
diff --git a/src/libedataserver/e-oauth2-services.c b/src/libedataserver/e-oauth2-services.c
index 678a3ba..e82bebc 100644
--- a/src/libedataserver/e-oauth2-services.c
+++ b/src/libedataserver/e-oauth2-services.c
@@ -316,7 +316,7 @@ e_oauth2_services_find (EOAuth2Services *services,
 }
 
 /**
- * e_oauth2_services_find:
+ * e_oauth2_services_guess:
  * @services: an #EOAuth2Services
  * @protocol: (nullable): a protocol to search the service for, like "imap", or %NULL
  * @hostname: (nullable): a host name to search the service for, like "server.example.com", or %NULL


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]