This file is indexed.

/usr/share/qt5/doc/qtpositioning/qtpositioning-plugins.html is in qtlocation5-doc-html 5.5.1-3ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

 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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtpositioning-plugins.qdoc -->
  <title>Qt Positioning service plugins | Qt Positioning 5.5</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
    <div class="main">
    <div class="main-rounded">
        <div class="navigationbar">
        <ul>
<li>Qt 5.5</li>
<li><a href="qtpositioning-index.html">Qt Positioning</a></li>
<li>Qt Positioning service plugins</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
    </ul>
    </div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#plugin-description">Plugin Description</a></li>
<li class="level1"><a href="#implementing-plugins">Implementing Plugins</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Positioning service plugins</h1>
<span class="subtitle"></span>
<!-- $$$qtpositioning-plugins.html-description -->
<div class="descr"> <a name="details"></a>
<p>Qt Positioning provides the majority of its functionality through plugins. This document outlines how to develop a new position plugin.</p>
<a name="plugin-description"></a>
<h2 id="plugin-description">Plugin Description</h2>
<p>Each plugin is described by a json file. The json describes the plugins capabilities and version. Below is an example of a json file used by the postionpoll plugin:</p>
<pre class="cpp">{
    &quot;Keys&quot;: [<span class="string">&quot;positionpoll&quot;</span>],
    &quot;Provider&quot;: <span class="string">&quot;positionpoll&quot;</span>,
    &quot;Position&quot;: <span class="number">false</span>,
    &quot;Satellite&quot;: <span class="number">false</span>,
    &quot;Monitor&quot;: <span class="number">true</span>,
    &quot;Priority&quot;: <span class="number">1000</span>
}</pre>
<p>The entries have the following meaning:</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Key</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >Keys</td><td >The unique name/key of the plugin. Each position plugin must have a unique name.</td></tr>
<tr valign="top" class="even"><td >Provider</td><td >The provider name of the services. Multiple plugins may have the same name. In such cases the Version string will be used to further distinguish the plugins.</td></tr>
<tr valign="top" class="odd"><td >Position</td><td >Set to <code>true</code> if the plugin implements a <a href="qgeopositioninfosource.html">QGeoPositionInfoSource</a>.</td></tr>
<tr valign="top" class="even"><td >Satellite</td><td >Set to <code>true</code> if the plugin implements a <a href="qgeosatelliteinfosource.html">QGeoSatelliteInfoSource</a>.</td></tr>
<tr valign="top" class="odd"><td >Monitor</td><td >Set to <code>true</code> if the plugin implements a <a href="qgeoareamonitorsource.html">QGeoAreaMonitorSource</a>.</td></tr>
<tr valign="top" class="even"><td >Priority</td><td >The plugin priority. If multiple plugins have the same provider name, the plugin with the higest priority will be used.</td></tr>
</table></div>
<a name="implementing-plugins"></a>
<h2 id="implementing-plugins">Implementing Plugins</h2>
<p>A plugin implementer needs to subclass <a href="qgeopositioninfosourcefactory.html">QGeoPositionInfoSourceFactory</a> and override one or more of its functions. If a plugin does not support a specific feature the function should return 0 or utilize the default implementation.</p>
<ul>
<li><a href="qgeopositioninfosourcefactory.html#areaMonitor">QGeoPositionInfoSourceFactory::areaMonitor</a>()</li>
<li><a href="qgeopositioninfosourcefactory.html#positionInfoSource">QGeoPositionInfoSourceFactory::positionInfoSource</a>()</li>
<li><a href="qgeopositioninfosourcefactory.html#satelliteInfoSource">QGeoPositionInfoSourceFactory::satelliteInfoSource</a>()</li>
</ul>
</div>
<!-- @@@qtpositioning-plugins.html -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2015 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>