[tracker/wip/carlosg/hotdoc: 30/40] src: Remove needless <para> in API doc blurbs




commit aff51b6ac584df09f6937de8ae310c5a738b7335
Author: Carlos Garnacho <carlosg gnome org>
Date:   Tue Aug 3 13:48:31 2021 +0200

    src: Remove needless <para> in API doc blurbs
    
    Not even gtk-doc needs these nowadays, plus they'll mess up with
    anything we'll port to.

 src/libtracker-sparql/tracker-connection.c        | 12 ------------
 src/libtracker-sparql/tracker-cursor.c            |  2 --
 src/libtracker-sparql/tracker-endpoint.c          |  5 +----
 src/libtracker-sparql/tracker-namespace-manager.c |  4 +---
 src/libtracker-sparql/tracker-resource.c          |  2 --
 5 files changed, 2 insertions(+), 23 deletions(-)
---
diff --git a/src/libtracker-sparql/tracker-connection.c b/src/libtracker-sparql/tracker-connection.c
index fcb2d2ecd..9584a057b 100644
--- a/src/libtracker-sparql/tracker-connection.c
+++ b/src/libtracker-sparql/tracker-connection.c
@@ -24,45 +24,33 @@
  * @stability: Stable
  * @include: tracker-sparql.h
  *
- * <para>
  * #TrackerSparqlConnection is an object that represents a connection to a
  * SPARQL triple store. This store may be local and private (see
  * tracker_sparql_connection_new()), or it may be a remote connection to a
  * public endpoint (See tracker_sparql_connection_bus_new() and
  * tracker_sparql_connection_remote_new()).
- * </para>
  *
- * <para>
  * A #TrackerSparqlConnection is private to the calling process, it can be
  * exposed publicly via a #TrackerEndpoint, see tracker_endpoint_dbus_new().
- * </para>
  *
- * <para>
  * Updates on a connection are performed via the tracker_sparql_connection_update()
  * family of calls. tracker_sparql_connection_update_array() may be used for batched
  * updates. All functions have asynchronous variants.
- * </para>
  *
- * <para>
  * Queries on a connection are performed via tracker_sparql_connection_query()
  * and tracker_sparql_connection_query_statement(). The first call receives a
  * query string and returns a #TrackerSparqlCursor to iterate the results. The
  * second call returns a #TrackerSparqlStatement object that may be reused for
  * repeatable queries with variable parameters. tracker_sparql_statement_execute()
  * will returns a #TrackerSparqlCursor.
- * </para>
  *
- * <para>
  * Depending on the ontology definition, #TrackerSparqlConnection may emit
  * notifications whenever changes happen in the stored data. These notifications
  * can be processed via a #TrackerNotifier obtained with
  * tracker_sparql_connection_create_notifier().
- * </para>
  *
- * <para>
  * After use, a #TrackerSparqlConnection should be closed. See
  * tracker_sparql_connection_close() and tracker_sparql_connection_close_async().
- * </para>
  */
 #include "config.h"
 
diff --git a/src/libtracker-sparql/tracker-cursor.c b/src/libtracker-sparql/tracker-cursor.c
index 3e32b3320..3b7d9da09 100644
--- a/src/libtracker-sparql/tracker-cursor.c
+++ b/src/libtracker-sparql/tracker-cursor.c
@@ -23,10 +23,8 @@
  * @stability: Stable
  * @include: tracker-sparql.h
  *
- * <para>
  * #TrackerSparqlCursor is an object which provides methods to iterate the
  * results of a query to the Tracker Store.
- * </para>
  */
 #include "config.h"
 
diff --git a/src/libtracker-sparql/tracker-endpoint.c b/src/libtracker-sparql/tracker-endpoint.c
index 6392dbb37..f404e3f0c 100644
--- a/src/libtracker-sparql/tracker-endpoint.c
+++ b/src/libtracker-sparql/tracker-endpoint.c
@@ -45,17 +45,14 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (TrackerEndpoint, tracker_endpoint, G_TYPE_O
  * @stability: Stable
  * @include: tracker-endpoint.h
  *
- * <para>
  * #TrackerEndpoint allows sharing data, either with other processes on the
  * system via a Tracker-specific D-Bus API, or remote peers via the HTTP
  * SPARQL protocol.
- * </para>
- * <para>
+ *
  * When it is shared in this way, other peers can connect to your database using
  * tracker_sparql_connection_bus_new() or tracker_sparql_connection_remote_new(),
  * and can also fetch data directly from SPARQL queries using the
  * <userinput>SELECT { SERVICE ... }</userinput> syntax.
- * </para>
  */
 
 static void
diff --git a/src/libtracker-sparql/tracker-namespace-manager.c 
b/src/libtracker-sparql/tracker-namespace-manager.c
index 0d639b55f..832be6e27 100644
--- a/src/libtracker-sparql/tracker-namespace-manager.c
+++ b/src/libtracker-sparql/tracker-namespace-manager.c
@@ -46,9 +46,8 @@ G_DEFINE_TYPE_WITH_PRIVATE (TrackerNamespaceManager, tracker_namespace_manager,
  * @short_description: A set of well-known namespaces, and known abbreviations for them
  * @title: TrackerNamespaceManager
  * @stability: Stable
- * @include: tracker-namespace-manager.h
+ * @include: libtracker-sparql/tracker-sparql.h
  *
- * <para>
  * #TrackerNamespaceManager keeps track of namespaces. It allows you to assign
  * short prefixes for them to avoid typing full URLs all the time.
  *
@@ -58,7 +57,6 @@ G_DEFINE_TYPE_WITH_PRIVATE (TrackerNamespaceManager, tracker_namespace_manager,
  * Usually you will want to use the default namespace manager, as returned by
  * tracker_namespace_manager_get_default(). This has a set of well-known
  * prefixes predefined.
- * </para>
  */
 
 static void finalize     (GObject *object);
diff --git a/src/libtracker-sparql/tracker-resource.c b/src/libtracker-sparql/tracker-resource.c
index 01c5e38e9..d4d3b6b5c 100644
--- a/src/libtracker-sparql/tracker-resource.c
+++ b/src/libtracker-sparql/tracker-resource.c
@@ -52,10 +52,8 @@ G_DEFINE_TYPE_WITH_PRIVATE (TrackerResource, tracker_resource, G_TYPE_OBJECT)
  * @stability: Stable
  * @include: tracker-resource.h
  *
- * <para>
  * #TrackerResource keeps track of a set of properties for a given resource.
  * The resulting data can be serialized in several ways.
- * </para>
  */
 
 static char *


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