summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDebarshi Ray <debarshir@gnome.org>2021-04-01 03:10:18 +0200
committerDebarshi Ray <debarshir@gnome.org>2021-04-01 03:13:18 +0200
commit774f9ac1ffb6f402db906e03047b8d0fa59a05c0 (patch)
tree73cfe31615c579820e0d8d1509fe136584ab889c
parent8f6419245789d7410398b9e421f387f098e6761c (diff)
downloadtracker-wip/rishi/tracker_sparql_connection_update_array-documentation-fix.tar.gz
libtracker-sparql: Fix the tracker_sparql_connection_update_array docswip/rishi/tracker_sparql_connection_update_array-documentation-fix
Fallout from f06d078094355af47b58bcbfa13161d76b638d10 https://gitlab.gnome.org/GNOME/tracker/-/merge_requests/391
-rw-r--r--src/libtracker-sparql/tracker-connection.c38
1 files changed, 3 insertions, 35 deletions
diff --git a/src/libtracker-sparql/tracker-connection.c b/src/libtracker-sparql/tracker-connection.c
index a1fbc18cf..2cacd7735 100644
--- a/src/libtracker-sparql/tracker-connection.c
+++ b/src/libtracker-sparql/tracker-connection.c
@@ -417,9 +417,8 @@ tracker_sparql_connection_update_finish (TrackerSparqlConnection *connection,
* asynchronous operation is finished.
* @user_data: user-defined data to be passed to @callback
*
- * Executes asynchronously an array of SPARQL updates. Each update in the
- * array is its own transaction. This means that update n+1 is not halted
- * due to an error in update n.
+ * Executes asynchronously an array of SPARQL updates. All updates in the
+ * array are handled within a single transaction.
*/
void
tracker_sparql_connection_update_array_async (TrackerSparqlConnection *connection,
@@ -449,38 +448,7 @@ tracker_sparql_connection_update_array_async (TrackerSparqlConnection *connecti
*
* Finishes the asynchronous SPARQL update_array operation.
*
- * <example>
- * <programlisting>
- * static void
- * async_update_array_callback (GObject *source_object,
- * GAsyncResult *result,
- * gpointer user_data)
- * {
- * GError *error = NULL;
- * GPtrArray *errors;
- * guint i;
- *
- * errors = tracker_sparql_connection_update_array_finish (connection, result, &error);
- * g_assert_no_error (error);
- *
- * for (i = 0; i < errors->len; i++) {
- * const GError *e = g_ptr_array_index (errors, i);
- *
- * ...
- * }
- *
- * g_ptr_array_unref (errors);
- * }
- * </programlisting>
- * </example>
- *
- * Returns: a #GPtrArray of size @sparql_length with elements that are
- * either NULL or a GError instance. The returned array should be freed with
- * g_ptr_array_unref when no longer used, not with g_ptr_array_free. When
- * you use errors of the array, you must g_error_copy them. Errors inside of
- * the array must be considered as const data and not freed. The index of
- * the error corresponds to the index of the update query in the array that
- * you passed to tracker_sparql_connection_update_array_async.
+ * Returns: #TRUE if there were no errors.
*/
gboolean
tracker_sparql_connection_update_array_finish (TrackerSparqlConnection *connection,