[tracker/wip/carlosg/tracker-3.0-api-breaks: 59/63] libtracker-sparql: Add some missing docs and introspection annotations



commit 7a0fd9b2b0373db1acc4e0a1366fe06deda3f129
Author: Carlos Garnacho <carlosg gnome org>
Date:   Tue Jan 14 14:13:14 2020 +0100

    libtracker-sparql: Add some missing docs and introspection annotations

 src/libtracker-sparql/tracker-connection.c | 12 ++++++++++++
 src/libtracker-sparql/tracker-endpoint.c   |  8 ++++++++
 src/libtracker-sparql/tracker-statement.c  | 16 ++++++++++++++++
 3 files changed, 36 insertions(+)
---
diff --git a/src/libtracker-sparql/tracker-connection.c b/src/libtracker-sparql/tracker-connection.c
index 4fe64fabe..50783c6e4 100644
--- a/src/libtracker-sparql/tracker-connection.c
+++ b/src/libtracker-sparql/tracker-connection.c
@@ -448,6 +448,18 @@ tracker_sparql_connection_query_statement (TrackerSparqlConnection  *connection,
                                                                                  error);
 }
 
+/**
+ * tracker_sparql_connection_create_notifier:
+ * @connection: a #TrackerSparqlConnection
+ * @flags: flags to modify notifier behavior
+ *
+ * Creates a new #TrackerNotifier to notify about changes in @connection.
+ * See #TrackerNotifier documentation for information about how to use this
+ * object.
+ *
+ * Returns: (transfer full): a newly created notifier. Free with g_object_unref()
+ *          when no longer needed.
+ **/
 TrackerNotifier *
 tracker_sparql_connection_create_notifier (TrackerSparqlConnection *connection,
                                            TrackerNotifierFlags     flags)
diff --git a/src/libtracker-sparql/tracker-endpoint.c b/src/libtracker-sparql/tracker-endpoint.c
index 0ae8cf9d7..4539eae63 100644
--- a/src/libtracker-sparql/tracker-endpoint.c
+++ b/src/libtracker-sparql/tracker-endpoint.c
@@ -110,6 +110,14 @@ tracker_endpoint_init (TrackerEndpoint *endpoint)
 {
 }
 
+/**
+ * tracker_endpoint_get_sparql_connection:
+ * @endpoint: a #TrackerEndpoint
+ *
+ * Returns the #TrackerSparqlConnection that this endpoint proxies.
+ *
+ * Returns: (transfer none): The proxied SPARQL connection
+ **/
 TrackerSparqlConnection *
 tracker_endpoint_get_sparql_connection (TrackerEndpoint *endpoint)
 {
diff --git a/src/libtracker-sparql/tracker-statement.c b/src/libtracker-sparql/tracker-statement.c
index c7de16535..c01550ce2 100644
--- a/src/libtracker-sparql/tracker-statement.c
+++ b/src/libtracker-sparql/tracker-statement.c
@@ -158,6 +158,14 @@ tracker_sparql_statement_class_init (TrackerSparqlStatementClass *klass)
        g_object_class_install_properties (object_class, N_PROPS, props);
 }
 
+/**
+ * tracker_sparql_statement_get_connection:
+ * @stmt: a #TrackerSparqlStatement
+ *
+ * Returns the #TrackerSparqlConnection that this statement was created from.
+ *
+ * Returns: (transfer none): The SPARQL connection of this statement.
+ **/
 TrackerSparqlConnection *
 tracker_sparql_statement_get_connection (TrackerSparqlStatement *stmt)
 {
@@ -168,6 +176,14 @@ tracker_sparql_statement_get_connection (TrackerSparqlStatement *stmt)
        return priv->connection;
 }
 
+/**
+ * tracker_sparql_statement_get_sparql:
+ * @stmt: a #TrackerSparqlStatement
+ *
+ * Returns the SPARQL string that this prepared statement holds.
+ *
+ * Returns: The contained SPARQL query
+ **/
 const gchar *
 tracker_sparql_statement_get_sparql (TrackerSparqlStatement *stmt)
 {


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