[tracker/wip/tintou/tracker-control-doc] docs: Modernize the libtracker-control documentation
- From: Corentin Noël <corentinnoel src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [tracker/wip/tintou/tracker-control-doc] docs: Modernize the libtracker-control documentation
- Date: Wed, 27 Mar 2019 13:43:15 +0000 (UTC)
commit ceb5bdf90d68b52a67b991ef40f429eb39522fa6
Author: Corentin Noël <corentin noel collabora com>
Date: Wed Mar 27 14:41:57 2019 +0100
docs: Modernize the libtracker-control documentation
.../libtracker-control-docs.sgml | 36 ----------
.../libtracker-control/libtracker-control-docs.xml | 78 ++++++++++++++++++++++
.../libtracker-control-sections.txt | 37 ----------
.../libtracker-control/libtracker-control.types | 1 -
docs/reference/libtracker-control/meson.build | 4 +-
.../libtracker-control/migrating-1to2.xml | 5 +-
6 files changed, 83 insertions(+), 78 deletions(-)
---
diff --git a/docs/reference/libtracker-control/libtracker-control-docs.xml
b/docs/reference/libtracker-control/libtracker-control-docs.xml
new file mode 100644
index 000000000..ca9f4181d
--- /dev/null
+++ b/docs/reference/libtracker-control/libtracker-control-docs.xml
@@ -0,0 +1,78 @@
+<?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 Control Library Reference Manual</title>
+ <releaseinfo>
+ for libtracker-control &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>
+
+ <part id="libtracker-miner-reference">
+ <title>API Reference</title>
+ <partintro>
+ <para>
+ This section provides the detailed API of the Tracker Miner library.
+ </para>
+ </partintro>
+
+ <chapter>
+ <title>Tracker control objects</title>
+ <xi:include href="xml/tracker-miner-manager.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-10-5" role="0.10.5">
+ <title>Index of new symbols in 0.10.5</title>
+ <xi:include href="xml/api-index-0.10.5.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-0-10-15" role="0.10.15">
+ <title>Index of new symbols in 0.10.15</title>
+ <xi:include href="xml/api-index-0.10.15.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-16" role="0.16">
+ <title>Index of new symbols in 0.16</title>
+ <xi:include href="xml/api-index-0.16.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-control/meson.build b/docs/reference/libtracker-control/meson.build
index cb011d9b6..b38beedd4 100644
--- a/docs/reference/libtracker-control/meson.build
+++ b/docs/reference/libtracker-control/meson.build
@@ -4,9 +4,9 @@ version_xml = configure_file(input: 'version.xml.in',
gnome.gtkdoc('libtracker-control',
src_dir: controlinc,
- main_sgml: 'libtracker-control-docs.sgml',
+ main_xml: 'libtracker-control-docs.xml',
content_files: ['migrating-1to2.xml'],
dependencies: tracker_control_dep,
- gobject_typesfile: 'libtracker-control.types',
+ scan_args: ['--rebuild-sections'],
fixxref_args: fixxref_args,
install: true)
diff --git a/docs/reference/libtracker-control/migrating-1to2.xml
b/docs/reference/libtracker-control/migrating-1to2.xml
index 75116bc9f..22ccad4f7 100644
--- a/docs/reference/libtracker-control/migrating-1to2.xml
+++ b/docs/reference/libtracker-control/migrating-1to2.xml
@@ -17,8 +17,9 @@
<section>
<title>Cancellation support for tracker_miner_manager_index_file</title>
<para>
- The tracker_miner_manager_index_file method now requires a GCancellable
- argument. You can pass NULL if you don't want to specify one.
+ The <link linkend="tracker-miner-manager-index-file">tracker_miner_manager_index_file</link>
+ method now requires a <link linkend="GCancellable-struct"><classname>GCancellable</classname></link>
+ argument. You can pass <structname>NULL</structname> if you don't want to specify one.
</para>
</section>
</chapter>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]