diff options
author | Corentin Noël <corentin@elementary.io> | 2019-03-28 17:22:48 +0100 |
---|---|---|
committer | Corentin Noël <corentin@elementary.io> | 2019-03-28 17:22:48 +0100 |
commit | 9279bf73e50b34821eecb41cd355c6a2f3cf63ba (patch) | |
tree | e43d83d08d8259af55f6d3db2de2ac0fb675283a | |
parent | 98611c1a2b7c3e6cafc77012dc44b6663b682992 (diff) | |
download | tracker-9279bf73e50b34821eecb41cd355c6a2f3cf63ba.tar.gz |
docs: Modernize the libtracker-sparql documentation
Still not fixed the Tracker 2.0 references here and there
-rw-r--r-- | docs/reference/libtracker-sparql/examples.xml (renamed from docs/reference/libtracker-sparql/examples.sgml) | 0 | ||||
-rw-r--r-- | docs/reference/libtracker-sparql/libtracker-sparql-docs.sgml | 57 | ||||
-rw-r--r-- | docs/reference/libtracker-sparql/libtracker-sparql-docs.xml | 95 | ||||
-rw-r--r-- | docs/reference/libtracker-sparql/libtracker-sparql-sections.txt | 42 | ||||
-rw-r--r-- | docs/reference/libtracker-sparql/libtracker-sparql.types | 8 | ||||
-rw-r--r-- | docs/reference/libtracker-sparql/meson.build | 5 | ||||
-rw-r--r-- | docs/reference/libtracker-sparql/ontologies.xml (renamed from docs/reference/libtracker-sparql/ontologies.sgml) | 0 | ||||
-rw-r--r-- | docs/reference/libtracker-sparql/overview.xml (renamed from docs/reference/libtracker-sparql/overview.sgml) | 0 | ||||
-rw-r--r-- | src/libtracker-sparql/tracker-connection.vala | 10 |
9 files changed, 141 insertions, 76 deletions
diff --git a/docs/reference/libtracker-sparql/examples.sgml b/docs/reference/libtracker-sparql/examples.xml index 5590e3b00..5590e3b00 100644 --- a/docs/reference/libtracker-sparql/examples.sgml +++ b/docs/reference/libtracker-sparql/examples.xml diff --git a/docs/reference/libtracker-sparql/libtracker-sparql-docs.sgml b/docs/reference/libtracker-sparql/libtracker-sparql-docs.sgml deleted file mode 100644 index 0f76996df..000000000 --- a/docs/reference/libtracker-sparql/libtracker-sparql-docs.sgml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -<!ENTITY version SYSTEM "version.xml"> -]> -<book id="index"> - <bookinfo> - <title>Tracker SPARQL Library Reference Manual</title> - <releaseinfo> - for libtracker-sparql &version;. - The latest version of this documentation can be found on-line at - <ulink role="online-location" url="http://library.gnome.org/devel/libtracker-sparql/unstable/"> - http://library.gnome.org/devel/libtracker-sparql/unstable - </ulink>. - </releaseinfo> - </bookinfo> - - <!-- The Library Overview --> - <xi:include href="overview.sgml"/> - - <!-- The API Reference --> - <part id="libtracker-sparql-reference"> - <title>Reference</title> - <partintro> - <para> - This section provides the detailed API of the Tracker SPARQL library. - </para> - </partintro> - - <xi:include href="xml/tracker-resource.xml"/> - <xi:include href="xml/tracker-namespace-manager.xml"/> - <xi:include href="xml/tracker-sparql-builder.xml"/> - <xi:include href="xml/tracker-sparql-connection.xml"/> - <xi:include href="xml/tracker-sparql-statement.xml"/> - <xi:include href="xml/tracker-sparql-cursor.xml"/> - <xi:include href="xml/tracker-notifier.xml"/> - <xi:include href="xml/tracker-misc.xml"/> - <xi:include href="xml/tracker-version.xml"/> - </part> - - <part id="base-ontology"> - <title>Base ontology</title> - <xi:include href="xml/dc-ontology.xml"/> - <xi:include href="xml/xsd-ontology.xml"/> - <xi:include href="xml/rdf-ontology.xml"/> - <xi:include href="xml/nrl-ontology.xml"/> - <xi:include href="xml/nao-ontology.xml"/> - </part> - - <xi:include href="ontologies.sgml"/> - <xi:include href="private-store.xml"/> - <xi:include href="examples.sgml"/> - <xi:include href="migrating-1to2.xml"/> - - <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> -</book> diff --git a/docs/reference/libtracker-sparql/libtracker-sparql-docs.xml b/docs/reference/libtracker-sparql/libtracker-sparql-docs.xml new file mode 100644 index 000000000..5f5611e18 --- /dev/null +++ b/docs/reference/libtracker-sparql/libtracker-sparql-docs.xml @@ -0,0 +1,95 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN' + 'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [ + +<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +<!ENTITY version SYSTEM "version.xml"> +]> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>Tracker SPARQL Library Reference Manual</title> + <releaseinfo> + for libtracker-sparql &version;. + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="https://developer.gnome.org/libtracker-sparql/stable/"> + https://developer.gnome.org/libtracker-sparql/stable + </ulink>. + </releaseinfo> + </bookinfo> + + <!-- The Library Overview --> + <xi:include href="overview.xml"/> + + <!-- The API Reference --> + <part id="libtracker-sparql-reference"> + <title>Reference</title> + <partintro> + <para> + This section provides the detailed API of the Tracker SPARQL library. + </para> + </partintro> + + <xi:include href="xml/tracker-resource.xml"/> + <xi:include href="xml/tracker-namespace-manager.xml"/> + <xi:include href="xml/tracker-sparql-builder.xml"/> + <xi:include href="xml/tracker-sparql-connection.xml"/> + <xi:include href="xml/tracker-sparql-statement.xml"/> + <xi:include href="xml/tracker-sparql-cursor.xml"/> + <xi:include href="xml/tracker-notifier.xml"/> + <xi:include href="xml/tracker-misc.xml"/> + <xi:include href="xml/tracker-version.xml"/> + </part> + + <part id="base-ontology"> + <title>Base ontology</title> + <xi:include href="xml/dc-ontology.xml"/> + <xi:include href="xml/xsd-ontology.xml"/> + <xi:include href="xml/rdf-ontology.xml"/> + <xi:include href="xml/nrl-ontology.xml"/> + <xi:include href="xml/nao-ontology.xml"/> + </part> + + <xi:include href="ontologies.xml"/> + <xi:include href="private-store.xml"/> + <xi:include href="examples.xml"/> + <xi:include href="migrating-1to2.xml"/> + + <index id="api-index-full"> + <title>Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-deprecated" role="deprecated"> + <title>Index of deprecated symbols</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-0-10" role="0.10"> + <title>Index of new symbols in 0.10</title> + <xi:include href="xml/api-index-0.10.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-0-12" role="0.12"> + <title>Index of new symbols in 0.12</title> + <xi:include href="xml/api-index-0.12.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-1-10" role="1.10"> + <title>Index of new symbols in 1.10</title> + <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-1-12" role="1.12"> + <title>Index of new symbols in 1.12</title> + <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-2-0" role="2.0"> + <title>Index of new symbols in 2.0</title> + <xi:include href="xml/api-index-2.0.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-2-0-5" role="2.0.5"> + <title>Index of new symbols in 2.0.5</title> + <xi:include href="xml/api-index-2.0.5.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-2-2" role="2.2"> + <title>Index of new symbols in 2.2</title> + <xi:include href="xml/api-index-2.2.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/docs/reference/libtracker-sparql/libtracker-sparql-sections.txt b/docs/reference/libtracker-sparql/libtracker-sparql-sections.txt index 5f7899a10..8c0b6a4ef 100644 --- a/docs/reference/libtracker-sparql/libtracker-sparql-sections.txt +++ b/docs/reference/libtracker-sparql/libtracker-sparql-sections.txt @@ -7,6 +7,9 @@ tracker_sparql_escape_string tracker_sparql_escape_uri tracker_sparql_escape_uri_printf tracker_sparql_escape_uri_vprintf +<SUBSECTION Standard> +TRACKER_TYPE_URI +tracker_uri_get_type </SECTION> <SECTION> @@ -45,6 +48,27 @@ tracker_resource_get_values tracker_resource_identifier_compare_func tracker_resource_print_sparql_update tracker_resource_print_turtle +tracker_resource_print_jsonld +TRACKER_DATASOURCE_URN_NON_REMOVABLE_MEDIA +TRACKER_OWN_GRAPH_URN +TRACKER_PREFIX_DATASOURCE_URN +TRACKER_PREFIX_DC +TRACKER_PREFIX_MFO +TRACKER_PREFIX_MLO +TRACKER_PREFIX_NAO +TRACKER_PREFIX_NCO +TRACKER_PREFIX_NFO +TRACKER_PREFIX_NID3 +TRACKER_PREFIX_NIE +TRACKER_PREFIX_NMM +TRACKER_PREFIX_NMO +TRACKER_PREFIX_NRL +TRACKER_PREFIX_OSINFO +TRACKER_PREFIX_RDF +TRACKER_PREFIX_RDFS +TRACKER_PREFIX_SLO +TRACKER_PREFIX_TRACKER +TRACKER_PREFIX_XSD <SUBSECTION Standard> TrackerResourceClass TRACKER_RESOURCE @@ -59,6 +83,7 @@ TRACKER_RESOURCE_GET_CLASS <SECTION> <FILE>tracker-namespace-manager</FILE> <TITLE>TrackerNamespaceManager</TITLE> +TrackerNamespaceManager tracker_namespace_manager_add_prefix tracker_namespace_manager_expand_uri tracker_namespace_manager_get_default @@ -66,7 +91,9 @@ tracker_namespace_manager_has_prefix tracker_namespace_manager_lookup_prefix tracker_namespace_manager_new tracker_namespace_manager_print_turtle +tracker_namespace_manager_foreach <SUBSECTION Standard> +TrackerNamespaceManagerClass TRACKER_TYPE_NAMESPACE_MANAGER </SECTION> @@ -161,6 +188,8 @@ tracker_sparql_connection_statistics_finish tracker_sparql_connection_get_namespace_manager tracker_sparql_connection_set_domain tracker_sparql_connection_get_domain +tracker_sparql_connection_get_dbus_connection +tracker_sparql_connection_set_dbus_connection <SUBSECTION Standard> TrackerSparqlConnectionClass TRACKER_SPARQL_CONNECTION @@ -171,6 +200,8 @@ TRACKER_SPARQL_IS_CONNECTION_CLASS TRACKER_SPARQL_TYPE_CONNECTION TRACKER_SPARQL_TYPE_VALUE_TYPE tracker_sparql_connection_get_type +TRACKER_SPARQL_TYPE_CONNECTION_FLAGS +tracker_sparql_connection_flags_get_type <SUBSECTION Private> TRACKER_DBUS_INTERFACE_RESOURCES TRACKER_DBUS_INTERFACE_STATISTICS @@ -197,6 +228,10 @@ tracker_sparql_statement_bind_int tracker_sparql_statement_bind_double tracker_sparql_statement_bind_string tracker_sparql_statement_bind_boolean +tracker_sparql_statement_get_connection +tracker_sparql_statement_set_connection +tracker_sparql_statement_get_sparql +tracker_sparql_statement_set_sparql <SUBSECTION Standard> TrackerSparqlStatementClass TRACKER_SPARQL_STATEMENT @@ -269,6 +304,10 @@ TRACKER_NOTIFIER_CLASS TRACKER_NOTIFIER_GET_CLASS TRACKER_TYPE_NOTIFIER tracker_notifier_get_type +TRACKER_TYPE_NOTIFIER_EVENT_TYPE +tracker_notifier_event_type_get_type +TRACKER_TYPE_NOTIFIER_FLAGS +tracker_notifier_flags_get_type </SECTION> <SECTION> @@ -282,8 +321,5 @@ tracker_interface_age tracker_check_version <SUBSECTION> -TRACKER_MAJOR_VERSION -TRACKER_MINOR_VERSION -TRACKER_MICRO_VERSION TRACKER_CHECK_VERSION </SECTION> diff --git a/docs/reference/libtracker-sparql/libtracker-sparql.types b/docs/reference/libtracker-sparql/libtracker-sparql.types deleted file mode 100644 index 0b6587b7b..000000000 --- a/docs/reference/libtracker-sparql/libtracker-sparql.types +++ /dev/null @@ -1,8 +0,0 @@ -tracker_resource_get_type -tracker_namespace_manager_get_type -tracker_sparql_builder_get_type -tracker_sparql_builder_state_get_type -tracker_sparql_connection_get_type -tracker_sparql_statement_get_type -tracker_sparql_cursor_get_type -tracker_notifier_get_type diff --git a/docs/reference/libtracker-sparql/meson.build b/docs/reference/libtracker-sparql/meson.build index 193cded84..e86e0b459 100644 --- a/docs/reference/libtracker-sparql/meson.build +++ b/docs/reference/libtracker-sparql/meson.build @@ -28,9 +28,8 @@ example_files = [ gnome.gtkdoc('libtracker-sparql', src_dir: sparqlinc, - main_sgml: 'libtracker-sparql-docs.sgml', - content_files: ['overview.sgml', 'examples.sgml', 'ontologies.sgml', 'private-store.xml', 'migrating-1to2.xml', example_files], + main_xml: 'libtracker-sparql-docs.xml', + content_files: ['overview.xml', 'examples.xml', 'ontologies.xml', 'private-store.xml', 'migrating-1to2.xml', example_files], dependencies: tracker_sparql_dep, - gobject_typesfile: 'libtracker-sparql.types', fixxref_args: fixxref_args, install: true) diff --git a/docs/reference/libtracker-sparql/ontologies.sgml b/docs/reference/libtracker-sparql/ontologies.xml index 615ff74d0..615ff74d0 100644 --- a/docs/reference/libtracker-sparql/ontologies.sgml +++ b/docs/reference/libtracker-sparql/ontologies.xml diff --git a/docs/reference/libtracker-sparql/overview.sgml b/docs/reference/libtracker-sparql/overview.xml index 14890457d..14890457d 100644 --- a/docs/reference/libtracker-sparql/overview.sgml +++ b/docs/reference/libtracker-sparql/overview.xml diff --git a/src/libtracker-sparql/tracker-connection.vala b/src/libtracker-sparql/tracker-connection.vala index cdb6c36eb..70ef83218 100644 --- a/src/libtracker-sparql/tracker-connection.vala +++ b/src/libtracker-sparql/tracker-connection.vala @@ -136,11 +136,11 @@ public abstract class Tracker.Sparql.Connection : Object { * which it won't support (i.e. an update for a read-only backend), you will * see critical warnings. * - * When calling either tracker_sparql_connection_get(), - * tracker_sparql_connection_get_direct() or the asynchronous variants of - * these functions, a mutex is used to protect the loading of backends - * against potential race conditions. For synchronous calls, this function - * will always block if a previous connection get method has been called. + * When calling either tracker_sparql_connection_get(), or the asynchronous + * variants of these functions, a mutex is used to protect the loading of + * backends against potential race conditions. For synchronous calls, this + * function will always block if a previous connection get method has been + * called. * * All backends will call the D-Bus tracker-store API Wait() to make sure * the store and databases are in the right state before any user based |