[evolution-data-server] M!6 - [Documentation] Fix references to unexisting functions or classes



commit 8cc5603f9bf7eeaec0b36b08a33c7c6a9a5dfc5d
Author: Corentin Noël <corentin elementary io>
Date:   Wed Dec 5 12:06:56 2018 +0100

    M!6 - [Documentation] Fix references to unexisting functions or classes
    
    Closes https://gitlab.gnome.org/GNOME/evolution-data-server/merge_requests/6

 src/libebackend/e-collection-backend.c     | 4 +---
 src/libebackend/e-oauth2-support.c         | 2 +-
 src/libebackend/e-server-side-source.c     | 5 ++---
 src/libebackend/e-source-registry-server.c | 6 +++---
 src/libedataserver/e-oauth2-service.h      | 5 +++--
 src/libedataserver/e-source-selectable.c   | 2 +-
 6 files changed, 11 insertions(+), 13 deletions(-)
---
diff --git a/src/libebackend/e-collection-backend.c b/src/libebackend/e-collection-backend.c
index 335fc773e..90aaaeca8 100644
--- a/src/libebackend/e-collection-backend.c
+++ b/src/libebackend/e-collection-backend.c
@@ -32,9 +32,7 @@
  * server or else poll the remote server at regular intervals and then
  * update the data source collection accordingly.
  *
- * As most remote servers require authentication, the backend may also
- * wish to implement the #ESourceAuthenticator interface so it can submit
- * its own #EAuthenticationSession instances to the #ESourceRegistryServer.
+ * The client is responsible to provide credentials to use to authenticate.
  **/
 
 #include "evolution-data-server-config.h"
diff --git a/src/libebackend/e-oauth2-support.c b/src/libebackend/e-oauth2-support.c
index 98ed21a3b..147f989ce 100644
--- a/src/libebackend/e-oauth2-support.c
+++ b/src/libebackend/e-oauth2-support.c
@@ -152,7 +152,7 @@ e_oauth2_support_default_init (EOAuth2SupportInterface *iface)
 
 /**
  * e_oauth2_support_get_access_token_sync:
- * @support: an #EOAuthSupport
+ * @support: an #EOAuth2Support
  * @source: an #ESource
  * @cancellable: optional #GCancellable object, or %NULL
  * @out_access_token: return location for the access token, or %NULL
diff --git a/src/libebackend/e-server-side-source.c b/src/libebackend/e-server-side-source.c
index d82ec03d9..376202e84 100644
--- a/src/libebackend/e-server-side-source.c
+++ b/src/libebackend/e-server-side-source.c
@@ -2123,9 +2123,8 @@ e_server_side_source_get_server (EServerSideSource *source)
  * Returns whether @source has been exported over D-Bus.
  *
  * The function returns %FALSE after @source is initially created, %TRUE
- * after passing @source to e_source_registry_add_source() (provided that
- * @source's #ESource:parent is also exported), and %FALSE after passing
- * @source to e_source_registry_remove_source().
+ * after passing @source uid to e_source_registry_server_ref_source() (provided
+ * that @source's #ESource:parent is also exported).
  *
  * Returns: whether @source has been exported
  *
diff --git a/src/libebackend/e-source-registry-server.c b/src/libebackend/e-source-registry-server.c
index 70ab710c8..0ca3f582d 100644
--- a/src/libebackend/e-source-registry-server.c
+++ b/src/libebackend/e-source-registry-server.c
@@ -1212,10 +1212,10 @@ e_source_registry_server_new (void)
  * e_source_registry_server_ref_credentials_provider:
  * @server: an #ESourceRegistryServer
  *
- * Returns a referenced #ESourceRegistryCredentialsProvider.
+ * Returns a referenced #ESourceCredentialsProvider. Unref it with
+ * g_object_unref(), when no longer needed.
  *
- * Returns: A referenced #ESourceRegistryCredentialsProvider. Unref it with
- *    g_object_unref(), when no longer needed.
+ * Returns: (transfer full): A referenced #ESourceCredentialsProvider.
  *
  * Since: 3.16
  **/
diff --git a/src/libedataserver/e-oauth2-service.h b/src/libedataserver/e-oauth2-service.h
index 971327529..e97778e68 100644
--- a/src/libedataserver/e-oauth2-service.h
+++ b/src/libedataserver/e-oauth2-service.h
@@ -82,8 +82,9 @@ typedef enum {
 
 /**
  * EOAuth2ServiceRefSourceFunc:
- * @user_data: user data, as passed to e_oauth2_service_get_token_sync()
- *    or e_oauth2_service_refresh_token_sync()
+ * @user_data: user data, as passed to e_oauth2_service_get_access_token_sync()
+ *    or e_oauth2_service_receive_and_store_token_sync(),
+ *    or e_oauth2_service_refresh_and_store_token_sync()
  * @uid: an #ESource UID to return
  *
  * Returns: (transfer full) (nullable): an #ESource with UID @uid, or %NULL, if not found.
diff --git a/src/libedataserver/e-source-selectable.c b/src/libedataserver/e-source-selectable.c
index 9acf5dc83..c7b86988c 100644
--- a/src/libedataserver/e-source-selectable.c
+++ b/src/libedataserver/e-source-selectable.c
@@ -22,7 +22,7 @@
  * @see_also: #ESourceCalendar, #ESourceMemoList, #ESourceTaskList
  *
  * #ESourceSelectable is an abstract base class for data sources
- * that can be selected in an #ESourceSelector or similar widget.
+ * that can be selected.
  **/
 
 #include "e-source-selectable.h"


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