summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAlexander Volkov <a.volkov@rusbitech.ru>2015-10-08 13:36:22 +0300
committerAlexander Volkov <a.volkov@rusbitech.ru>2015-10-08 12:16:46 +0000
commitd8e357f75a05bce5e1286c94e2b1954f6591218e (patch)
tree7719d0911bd9bbde90eca70e0faf21bdf51db22f /src
parenta7427878d0c097791469cf80ef561a21d74d06e1 (diff)
doc: Fix "Qt Sensors Backend" page
Remove "Backend API" section, it's actually "Overview". Manually create the "Backend Topics" list as it's typically done in the Qt documentation. And by removing superfluous directive "\generatelist related" we avoid the duplication of the topics list. Change-Id: I82de56cd80fa6b8719f85d3a01c07bac3d9d6c1a Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/sensors/doc/src/qtsensors-backend.qdoc14
1 files changed, 6 insertions, 8 deletions
diff --git a/src/sensors/doc/src/qtsensors-backend.qdoc b/src/sensors/doc/src/qtsensors-backend.qdoc
index 98fcd741..65ea612b 100644
--- a/src/sensors/doc/src/qtsensors-backend.qdoc
+++ b/src/sensors/doc/src/qtsensors-backend.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
-\group sensors_backend_topics
+\page sensors-backend-topics.html
\title Qt Sensors Backend
\brief Describes how to use the Qt Sensors backend.
@@ -37,8 +37,6 @@ hardware sensors.
\section1 Overview
-\section1 Backend API
-
QSensor instances talk to a backend object. Backends are usually supplied
with the Qt Sensors library for a specific device, although third-party
backends may be used as well. A backend can talk directly to hardware, or
@@ -53,14 +51,16 @@ classes to use.
\section1 Backend Topics
-\generatelist related
-
+\list
+\li \l{Creating a sensor plugin}
+\li \l{Determining the default sensor for a type}
+\li \l{Dynamic Sensor Backend Registration}
+\endlist
*/
/*!
\page creating-a-sensor-plugin.html
\title Creating a sensor plugin
-\ingroup sensors_backend_topics
\section1 How a Sensor Plugin is Loaded
@@ -83,7 +83,6 @@ An example follows.
/*!
\page determining-the-default-sensor-for-a-type.html
\title Determining the default sensor for a type
-\ingroup sensors_backend_topics
\section1 Multiple Sensors Can Exist for a Type
@@ -141,7 +140,6 @@ it is specified in \c{Sensors.conf}.
/*!
\page dynamic-sensor-backend-registration.html
\title Dynamic Sensor Backend Registration
-\ingroup sensors_backend_topics
\section1 Static Backend Registration