summaryrefslogtreecommitdiff
path: root/docs/reference/libtracker-miner/libtracker-miner-docs.xml
blob: a54ae7482f40083d603b09737a5e53de3ef2ed4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?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-8" role="1.8">
    <title>Index of new symbols in 1.8</title>
    <xi:include href="xml/api-index-1.8.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>