[tracker/wip/tintou/tracker-miner-doc: 2/2] docs: Modernize the libtracker-miner documentation



commit ae7640c7ab5595fa43ef7605b6f9e1ff7352d849
Author: Corentin Noël <corentin noel collabora com>
Date:   Wed Mar 27 16:27:23 2019 +0100

    docs: Modernize the libtracker-miner documentation

 .../libtracker-miner/libtracker-miner-docs.sgml    |  56 -----
 .../libtracker-miner/libtracker-miner-docs.xml     | 111 ++++++++++
 .../libtracker-miner/libtracker-miner-sections.txt | 228 ---------------------
 .../libtracker-miner/libtracker-miner.types        |   7 -
 docs/reference/libtracker-miner/meson.build        |   6 +-
 .../{overview.sgml => overview.xml}                |   0
 6 files changed, 114 insertions(+), 294 deletions(-)
---
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/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
similarity index 100%
rename from docs/reference/libtracker-miner/overview.sgml
rename to docs/reference/libtracker-miner/overview.xml


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