[tracker/wip/carlosg/hotdoc: 41/53] libtracker-sparql: Add missing doc pieces




commit dd69257fcaeb6213a9d36d2ea0b2222f2263a447
Author: Carlos Garnacho <carlosg gnome org>
Date:   Tue Aug 3 15:15:54 2021 +0200

    libtracker-sparql: Add missing doc pieces
    
    Necessary to put things together nicely in hotdoc.

 src/libtracker-sparql/tracker-endpoint-dbus.c | 17 +++++++++++++++++
 src/libtracker-sparql/tracker-endpoint-http.c | 17 +++++++++++++++++
 src/libtracker-sparql/tracker-error.c         |  5 +++++
 src/libtracker-sparql/tracker-notifier.c      |  2 ++
 src/libtracker-sparql/tracker-ontologies.h    | 11 +++++++++++
 src/libtracker-sparql/tracker-uri.c           | 10 ++++++++++
 6 files changed, 62 insertions(+)
---
diff --git a/src/libtracker-sparql/tracker-endpoint-dbus.c b/src/libtracker-sparql/tracker-endpoint-dbus.c
index ea62aa56d..602614f58 100644
--- a/src/libtracker-sparql/tracker-endpoint-dbus.c
+++ b/src/libtracker-sparql/tracker-endpoint-dbus.c
@@ -19,6 +19,23 @@
  * Author: Carlos Garnacho <carlosg gnome org>
  */
 
+/**
+ * SECTION: tracker-endpoint-dbus
+ * @short_description: DBus endpoint
+ * @title: TrackerEndpointDBus
+ * @stability: Stable
+ * @include: libtracker-sparql/tracker-sparql.h
+ *
+ * #TrackerEndpointDBus is an endpoint implementation that exports
+ * a local #TrackerSparqlConnection so it is accessible in the given
+ * bus connection.
+ *
+ * Access to these endpoints may be transparently managed through
+ * the Tracker portal service for applications sandboxed via Flatpak, and
+ * access to data constrained to the graphs defined in the applications
+ * manifest.
+ */
+
 #include "config.h"
 
 #include "tracker-endpoint-dbus.h"
diff --git a/src/libtracker-sparql/tracker-endpoint-http.c b/src/libtracker-sparql/tracker-endpoint-http.c
index 3fa99ab01..e4b6a9ec9 100644
--- a/src/libtracker-sparql/tracker-endpoint-http.c
+++ b/src/libtracker-sparql/tracker-endpoint-http.c
@@ -19,6 +19,23 @@
  * Author: Carlos Garnacho <carlosg gnome org>
  */
 
+/**
+ * SECTION: tracker-endpoint-http
+ * @short_description: HTTP endpoint
+ * @title: TrackerEndpointHttp
+ * @stability: Stable
+ * @include: libtracker-sparql/tracker-sparql.h
+ *
+ * #TrackerEndpointHttp is an endpoint implementation that exports
+ * a local #TrackerSparqlConnection so it is accessible via HTTP
+ * requests.
+ *
+ * Access to these endpoints may be managed via the
+ * #TrackerEndpointHttp::block-remote-address signal, the boolean
+ * return value expressing whether the connection is blocked or not.
+ * Inspection of the requester address is left up to the user.
+ */
+
 #include "config.h"
 
 #include "tracker-endpoint-http.h"
diff --git a/src/libtracker-sparql/tracker-error.c b/src/libtracker-sparql/tracker-error.c
index 78e08bd90..730655968 100644
--- a/src/libtracker-sparql/tracker-error.c
+++ b/src/libtracker-sparql/tracker-error.c
@@ -39,6 +39,11 @@ static const GDBusErrorEntry tracker_sparql_error_entries[] =
 
 G_STATIC_ASSERT (G_N_ELEMENTS (tracker_sparql_error_entries) == TRACKER_SPARQL_N_ERRORS);
 
+/**
+ * tracker_sparql_error_quark:
+ *
+ * Returns: The error domain quark used for Tracker errors.
+ **/
 GQuark
 tracker_sparql_error_quark (void)
 {
diff --git a/src/libtracker-sparql/tracker-notifier.c b/src/libtracker-sparql/tracker-notifier.c
index a6bf2315c..a1b2e6f04 100644
--- a/src/libtracker-sparql/tracker-notifier.c
+++ b/src/libtracker-sparql/tracker-notifier.c
@@ -19,7 +19,9 @@
 
 /**
  * SECTION: tracker-notifier
+ * @title: TrackerNotifier
  * @short_description: Listen to changes in the Tracker database
+ * @stability: Stable
  * @include: libtracker-sparql/tracker-sparql.h
  *
  * #TrackerNotifier is an object that receives notifications about
diff --git a/src/libtracker-sparql/tracker-ontologies.h b/src/libtracker-sparql/tracker-ontologies.h
index bb678b67f..8713b4fb6 100644
--- a/src/libtracker-sparql/tracker-ontologies.h
+++ b/src/libtracker-sparql/tracker-ontologies.h
@@ -18,6 +18,17 @@
  * Boston, MA  02110-1301, USA.
  */
 
+/**
+ * SECTION: tracker-ontologies
+ * @short_description: Utility prefix definitions for common ontologies
+ * @title: Utility Ontology Defines
+ * @stability: Stable
+ * @include: libtracker-sparql/tracker-sparql.h
+ *
+ * Utility defines for the common namespace prefixes.
+ */
+
+
 #ifndef __LIBTRACKER_SPARQL_ONTOLOGIES_H__
 #define __LIBTRACKER_SPARQL_ONTOLOGIES_H__
 
diff --git a/src/libtracker-sparql/tracker-uri.c b/src/libtracker-sparql/tracker-uri.c
index dee41e51a..9238c50cb 100644
--- a/src/libtracker-sparql/tracker-uri.c
+++ b/src/libtracker-sparql/tracker-uri.c
@@ -19,6 +19,16 @@
  * Boston, MA  02110-1301, USA.
  */
 
+/**
+ * SECTION: tracker-uri
+ * @short_description: URI utility functions
+ * @title: URI Utilities
+ * @stability: Stable
+ * @include: libtracker-sparql/tracker-sparql.h
+ *
+ * Tracker defines some utility functions to deal with URI strings.
+ */
+
 #include "config.h"
 
 #include <string.h>


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