Commit 7aafc3d6 authored by Corentin Noël's avatar Corentin Noël Committed by Sam Thursfield

docs: Modernize the libtracker-control documentation

parent e4347082
<?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 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="http://library.gnome.org/devel/libtracker-miner/unstable/">
http://library.gnome.org/devel/libtracker-control/unstable
</ulink>.
</releaseinfo>
</bookinfo>
<!-- 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>Tracker control objects</title>
<xi:include href="xml/tracker-miner-manager.xml"/>
</chapter>
</part>
<xi:include href="migrating-1to2.xml"/>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
<?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>
<SECTION>
<FILE>tracker-miner-manager</FILE>
<TITLE>TrackerMinerManager</TITLE>
TRACKER_MINER_MANAGER_ERROR
TrackerMinerManagerError
TrackerMinerManager
TrackerMinerManagerClass
tracker_miner_manager_error_quark
tracker_miner_manager_new
tracker_miner_manager_new_full
tracker_miner_manager_get_running
tracker_miner_manager_get_available
tracker_miner_manager_pause
tracker_miner_manager_pause_for_process
tracker_miner_manager_resume
tracker_miner_manager_is_active
tracker_miner_manager_is_paused
tracker_miner_manager_get_status
tracker_miner_manager_get_display_name
tracker_miner_manager_get_description
tracker_miner_manager_reindex_by_mimetype
tracker_miner_manager_index_file
tracker_miner_manager_index_file_async
tracker_miner_manager_index_file_finish
tracker_miner_manager_index_file_for_process
tracker_miner_manager_index_file_for_process_async
tracker_miner_manager_index_file_for_process_finish
<SUBSECTION Standard>
TRACKER_IS_MINER_MANAGER
TRACKER_IS_MINER_MANAGER_CLASS
TRACKER_MINER_MANAGER
TRACKER_MINER_MANAGER_CLASS
TRACKER_MINER_MANAGER_GET_CLASS
TRACKER_TYPE_MINER_MANAGER
tracker_miner_manager_get_type
</SECTION>
......@@ -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)
......@@ -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>
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