Commit 9279bf73 authored by Corentin Noël's avatar Corentin Noël

docs: Modernize the libtracker-sparql documentation

Still not fixed the Tracker 2.0 references here and there
parent 98611c1a
<?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" [
<!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">
<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="http://library.gnome.org/devel/libtracker-sparql/unstable/">
http://library.gnome.org/devel/libtracker-sparql/unstable
</ulink>.
</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.sgml"/>
<xi:include href="overview.xml"/>
<!-- The API Reference -->
<part id="libtracker-sparql-reference">
......@@ -48,10 +49,47 @@
<xi:include href="xml/nao-ontology.xml"/>
</part>
<xi:include href="ontologies.sgml"/>
<xi:include href="ontologies.xml"/>
<xi:include href="private-store.xml"/>
<xi:include href="examples.sgml"/>
<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>
......@@ -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>
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
......@@ -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)
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment