docs: Modernize the libtracker-miner documentation

6 files changed, 114 insertions, 294 deletions

diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
deleted file mode 100644
index 5dbfe4780..000000000
--- a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
+++ /dev/null
@@ -1,56 +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 Miner Library Reference Manual</title>
-    <releaseinfo>
-	  for libtracker-miner &version;.
-	  The latest version of this documentation can be found on-line at
-	  <ulink role="online-location" url="http://library.gnome.org/devel/libtracker-miner/unstable/">
-		http://library.gnome.org/devel/libtracker-miner/unstable
-	  </ulink>.
-	</releaseinfo>
-  </bookinfo>
-
-  <!-- The Library Overview -->
-  <xi:include href="overview.sgml"/>
-
-  <!-- The API Reference -->
-  <part id="libtracker-miner-reference">
-    <title>Reference</title>
-    <partintro>
-      <para>
-        This section provides the detailed API of the Tracker Miner library.
-      </para>
-    </partintro>
-
-    <chapter>
-      <title>Base abstract miner classes</title>
-      <xi:include href="xml/tracker-miner-enums.xml"/>
-      <xi:include href="xml/tracker-miner-object.xml"/>
-      <xi:include href="xml/tracker-miner-online.xml"/>
-      <xi:include href="xml/tracker-data-provider.xml"/>
-      <xi:include href="xml/tracker-indexing-tree.xml"/>
-    </chapter>
-
-    <chapter>
-      <title>Miner classes for file system</title>
-      <xi:include href="xml/tracker-miner-fs.xml"/>
-      <xi:include href="xml/tracker-file-data-provider.xml"/>
-      <xi:include href="xml/tracker-decorator-fs.xml"/>
-    </chapter>
-
-    <chapter>
-      <title>DBus helpers</title>
-      <xi:include href="xml/tracker-decorator.xml"/>
-      <xi:include href="xml/tracker-miner-proxy.xml"/>
-    </chapter>
-  </part>
-
-  <xi:include href="migrating-1to2.xml"/>
-  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-</book>
diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.xml b/docs/reference/libtracker-miner/libtracker-miner-docs.xml
new file mode 100644
index 000000000..2ef95978a
--- /dev/null
+++ b/docs/reference/libtracker-miner/libtracker-miner-docs.xml
@@ -0,0 +1,111 @@
+<?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 Miner Library Reference Manual</title>
+    <releaseinfo>
+      for libtracker-miner &version;.
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="https://developer.gnome.org/libtracker-miner/stable/">
+        https://developer.gnome.org/libtracker-miner/stable
+      </ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <!-- The Library Overview -->
+  <xi:include href="overview.xml"/>
+
+  <!-- The API Reference -->
+  <part id="libtracker-miner-reference">
+    <title>Reference</title>
+    <partintro>
+      <para>
+        This section provides the detailed API of the Tracker Miner library.
+      </para>
+    </partintro>
+
+    <chapter>
+      <title>Base abstract miner classes</title>
+      <xi:include href="xml/tracker-miner-enums.xml"/>
+      <xi:include href="xml/tracker-miner-object.xml"/>
+      <xi:include href="xml/tracker-miner-online.xml"/>
+      <xi:include href="xml/tracker-data-provider.xml"/>
+      <xi:include href="xml/tracker-indexing-tree.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Miner classes for file system</title>
+      <xi:include href="xml/tracker-miner-fs.xml"/>
+      <xi:include href="xml/tracker-file-system.xml"/>
+      <xi:include href="xml/tracker-file-data-provider.xml"/>
+      <xi:include href="xml/tracker-file-notifier.xml"/>
+      <xi:include href="xml/tracker-monitor.xml"/>
+      <xi:include href="xml/tracker-decorator-fs.xml"/>
+      <xi:include href="xml/tracker-crawler.xml"/>
+      <xi:include href="xml/tracker-priority-queue.xml"/>
+      <xi:include href="xml/tracker-task-pool.xml"/>
+      <xi:include href="xml/tracker-sparql-buffer.xml"/>
+      <xi:include href="xml/tracker-utils.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>DBus helpers</title>
+      <xi:include href="xml/tracker-decorator.xml"/>
+      <xi:include href="xml/tracker-miner-proxy.xml"/>
+    </chapter>
+  </part>
+
+  <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-8" role="0.8">
+    <title>Index of new symbols in 0.8</title>
+    <xi:include href="xml/api-index-0.8.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-0-14" role="0.14">
+    <title>Index of new symbols in 0.14</title>
+    <xi:include href="xml/api-index-0.14.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-0-18" role="0.18">
+    <title>Index of new symbols in 0.18</title>
+    <xi:include href="xml/api-index-0.18.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-1-2" role="1.2">
+    <title>Index of new symbols in 1.2</title>
+    <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-1-2-2" role="1.2.2">
+    <title>Index of new symbols in 1.2.2</title>
+    <xi:include href="xml/api-index-1.2.2.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-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>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
deleted file mode 100644
index d5b74d20e..000000000
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ /dev/null
@@ -1,228 +0,0 @@
-<SECTION>
-<FILE>tracker-data-provider</FILE>
-<TITLE>TrackerDataProvider</TITLE>
-TrackerDataProviderIface
-tracker_data_provider_begin
-tracker_data_provider_begin_async
-tracker_data_provider_begin_finish
-TrackerDataProvider
-<SUBSECTION Standard>
-TRACKER_DATA_PROVIDER
-TRACKER_DATA_PROVIDER_GET_IFACE
-TRACKER_IS_DATA_PROVIDER
-TRACKER_TYPE_DATA_PROVIDER
-tracker_data_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-decorator</FILE>
-<TITLE>TrackerDecorator</TITLE>
-TrackerDecorator
-TrackerDecoratorClass
-TrackerDecoratorError
-tracker_decorator_error_quark
-tracker_decorator_get_data_source
-tracker_decorator_get_class_names
-tracker_decorator_get_n_items
-tracker_decorator_prepend_id
-tracker_decorator_delete_id
-tracker_decorator_next
-tracker_decorator_next_finish
-tracker_decorator_set_priority_rdf_types
-tracker_decorator_info_ref
-tracker_decorator_info_unref
-tracker_decorator_info_get_urn
-tracker_decorator_info_get_url
-tracker_decorator_info_get_mimetype
-tracker_decorator_info_get_task
-tracker_decorator_info_complete
-tracker_decorator_info_complete_error
-<SUBSECTION Standard>
-TRACKER_DECORATOR
-TRACKER_DECORATOR_CLASS
-TRACKER_DECORATOR_GET_CLASS
-TRACKER_IS_DECORATOR
-TRACKER_IS_DECORATOR_CLASS
-TRACKER_TYPE_DECORATOR
-TrackerDecoratorInfo
-tracker_decorator_get_type
-tracker_decorator_info_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-decorator-fs</FILE>
-<TITLE>TrackerDecoratorFS</TITLE>
-TrackerDecoratorFS
-TrackerDecoratorFSClass
-tracker_decorator_fs_prepend_file
-<SUBSECTION Standard>
-TRACKER_DECORATOR_FS
-TRACKER_DECORATOR_FS_CLASS
-TRACKER_DECORATOR_FS_GET_CLASS
-TRACKER_IS_DECORATOR_FS
-TRACKER_IS_DECORATOR_FS_CLASS
-TRACKER_TYPE_DECORATOR_FS
-tracker_decorator_fs_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-file-data-provider</FILE>
-<TITLE>TrackerFileDataProvider</TITLE>
-TrackerFileDataProviderClass
-tracker_file_data_provider_new
-TrackerFileDataProvider
-<SUBSECTION Standard>
-TRACKER_FILE_DATA_PROVIDER
-TRACKER_FILE_DATA_PROVIDER_CLASS
-TRACKER_FILE_DATA_PROVIDER_GET_CLASS
-TRACKER_IS_FILE_DATA_PROVIDER
-TRACKER_IS_FILE_DATA_PROVIDER_CLASS
-TRACKER_TYPE_FILE_DATA_PROVIDER
-TrackerFileDataProviderPrivate
-tracker_file_data_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-indexing-tree</FILE>
-<TITLE>TrackerIndexingTree</TITLE>
-TrackerIndexingTree
-TrackerIndexingTreeClass
-tracker_indexing_tree_new
-tracker_indexing_tree_new_with_root
-tracker_indexing_tree_add
-tracker_indexing_tree_remove
-tracker_indexing_tree_add_filter
-tracker_indexing_tree_clear_filters
-tracker_indexing_tree_file_matches_filter
-tracker_indexing_tree_file_is_indexable
-tracker_indexing_tree_parent_is_indexable
-tracker_indexing_tree_get_filter_hidden
-tracker_indexing_tree_set_filter_hidden
-tracker_indexing_tree_get_default_policy
-tracker_indexing_tree_set_default_policy
-tracker_indexing_tree_get_root
-tracker_indexing_tree_get_master_root
-tracker_indexing_tree_file_is_root
-tracker_indexing_tree_list_roots
-tracker_indexing_tree_notify_update
-<SUBSECTION Standard>
-TRACKER_INDEXING_TREE
-TRACKER_INDEXING_TREE_CLASS
-TRACKER_INDEXING_TREE_GET_CLASS
-TRACKER_IS_INDEXING_TREE
-TRACKER_IS_INDEXING_TREE_CLASS
-TRACKER_TYPE_INDEXING_TREE
-tracker_indexing_tree_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-miner-enum-types</FILE>
-<SUBSECTION Standard>
-TRACKER_TYPE_DIRECTORY_FLAGS
-TRACKER_TYPE_FILTER_POLICY
-TRACKER_TYPE_FILTER_TYPE
-TRACKER_TYPE_NETWORK_TYPE
-tracker_directory_flags_get_type
-tracker_filter_policy_get_type
-tracker_filter_type_get_type
-tracker_network_type_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-miner-enums</FILE>
-TrackerDirectoryFlags
-TrackerFilterType
-TrackerFilterPolicy
-TrackerNetworkType
-</SECTION>
-
-<SECTION>
-<FILE>tracker-miner-fs</FILE>
-<TITLE>TrackerMinerFS</TITLE>
-TrackerMinerFS
-TrackerMinerFSClass
-TrackerMinerFSError
-TrackerMinerFSEventType
-tracker_miner_fs_error_quark
-tracker_miner_fs_get_indexing_tree
-tracker_miner_fs_get_data_provider
-tracker_miner_fs_get_throttle
-tracker_miner_fs_set_throttle
-tracker_miner_fs_check_file
-tracker_miner_fs_notify_finish
-tracker_miner_fs_get_urn
-tracker_miner_fs_query_urn
-tracker_miner_fs_has_items_to_process
-<SUBSECTION Standard>
-TRACKER_IS_MINER_FS
-TRACKER_IS_MINER_FS_CLASS
-TRACKER_MINER_FS
-TRACKER_MINER_FS_CLASS
-TRACKER_MINER_FS_GET_CLASS
-TRACKER_TYPE_MINER_FS
-TrackerMinerFSPrivate
-tracker_miner_fs_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-miner-object</FILE>
-<TITLE>TrackerMiner</TITLE>
-TRACKER_MINER_DBUS_INTERFACE
-TRACKER_MINER_DBUS_NAME_PREFIX
-TRACKER_MINER_DBUS_PATH_PREFIX
-TRACKER_MINER_ERROR_DOMAIN
-TRACKER_MINER_ERROR
-TrackerMiner
-TrackerMinerClass
-TrackerMinerError
-tracker_miner_error_quark
-tracker_miner_start
-tracker_miner_stop
-tracker_miner_is_started
-tracker_miner_is_paused
-tracker_miner_pause
-tracker_miner_resume
-tracker_miner_get_connection
-<SUBSECTION Standard>
-TRACKER_IS_MINER
-TRACKER_IS_MINER_CLASS
-TRACKER_MINER
-TRACKER_MINER_CLASS
-TRACKER_MINER_GET_CLASS
-TRACKER_TYPE_MINER
-TrackerMinerPrivate
-tracker_miner_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-miner-online</FILE>
-<TITLE>TrackerMinerOnline</TITLE>
-TrackerMinerOnline
-TrackerMinerOnlineClass
-tracker_miner_online_get_network_type
-<SUBSECTION Standard>
-TRACKER_IS_MINER_ONLINE
-TRACKER_IS_MINER_ONLINE_CLASS
-TRACKER_MINER_ONLINE
-TRACKER_MINER_ONLINE_CLASS
-TRACKER_MINER_ONLINE_GET_CLASS
-TRACKER_TYPE_MINER_ONLINE
-tracker_miner_online_get_type
-</SECTION>
-
-<SECTION>
-<FILE>tracker-miner-proxy</FILE>
-<TITLE>TrackerMinerProxy</TITLE>
-TrackerMinerProxy
-TrackerMinerProxyClass
-tracker_miner_proxy_new
-<SUBSECTION Standard>
-TRACKER_IS_MINER_PROXY
-TRACKER_IS_MINER_PROXY_CLASS
-TRACKER_MINER_PROXY
-TRACKER_MINER_PROXY_CLASS
-TRACKER_MINER_PROXY_GET_CLASS
-TRACKER_TYPE_MINER_PROXY
-tracker_miner_proxy_get_type
-</SECTION>
-
diff --git a/docs/reference/libtracker-miner/libtracker-miner.types b/docs/reference/libtracker-miner/libtracker-miner.types
deleted file mode 100644
index 8cff4f654..000000000
--- a/docs/reference/libtracker-miner/libtracker-miner.types
+++ /dev/null
@@ -1,7 +0,0 @@
-tracker_decorator_get_type
-tracker_decorator_fs_get_type
-tracker_indexing_tree_get_type
-tracker_miner_get_type
-tracker_miner_fs_get_type
-tracker_miner_online_get_type
-tracker_miner_proxy_get_type
diff --git a/docs/reference/libtracker-miner/meson.build b/docs/reference/libtracker-miner/meson.build
index 5f748303f..30bcb43b5 100644
--- a/docs/reference/libtracker-miner/meson.build
+++ b/docs/reference/libtracker-miner/meson.build
@@ -4,9 +4,9 @@ version_xml = configure_file(input: 'version.xml.in',
 
 gnome.gtkdoc('libtracker-miner',
     src_dir: minerinc,
-    main_sgml: 'libtracker-miner-docs.sgml',
-    content_files: ['overview.sgml', 'migrating-1to2.xml'],
+    main_xml: 'libtracker-miner-docs.xml',
+    content_files: ['overview.xml', 'migrating-1to2.xml'],
     dependencies: tracker_miner_dep,
-    gobject_typesfile: 'libtracker-miner.types',
+    scan_args: ['--rebuild-sections'],
     fixxref_args: fixxref_args,
     install: true)
diff --git a/docs/reference/libtracker-miner/overview.sgml b/docs/reference/libtracker-miner/overview.xml
index 5becdcd14..5becdcd14 100644
--- a/docs/reference/libtracker-miner/overview.sgml
+++ b/docs/reference/libtracker-miner/overview.xml