[evolution-data-server] I#65 - [Documentation] Fix several warnings with non-existing links
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] I#65 - [Documentation] Fix several warnings with non-existing links
- Date: Thu, 6 Dec 2018 08:55:13 +0000 (UTC)
commit 22e7599537b8dd6894ad1d5e17440ce2810e36e5
Author: Corentin Noël <corentin elementary io>
Date: Thu Dec 6 09:54:36 2018 +0100
I#65 - [Documentation] Fix several warnings with non-existing links
Closes https://gitlab.gnome.org/GNOME/evolution-data-server/issues/65
src/addressbook/libebook/e-book-client-cursor.c | 10 +++---
src/addressbook/libebook/e-book-utils.c | 2 +-
.../libedata-book/e-book-backend-sqlitedb.c | 6 ++--
.../libedata-book/e-book-backend-sqlitedb.h | 6 ++--
src/addressbook/libedata-book/e-book-backend.c | 2 +-
src/addressbook/libedata-book/e-book-sqlite.c | 6 ++--
src/addressbook/libedata-book/e-book-sqlite.h | 8 ++---
src/addressbook/libedata-book/e-data-book-cursor.c | 6 ++--
src/addressbook/libedata-book/e-data-book-cursor.h | 2 +-
src/calendar/libecal/e-cal-client.c | 8 ++---
src/calendar/libecal/e-reminder-watcher.h | 3 ++
src/calendar/libedata-cal/e-cal-backend.c | 23 +++++--------
src/calendar/libedata-cal/e-cal-cache.h | 2 +-
src/calendar/libedata-cal/e-cal-meta-backend.c | 2 +-
src/calendar/libedata-cal/e-data-cal-view.c | 24 +++++---------
src/camel/camel-sexp.h | 3 +-
src/libebackend/e-collection-backend.c | 2 +-
src/libebackend/e-source-registry-server.c | 4 +--
src/libedataserver/e-data-server-util.c | 10 +++---
src/libedataserver/e-oauth2-service.c | 6 ++--
src/libedataserver/e-sexp.h | 38 ++++++++++++++++++----
src/libedataserver/e-source-proxy.c | 2 +-
src/libedataserver/e-source-registry.c | 2 +-
src/libedataserver/e-source.c | 4 +--
src/libedataserver/e-source.h | 2 +-
src/libedataserver/e-uid.h | 2 ++
26 files changed, 100 insertions(+), 85 deletions(-)
---
diff --git a/src/addressbook/libebook/e-book-client-cursor.c b/src/addressbook/libebook/e-book-client-cursor.c
index 7a37bf57f..c6b30ffe0 100644
--- a/src/addressbook/libebook/e-book-client-cursor.c
+++ b/src/addressbook/libebook/e-book-client-cursor.c
@@ -26,7 +26,7 @@
* a sorted list of contacts in the addressbook.
*
* Aside from the documentation found here, a fully functional example
- * progrem <link linkend="eds-cursor-example">can be found here</link>.
+ * program <link linkend="eds-cursor-example">can be found here</link>.
*
* <refsect2 id="cursor-sort-keys">
* <title>Sort Keys</title>
@@ -880,7 +880,7 @@ e_book_client_cursor_class_init (EBookClientCursorClass *class)
* cursor position, inclusive of the current cursor
* position.
*
- * If the position value is %0, then the cursor is positioned
+ * If the position value is 0, then the cursor is positioned
* before the contact list in the symbolic %E_BOOK_CURSOR_ORIGIN_BEGIN
* position. If the position value is greater than
* #EBookClientCursor:total, this indicates that the cursor is
@@ -2539,15 +2539,15 @@ e_book_client_cursor_step_finish (EBookClientCursor *cursor,
*
* If @cursor reaches the beginning or end of the query results, then the
* returned list might not contain the amount of desired contacts, or might
- * return no results if the cursor currently points to the last contact.
+ * return no results if the cursor currently points to the last contact.
* Reaching the end of the list is not considered an error condition. Attempts
* to step beyond the end of the list after having reached the end of the list
* will however trigger an %E_CLIENT_ERROR_QUERY_REFUSED error.
*
- * If %E_BOOK_CURSOR_STEP_FETCH is specified in %flags, a pointer to
+ * If %E_BOOK_CURSOR_STEP_FETCH is specified in @flags, a pointer to
* a %NULL #GSList pointer should be provided for the @results parameter.
*
- * If %E_BOOK_CURSOR_STEP_MOVE is specified in %flags, then the cursor's
+ * If %E_BOOK_CURSOR_STEP_MOVE is specified in @flags, then the cursor's
* state will be modified and the <link linkend="cursor-pos-total">position</link>
* property will be updated as a result.
*
diff --git a/src/addressbook/libebook/e-book-utils.c b/src/addressbook/libebook/e-book-utils.c
index ac82617ff..ece8dfa7d 100644
--- a/src/addressbook/libebook/e-book-utils.c
+++ b/src/addressbook/libebook/e-book-utils.c
@@ -197,7 +197,7 @@ book_utils_get_recipient_certificates_thread (gpointer data,
* @error: return location for a #GError, or %NULL
*
* Synchronously searches for @recipients S/MIME or PGP certificates either
- * in provided @only_clients #EBookClient-s, or, when %NULL, in each found
+ * in provided @only_clients #EBookClient, or, when %NULL, in each found
* address book configured for auto-completion.
*
* This function can be used within camel_session_get_recipient_certificates_sync()
diff --git a/src/addressbook/libedata-book/e-book-backend-sqlitedb.c
b/src/addressbook/libedata-book/e-book-backend-sqlitedb.c
index d40f39fc4..39ab294a2 100644
--- a/src/addressbook/libedata-book/e-book-backend-sqlitedb.c
+++ b/src/addressbook/libedata-book/e-book-backend-sqlitedb.c
@@ -6158,7 +6158,7 @@ collect_results_for_cursor_cb (gpointer ref,
* @origin: The #EbSdbCursorOrigin from whence to step
* @count: A positive or negative amount of contacts to try and fetch
* @results: (out) (allow-none) (element-type EbSdbSearchData) (transfer full):
- * A return location to store the results, or %NULL if %EBSDB_CURSOR_STEP_FETCH is not specified in %flags.
+ * A return location to store the results, or %NULL if %EBSDB_CURSOR_STEP_FETCH is not specified in @flags.
* @error: (allow-none): A location to store any error that may have occurred.
*
* Steps @cursor through it's sorted query by a maximum of @count contacts
@@ -6168,12 +6168,12 @@ collect_results_for_cursor_cb (gpointer ref,
*
* If @cursor reaches the beginning or end of the query results, then the
* returned list might not contain the amount of desired contacts, or might
- * return no results if the cursor currently points to the last contact.
+ * return no results if the cursor currently points to the last contact.
* Reaching the end of the list is not considered an error condition. Attempts
* to step beyond the end of the list after having reached the end of the list
* will however trigger an %E_BOOK_SDB_ERROR_END_OF_LIST error.
*
- * If %EBSDB_CURSOR_STEP_FETCH is specified in %flags, a pointer to
+ * If %EBSDB_CURSOR_STEP_FETCH is specified in @flags, a pointer to
* a %NULL #GSList pointer should be provided for the @results parameter.
*
* The result list will be stored to @results and should be freed with g_slist_free()
diff --git a/src/addressbook/libedata-book/e-book-backend-sqlitedb.h
b/src/addressbook/libedata-book/e-book-backend-sqlitedb.h
index 4a3e388d0..97cee2698 100644
--- a/src/addressbook/libedata-book/e-book-backend-sqlitedb.h
+++ b/src/addressbook/libedata-book/e-book-backend-sqlitedb.h
@@ -110,7 +110,7 @@ struct _EBookBackendSqliteDB {
/**
* EBookBackendSqliteDBClass:
*
- * Class structure for the #EBookBackendSqlite class.
+ * Class structure for the #EBookBackendSqliteDB class.
*
* Deprecated: 3.12: Use #EBookSqlite instead
*/
@@ -145,7 +145,7 @@ typedef struct {
} EbSdbSearchData;
/**
- * EbSdbCuror:
+ * EbSdbCursor:
*
* An opaque cursor pointer
*
@@ -164,7 +164,7 @@ typedef struct _EbSdbCursor EbSdbCursor;
* Specifies the start position to in the list of traversed contacts
* in calls to e_book_backend_sqlitedb_cursor_step().
*
- * When an #EbSdbCuror is created, the current position implied by %EBSDB_CURSOR_ORIGIN_CURRENT
+ * When an #EbSdbCursor is created, the current position implied by %EBSDB_CURSOR_ORIGIN_CURRENT
* is the same as %EBSDB_CURSOR_ORIGIN_BEGIN.
*
* Since: 3.12
diff --git a/src/addressbook/libedata-book/e-book-backend.c b/src/addressbook/libedata-book/e-book-backend.c
index 7c10bd8c4..2da60b13d 100644
--- a/src/addressbook/libedata-book/e-book-backend.c
+++ b/src/addressbook/libedata-book/e-book-backend.c
@@ -3267,7 +3267,7 @@ e_book_backend_get_backend_property (EBookBackend *backend,
* Checks if @backend's storage has been opened (and
* authenticated, if necessary) and the backend itself
* is ready for accessing. This property is changed automatically
- * within call of e_book_backend_notify_opened().
+ * after the @backend is successfully opened.
*
* Returns: %TRUE if fully opened, %FALSE otherwise.
*
diff --git a/src/addressbook/libedata-book/e-book-sqlite.c b/src/addressbook/libedata-book/e-book-sqlite.c
index 991c5397e..282ed65a2 100644
--- a/src/addressbook/libedata-book/e-book-sqlite.c
+++ b/src/addressbook/libedata-book/e-book-sqlite.c
@@ -8072,7 +8072,7 @@ collect_results_for_cursor_cb (gpointer ref,
* @origin: The #EbSqlCursorOrigin from whence to step
* @count: A positive or negative amount of contacts to try and fetch
* @results: (out) (allow-none) (element-type EbSqlSearchData) (transfer full):
- * A return location to store the results, or %NULL if %EBSQL_CURSOR_STEP_FETCH is not specified in %flags.
+ * A return location to store the results, or %NULL if %EBSQL_CURSOR_STEP_FETCH is not specified in @flags.
* @cancellable: (allow-none): A #GCancellable
* @error: A return location to store any error that might be reported.
*
@@ -8083,12 +8083,12 @@ collect_results_for_cursor_cb (gpointer ref,
*
* If @cursor reaches the beginning or end of the query results, then the
* returned list might not contain the amount of desired contacts, or might
- * return no results if the cursor currently points to the last contact.
+ * return no results if the cursor currently points to the last contact.
* Reaching the end of the list is not considered an error condition. Attempts
* to step beyond the end of the list after having reached the end of the list
* will however trigger an %E_BOOK_SQLITE_ERROR_END_OF_LIST error.
*
- * If %EBSQL_CURSOR_STEP_FETCH is specified in %flags, a pointer to
+ * If %EBSQL_CURSOR_STEP_FETCH is specified in @flags, a pointer to
* a %NULL #GSList pointer should be provided for the @results parameter.
*
* The result list will be stored to @results and should be freed with g_slist_free()
diff --git a/src/addressbook/libedata-book/e-book-sqlite.h b/src/addressbook/libedata-book/e-book-sqlite.h
index d29d50d54..4e8c3a711 100644
--- a/src/addressbook/libedata-book/e-book-sqlite.h
+++ b/src/addressbook/libedata-book/e-book-sqlite.h
@@ -61,7 +61,7 @@
* This key can be used with e_book_sqlite_get_key_value().
*
* In the case of a migration from an older SQLite, any value which
- * was previously stored with e_book_sqlitedb_set_is_populated()
+ * was previously stored with e_book_backend_sqlitedb_set_is_populated()
* can be retrieved with this key.
*
* Since: 3.12
@@ -74,7 +74,7 @@
* This key can be used with e_book_sqlite_get_key_value().
*
* In the case of a migration from an older SQLite, any value which
- * was previously stored with e_book_sqlitedb_set_sync_data()
+ * was previously stored with e_book_backend_sqlitedb_set_sync_data()
* can be retrieved with this key.
*
* Since: 3.12
@@ -273,7 +273,7 @@ struct _EBookSqliteClass {
};
/**
- * EbSqlCuror:
+ * EbSqlCursor:
*
* An opaque cursor pointer
*
@@ -290,7 +290,7 @@ typedef struct _EbSqlCursor EbSqlCursor;
* Specifies the start position to in the list of traversed contacts
* in calls to e_book_sqlite_cursor_step().
*
- * When an #EbSqlCuror is created, the current position implied by %EBSQL_CURSOR_ORIGIN_CURRENT
+ * When an #EbSqlCursor is created, the current position implied by %EBSQL_CURSOR_ORIGIN_CURRENT
* is the same as %EBSQL_CURSOR_ORIGIN_BEGIN.
*
* Since: 3.12
diff --git a/src/addressbook/libedata-book/e-data-book-cursor.c
b/src/addressbook/libedata-book/e-data-book-cursor.c
index 2166400af..132e62dd1 100644
--- a/src/addressbook/libedata-book/e-data-book-cursor.c
+++ b/src/addressbook/libedata-book/e-data-book-cursor.c
@@ -802,7 +802,7 @@ e_data_book_cursor_set_sexp (EDataBookCursor *cursor,
* @origin: The #EBookCursorOrigin from whence to step
* @count: a positive or negative amount of contacts to try and fetch
* @results: (out) (allow-none) (element-type utf8) (transfer full):
- * A return location to store the results, or %NULL if %E_BOOK_CURSOR_STEP_FETCH is not specified in %flags
+ * A return location to store the results, or %NULL if %E_BOOK_CURSOR_STEP_FETCH is not specified in @flags
* @cancellable: (allow-none): A #GCancellable
* @error: (out) (allow-none): return location for a #GError, or %NULL
*
@@ -813,12 +813,12 @@ e_data_book_cursor_set_sexp (EDataBookCursor *cursor,
*
* If @cursor reaches the beginning or end of the query results, then the
* returned list might not contain the amount of desired contacts, or might
- * return no results if the cursor currently points to the last contact.
+ * return no results if the cursor currently points to the last contact.
* Reaching the end of the list is not considered an error condition. Attempts
* to step beyond the end of the list after having reached the end of the list
* will however trigger an %E_CLIENT_ERROR_QUERY_REFUSED error.
*
- * If %E_BOOK_CURSOR_STEP_FETCH is specified in %flags, a pointer to
+ * If %E_BOOK_CURSOR_STEP_FETCH is specified in @flags, a pointer to
* a %NULL #GSList pointer should be provided for the @results parameter.
*
* The result list will be stored to @results and should be freed with g_slist_free()
diff --git a/src/addressbook/libedata-book/e-data-book-cursor.h
b/src/addressbook/libedata-book/e-data-book-cursor.h
index ba624815c..5cc29babe 100644
--- a/src/addressbook/libedata-book/e-data-book-cursor.h
+++ b/src/addressbook/libedata-book/e-data-book-cursor.h
@@ -80,7 +80,7 @@ typedef gboolean (*EDataBookCursorSetSexpFunc) (EDataBookCursor *cursor,
* @origin: The #EBookCursorOrigin from whence to step
* @count: a positive or negative amount of contacts to try and fetch
* @results: (out) (allow-none) (element-type utf8) (transfer full):
- * A return location to store the results, or %NULL if %E_BOOK_CURSOR_STEP_FETCH is not specified in %flags
+ * A return location to store the results, or %NULL if %E_BOOK_CURSOR_STEP_FETCH is not specified in @flags
* @cancellable: (allow-none): A #GCancellable
* @error: (out) (allow-none): return location for a #GError, or %NULL
*
diff --git a/src/calendar/libecal/e-cal-client.c b/src/calendar/libecal/e-cal-client.c
index 47aa8e2dc..f0994f6f6 100644
--- a/src/calendar/libecal/e-cal-client.c
+++ b/src/calendar/libecal/e-cal-client.c
@@ -3006,7 +3006,7 @@ generate_instances_got_objects_cb (struct get_objects_async_data *goad,
* @cb_data; can be %NULL.
*
* Does a combination of e_cal_client_get_object_list() and
- * e_cal_client_recur_generate_instances(). Unlike
+ * e_cal_recur_generate_instances(). Unlike
* e_cal_client_generate_instances_sync(), this returns immediately and the
* @cb callback is called asynchronously.
*
@@ -3062,7 +3062,7 @@ e_cal_client_generate_instances (ECalClient *client,
* @cb_data: (closure): Closure data for the callback
*
* Does a combination of e_cal_client_get_object_list() and
- * e_cal_client_recur_generate_instances().
+ * e_cal_recur_generate_instances().
*
* The callback function should do a g_object_ref() of the calendar component
* it gets passed if it intends to keep it around, since it will be unreffed
@@ -3184,7 +3184,7 @@ generate_instances_for_object_got_objects_cb (struct get_objects_async_data *goa
* free @cb_data; can be %NULL.
*
* Does a combination of e_cal_client_get_object_list() and
- * e_cal_client_recur_generate_instances(), like
+ * e_cal_recur_generate_instances(), like
* e_cal_client_generate_instances(), but for a single object. Unlike
* e_cal_client_generate_instances_for_object_sync(), this returns immediately
* and the @cb callback is called asynchronously.
@@ -3297,7 +3297,7 @@ e_cal_client_generate_instances_for_object (ECalClient *client,
* @cb_data: (closure): Closure data for the callback
*
* Does a combination of e_cal_client_get_object_list() and
- * e_cal_client_recur_generate_instances(), like
+ * e_cal_recur_generate_instances(), like
* e_cal_client_generate_instances_sync(), but for a single object.
*
* The callback function should do a g_object_ref() of the calendar component
diff --git a/src/calendar/libecal/e-reminder-watcher.h b/src/calendar/libecal/e-reminder-watcher.h
index c8c5a321a..285d6cc67 100644
--- a/src/calendar/libecal/e-reminder-watcher.h
+++ b/src/calendar/libecal/e-reminder-watcher.h
@@ -51,6 +51,9 @@ G_BEGIN_DECLS
/**
* EReminderData:
+ * @source_uid: the source UID
+ * @component: the #ECalComponent that triggered the reminder
+ * @instance: the #ECalComponentAlarmInstance describing the reminder alarm
*
* Contains data related to single reminder occurrence.
*
diff --git a/src/calendar/libedata-cal/e-cal-backend.c b/src/calendar/libedata-cal/e-cal-backend.c
index 3f4d40e96..20b47d399 100644
--- a/src/calendar/libedata-cal/e-cal-backend.c
+++ b/src/calendar/libedata-cal/e-cal-backend.c
@@ -1278,7 +1278,7 @@ e_cal_backend_set_writable (ECalBackend *backend,
* Checks if @backend's storage has been opened (and
* authenticated, if necessary) and the backend itself
* is ready for accessing. This property is changed automatically
- * within call of e_cal_backend_notify_opened().
+ * after the @backend is successfully opened.
*
* Returns: %TRUE if fully opened, %FALSE otherwise.
*
@@ -1296,8 +1296,7 @@ e_cal_backend_is_opened (ECalBackend *backend)
* e_cal_backend_is_readonly:
* @backend: an #ECalBackend
*
- * Returns: Whether is backend read-only. This value is the last used
- * in a call of e_cal_backend_notify_readonly().
+ * Returns: Whether is backend read-only.
*
* Since: 3.2
**/
@@ -4367,10 +4366,8 @@ e_cal_backend_stop_view (ECalBackend *backend,
*
* Notifies each of the backend's listeners about a new object.
*
- * Like e_cal_backend_notify_object_created() except takes an #ECalComponent
- * instead of an ical string representation and uses the #EDataCalView's
- * fields-of-interest to filter out unwanted information from ical strings
- * sent over the bus.
+ * Uses the #EDataCalView's fields-of-interest to filter out unwanted
+ * information from ical strings sent over the bus.
*
* Since: 3.4
**/
@@ -4429,10 +4426,8 @@ match_view_and_notify_component (EDataCalView *view,
*
* Notifies each of the backend's listeners about a modified object.
*
- * Like e_cal_backend_notify_object_modified() except takes an #ECalComponent
- * instead of an ical string representation and uses the #EDataCalView's
- * fields-of-interest to filter out unwanted information from ical strings
- * sent over the bus.
+ * Uses the #EDataCalView's fields-of-interest to filter out unwanted
+ * information from ical strings sent over the bus.
*
* Since: 3.4
**/
@@ -4468,10 +4463,8 @@ e_cal_backend_notify_component_modified (ECalBackend *backend,
*
* Notifies each of the backend's listeners about a removed object.
*
- * Like e_cal_backend_notify_object_removed() except takes an #ECalComponent
- * instead of an ical string representation and uses the #EDataCalView's
- * fields-of-interest to filter out unwanted information from ical strings
- * sent over the bus.
+ * Uses the #EDataCalView's fields-of-interest to filter out unwanted
+ * information from ical strings sent over the bus.
*
* Since: 3.4
**/
diff --git a/src/calendar/libedata-cal/e-cal-cache.h b/src/calendar/libedata-cal/e-cal-cache.h
index 66f104532..3cef7517b 100644
--- a/src/calendar/libedata-cal/e-cal-cache.h
+++ b/src/calendar/libedata-cal/e-cal-cache.h
@@ -96,7 +96,7 @@ void e_cal_cache_offline_change_free (/* ECalCacheOfflineChange */ gpointer cha
* such as e_cal_cache_search().
*
* The @extra parameter will contain any data which was
- * previously passed for this component in e_cal_cache_add_component()
+ * previously passed for this component in e_cal_cache_put_component()
* or set with e_cal_cache_set_component_extra().
*
* These should be freed with e_cal_cache_search_data_free().
diff --git a/src/calendar/libedata-cal/e-cal-meta-backend.c b/src/calendar/libedata-cal/e-cal-meta-backend.c
index f0ce94a6f..fbad412d8 100644
--- a/src/calendar/libedata-cal/e-cal-meta-backend.c
+++ b/src/calendar/libedata-cal/e-cal-meta-backend.c
@@ -4844,7 +4844,7 @@ e_cal_meta_backend_get_changes_sync (ECalMetaBackend *meta_backend,
* of loading it with e_cal_meta_backend_load_component_sync().
*
* It is mandatory to implement this virtual method by the descendant, unless
- * it implements its own get_changes_sync().
+ * it implements its own #ECalMetaBackendClass.get_changes_sync().
*
* The @out_existing_objects #GSList should be freed with
* g_slist_free_full (objects, e_cal_meta_backend_info_free);
diff --git a/src/calendar/libedata-cal/e-data-cal-view.c b/src/calendar/libedata-cal/e-data-cal-view.c
index f858349b4..416d74c58 100644
--- a/src/calendar/libedata-cal/e-data-cal-view.c
+++ b/src/calendar/libedata-cal/e-data-cal-view.c
@@ -1173,10 +1173,8 @@ e_data_cal_view_get_component_string (EDataCalView *view,
*
* Notifies all view listeners of the addition of a list of components.
*
- * Like e_data_cal_view_notify_objects_added() except takes a list
- * of #ECalComponent-s instead of ical string representations and uses the
- * #EDataCalView's fields-of-interest to filter out unwanted information
- * from ical strings sent over the bus.
+ * Uses the #EDataCalView's fields-of-interest to filter out unwanted
+ * information from ical strings sent over the bus.
*
* Since: 3.4
*/
@@ -1211,10 +1209,8 @@ e_data_cal_view_notify_components_added (EDataCalView *view,
*
* Notifies all the view listeners of the addition of a single object.
*
- * Like e_data_cal_view_notify_objects_added_1() except takes an #ECalComponent
- * instead of an ical string representation and uses the #EDataCalView's
- * fields-of-interest to filter out unwanted information from ical strings
- * sent over the bus.
+ * Uses the #EDataCalView's fields-of-interest to filter out unwanted
+ * information from ical strings sent over the bus.
*
* Since: 3.4
*/
@@ -1238,10 +1234,8 @@ e_data_cal_view_notify_components_added_1 (EDataCalView *view,
*
* Notifies all view listeners of the modification of a list of components.
*
- * Like e_data_cal_view_notify_objects_modified() except takes a list of
- * #ECalComponent instead of a ical string representations and uses the
- * #EDataCalView's fields-of-interest to filter out unwanted information
- * from ical strings sent over the bus.
+ * Uses the #EDataCalView's fields-of-interest to filter out unwanted
+ * information from ical strings sent over the bus.
*
* Since: 3.4
*/
@@ -1276,10 +1270,8 @@ e_data_cal_view_notify_components_modified (EDataCalView *view,
*
* Notifies all view listeners of the modification of @component.
*
- * Like e_data_cal_view_notify_objects_modified_1() except takes an
- * #ECalComponent instead of an ical string representation and uses the
- * #EDataCalView's fields-of-interest to filter out unwanted information
- * from ical strings sent over the bus.
+ * Uses the #EDataCalView's fields-of-interest to filter out unwanted
+ * information from ical strings sent over the bus.
*
* Since: 3.4
*/
diff --git a/src/camel/camel-sexp.h b/src/camel/camel-sexp.h
index cbb9f02b5..55621b100 100644
--- a/src/camel/camel-sexp.h
+++ b/src/camel/camel-sexp.h
@@ -170,7 +170,8 @@ typedef enum {
* @type: a type of the symbol, either CAMEL_SEXP_TERM_FUNC or CAMEL_SEXP_TERM_VAR
* @name: name of the symbol
* @data: user data for the callback
- * @f: a #CamelSExpFunc or a #CamelSExpIFunc callback
+ * @f.func: a #CamelSExpFunc callback
+ * @f.ifunc: a #CamelSExpIFunc callback
*
* Describes a function or a variable symbol
*
diff --git a/src/libebackend/e-collection-backend.c b/src/libebackend/e-collection-backend.c
index 90aaaeca8..c92925ea5 100644
--- a/src/libebackend/e-collection-backend.c
+++ b/src/libebackend/e-collection-backend.c
@@ -1361,7 +1361,7 @@ e_collection_backend_ref_proxy_resolver (ECollectionBackend *backend)
* Unreference the #ESourceRegistryServer with g_object_unref() when
* finished with it.
*
- * Returns: the #ESourceRegisterServer for @backend
+ * Returns: the #ESourceRegistryServer for @backend
*
* Since: 3.6
**/
diff --git a/src/libebackend/e-source-registry-server.c b/src/libebackend/e-source-registry-server.c
index 0ca3f582d..6eafd1f80 100644
--- a/src/libebackend/e-source-registry-server.c
+++ b/src/libebackend/e-source-registry-server.c
@@ -1475,7 +1475,7 @@ e_source_registry_server_load_all (ESourceRegistryServer *server,
* not be opened. If a key file fails to load, the error is broadcast
* through the #ESourceRegistryServer::load-error signal.
*
- * If the #E_DBUS_LOAD_DIRECTORY_REMOVABLE flag is given, then the @server
+ * If the #E_SOURCE_PERMISSION_REMOVABLE flag is given, then the @server
* will emit signals on the D-Bus interface when key files are created or
* deleted in @path.
*
@@ -1819,7 +1819,7 @@ e_source_registry_server_load_file (ESourceRegistryServer *server,
/**
* e_source_registry_server_load_error:
- * @server: an #EBusSourceServer
+ * @server: an #ESourceRegistryServer
* @file: the #GFile that failed to load
* @error: a #GError describing the load error
*
diff --git a/src/libedataserver/e-data-server-util.c b/src/libedataserver/e-data-server-util.c
index bd209c980..4d85234c6 100644
--- a/src/libedataserver/e-data-server-util.c
+++ b/src/libedataserver/e-data-server-util.c
@@ -2749,7 +2749,7 @@ e_timeout_add_with_name (gint priority,
* or %NULL
*
* Similar to g_timeout_add_seconds_full(), but also names the #GSource as
- * %name.
+ * @name.
*
* You might find e_named_timeout_add_seconds() or
* e_named_timeout_add_seconds_full() more convenient. Those macros name
@@ -2834,9 +2834,9 @@ e_source_registry_debug_print (const gchar *format,
* in a consistent format:
* [domain] YYYY-MM-DD hh:mm:ss.ms - format
*
- * Since: 3.30
- *
* See: e_util_debug_printv()
+ *
+ * Since: 3.30
**/
void
e_util_debug_print (const gchar *domain,
@@ -2863,9 +2863,9 @@ e_util_debug_print (const gchar *domain,
* in a consistent form:
* [@domain] YYYY-MM-DD hh:mm:ss.ms - @format
*
- * Since: 3.30
- *
* See: e_util_debug_print()
+ *
+ * Since: 3.30
**/
void
e_util_debug_printv (const gchar *domain,
diff --git a/src/libedataserver/e-oauth2-service.c b/src/libedataserver/e-oauth2-service.c
index ac2eff406..682673c16 100644
--- a/src/libedataserver/e-oauth2-service.c
+++ b/src/libedataserver/e-oauth2-service.c
@@ -1253,7 +1253,7 @@ eos_lookup_token_sync (EOAuth2Service *service,
* @source: an #ESource
* @authorization_code: authorization code provided by the server
* @ref_source: (scope call): an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
- * @ref_source_user_data user data for @ref_source
+ * @ref_source_user_data: user data for @ref_source
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
*
@@ -1541,7 +1541,7 @@ e_oauth2_service_get_access_token_sync (EOAuth2Service *service,
/**
* e_oauth2_service_util_set_to_form:
- * @form: a #GHashTable
+ * @form: (element-type utf8 utf8): a #GHashTable
* @name: a property name
* @value: (nullable): a property value
*
@@ -1571,7 +1571,7 @@ e_oauth2_service_util_set_to_form (GHashTable *form,
/**
* e_oauth2_service_util_take_to_form:
- * @form: a #GHashTable
+ * @form: (element-type utf8 utf8): a #GHashTable
* @name: a property name
* @value: (transfer full) (nullable): a property value
*
diff --git a/src/libedataserver/e-sexp.h b/src/libedataserver/e-sexp.h
index 90f0a0084..ec5860db8 100644
--- a/src/libedataserver/e-sexp.h
+++ b/src/libedataserver/e-sexp.h
@@ -66,13 +66,37 @@ struct _ESExpResult {
time_t occuring_end;
};
-typedef struct _ESExpResult *(ESExpFunc)(struct _ESExp *sexp, gint argc,
+/**
+ * ESExpFunc:
+ * @sexp: a #ESExp
+ * @argc: count of arguments
+ * @argv: (in) (array length=argc): array of values of the arguments
+ * @user_data: user data as passed to e_sexp_add_function()
+ *
+ * Callback type for function symbols used with e_sexp_add_function().
+ *
+ * Returns: Result of the function call, allocated by e_sexp_result_new().
+ */
+typedef struct _ESExpResult *(ESExpFunc)(struct _ESExp *sexp,
+ gint argc,
struct _ESExpResult **argv,
- gpointer data);
-
-typedef struct _ESExpResult *(ESExpIFunc)(struct _ESExp *sexp, gint argc,
+ gpointer user_data);
+
+/**
+ * ESExpIFunc:
+ * @sexp: a #ESExp
+ * @argc: count of arguments
+ * @argv: (in) (array length=argc): array of values of the arguments
+ * @user_data: user data as passed to e_sexp_add_ifunction()
+ *
+ * Callback type for function symbols used with e_sexp_add_ifunction().
+ *
+ * Returns: Result of the function call, allocated by e_sexp_result_new().
+ */
+typedef struct _ESExpResult *(ESExpIFunc)(struct _ESExp *sexp,
+ gint argc,
struct _ESExpTerm **argv,
- gpointer data);
+ gpointer user_data);
typedef enum {
ESEXP_TERM_INT = 0, /* integer literal */
@@ -126,12 +150,12 @@ void e_sexp_add_function (ESExp *sexp,
gint scope,
const gchar *name,
ESExpFunc *func,
- gpointer data);
+ gpointer user_data);
void e_sexp_add_ifunction (ESExp *sexp,
gint scope,
const gchar *name,
ESExpIFunc *func,
- gpointer data);
+ gpointer user_data);
void e_sexp_add_variable (ESExp *sexp,
gint scope,
gchar *name,
diff --git a/src/libedataserver/e-source-proxy.c b/src/libedataserver/e-source-proxy.c
index 93cdfb255..cd6194943 100644
--- a/src/libedataserver/e-source-proxy.c
+++ b/src/libedataserver/e-source-proxy.c
@@ -1495,7 +1495,7 @@ e_source_proxy_get_socks_host (ESourceProxy *extension)
* e_source_proxy_dup_socks_host:
* @extension: an #ESourceProxy
*
- * Thread-safe variation of e_source-proxy_get_socks_host().
+ * Thread-safe variation of e_source_proxy_get_socks_host().
* Use this function when accessing @extension from multiple threads.
*
* The returned string should be freed with g_free() when no longer needed.
diff --git a/src/libedataserver/e-source-registry.c b/src/libedataserver/e-source-registry.c
index 979e70974..a5a30a3e1 100644
--- a/src/libedataserver/e-source-registry.c
+++ b/src/libedataserver/e-source-registry.c
@@ -1686,7 +1686,7 @@ e_source_registry_class_init (ESourceRegistryClass *class)
* The ::credentials-required signal is emitted when the @source
* requires credentials to connect to (possibly remote)
* data store. The credentials can be passed to the source using
- * e_source_authenticate() function. The signal is emitted in
+ * e_source_invoke_authenticate() function. The signal is emitted in
* the thread-default main context from the time the @registry was created.
*
* Note: This is just a proxy signal for the ESource::credentials-required signal.
diff --git a/src/libedataserver/e-source.c b/src/libedataserver/e-source.c
index c12f714d9..6c3aaae14 100644
--- a/src/libedataserver/e-source.c
+++ b/src/libedataserver/e-source.c
@@ -2315,7 +2315,7 @@ e_source_class_init (ESourceClass *class)
* The ::credentials-required signal is emitted when the @source
* requires credentials to connect to (possibly remote)
* data store. The credentials can be passed to the backend using
- * e_source_authenticate() function.
+ * e_source_invoke_authenticate() function.
**/
signals[CREDENTIALS_REQUIRED] = g_signal_new (
"credentials-required",
@@ -4456,7 +4456,7 @@ e_source_delete_password_finish (ESource *source,
* @error: (allow-none): return location for a #GError, or %NULL
*
* Let's the client-side know that credentials are required. The @reason defines which
- * parameters are used. The client passed the credentials with an e_source_authenticate()
+ * parameters are used. The client passed the credentials with an e_source_invoke_authenticate()
* call.
*
* The %E_SOURCE_CREDENTIALS_REASON_REQUIRED is used for the first credentials prompt,
diff --git a/src/libedataserver/e-source.h b/src/libedataserver/e-source.h
index bfaeff128..867524b90 100644
--- a/src/libedataserver/e-source.h
+++ b/src/libedataserver/e-source.h
@@ -91,7 +91,7 @@
* to have up-to-date data on the server side, when the client side
* just saved the SSL trust change, which might not be propagated
* into the server (factory) side quickly enough. The key is added into
- * the credentials in invoke_authenticate() automatically, if the
+ * the credentials in e_source_invoke_authenticate() automatically, if the
* corresponding ESource contain a WebDAV extension and the key
* is not part of the credentials already.
*
diff --git a/src/libedataserver/e-uid.h b/src/libedataserver/e-uid.h
index 469b25478..9585f1863 100644
--- a/src/libedataserver/e-uid.h
+++ b/src/libedataserver/e-uid.h
@@ -29,7 +29,9 @@
G_BEGIN_DECLS
+#ifndef EDS_DISABLE_DEPRECATED
gchar * e_uid_new (void);
+#endif /* EDS_DISABLE_DEPRECATED */
G_END_DECLS
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
