summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/src/examples/grue.qdoc4
-rw-r--r--doc/src/examples/qmlqtsensors.qdoc4
-rw-r--r--doc/src/examples/sensors.qdoc6
-rw-r--r--doc/src/imports/qtmobilitysensors1.qdoc2
-rw-r--r--doc/src/imports/qtsensors5.qdoc6
-rw-r--r--doc/src/porting.qdoc22
-rw-r--r--doc/src/qtsensors-backend.qdoc8
-rw-r--r--doc/src/qtsensors-cpp.qdoc18
-rw-r--r--doc/src/qtsensors.qdoc42
9 files changed, 56 insertions, 56 deletions
diff --git a/doc/src/examples/grue.qdoc b/doc/src/examples/grue.qdoc
index 136e3d40..c2be06e1 100644
--- a/doc/src/examples/grue.qdoc
+++ b/doc/src/examples/grue.qdoc
@@ -80,7 +80,7 @@
/*!
\example sensors/grue/plugin
\title Grue Sensor Implementation
- \brief The Grue sensor implementation lives in a plugin that is loaded by the QtSensors library.
+ \brief The Grue sensor implementation lives in a plugin that is loaded by the Qt Sensors library.
The Grue sensor needs a backend before it can be used. The backend provided
is rather basic and it relies on some kind of light sensor to work but it
@@ -128,7 +128,7 @@
\brief The Grue sensor console application demonstrates use of the Grue sensor.
This is a simple commandline application. It demonstrates how to use the generic
- access feature of QtSensors to avoid a link-time dependency on the Grue Sensor
+ access feature of Qt Sensors to avoid a link-time dependency on the Grue Sensor
library.
\sa {Grue Sensor Example}
diff --git a/doc/src/examples/qmlqtsensors.qdoc b/doc/src/examples/qmlqtsensors.qdoc
index 4e997c8a..4fc9e7d1 100644
--- a/doc/src/examples/qmlqtsensors.qdoc
+++ b/doc/src/examples/qmlqtsensors.qdoc
@@ -27,9 +27,9 @@
/*!
\example sensors/qmlqtsensors
- \title QML QtSensors example
+ \title QML Qt Sensors example
\ingroup qtsensors-examples
- \brief The QML QtSensors example demonstrates the QML sensors elements in the QtSensors 5 import.
+ \brief The QML Qt Sensors example demonstrates the QML sensors elements in the QtSensors 5 import.
\image qmlqtsensors.jpg
\section1 Overview
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc
index 530df3d5..3bf57d9c 100644
--- a/doc/src/examples/sensors.qdoc
+++ b/doc/src/examples/sensors.qdoc
@@ -27,11 +27,11 @@
/*!
\group qtsensors-examples
- \title QtSensors Examples
- \brief Examples for the QtSensors module
+ \title Qt Sensors Examples
+ \brief Examples for the Qt Sensors module
\ingroup all-examples
- These are the QtSensors examples.
+ These are the Qt Sensors examples.
\generatelist related
*/
diff --git a/doc/src/imports/qtmobilitysensors1.qdoc b/doc/src/imports/qtmobilitysensors1.qdoc
index 7b068cac..40ec4b63 100644
--- a/doc/src/imports/qtmobilitysensors1.qdoc
+++ b/doc/src/imports/qtmobilitysensors1.qdoc
@@ -35,7 +35,7 @@
This is the legacy QML import. It exists for compatibility with the QtMobiltiy 1.2 release
and is not recommended for new applications.
- The QtMobility.sensors import has the QtSensors C++ classes directly exported into the QML environment.
+ The QtMobility.sensors import has the Qt Sensors C++ classes directly exported into the QML environment.
This causes some limitations due to the use of types that do not work in the QML environment.
See \l{QtMobility.sensors QML Limitations}{below} for a list of the known limitations.
diff --git a/doc/src/imports/qtsensors5.qdoc b/doc/src/imports/qtsensors5.qdoc
index 6f1a46a4..c8898682 100644
--- a/doc/src/imports/qtsensors5.qdoc
+++ b/doc/src/imports/qtsensors5.qdoc
@@ -27,8 +27,8 @@
/*!
\qmlmodule QtSensors 5
- \title QtSensors 5.x
- \brief The QML import for QtSensors
+ \title Qt Sensors QML API
+ \brief The QML import for Qt Sensors
\section1 Overview
@@ -40,7 +40,7 @@
sensors.
The plugin contains many sensor types and properties to read values.
- As an example, consider the tilt sensor. The \l {QML QtSensors example}
+ As an example, consider the tilt sensor. The \l {QML Qt Sensors example}
simply displays text on-screen to show the current tilt value.
The QML code to read the value is quite simple. Below is a QML \l TiltSensor element
diff --git a/doc/src/porting.qdoc b/doc/src/porting.qdoc
index fcd38498..3911f34c 100644
--- a/doc/src/porting.qdoc
+++ b/doc/src/porting.qdoc
@@ -27,15 +27,15 @@
/*!
\page qtsensors-porting.html
- \title Porting Applications from QtMobility Sensors to QtSensors
+ \title Porting Applications from QtMobility Sensors to Qt Sensors
\tableofcontents
\section1 Overview
- The initial release of QtSensors (5.0) is generally expected to be source
+ The initial release of Qt Sensors (5.0) is generally expected to be source
compatible with QtMobility Sensors 1.2. This document attempts to explain
- where things must be changed in order to port applications to QtSensors.
+ where things must be changed in order to port applications to Qt Sensors.
\section1 QML
@@ -48,8 +48,8 @@
\table
\row
- \o \l {QtSensors 5.x}{QML API}
- \o Information about the QtSensors QML API
+ \o \l {Qt Sensors QML API}{QML API}
+ \o Information about the Qt Sensors QML API
\row
\o \l {QtMobility.sensors 1.x}{Legacy QML API}
\o Information about the legacy QtMobility.sensors QML API
@@ -59,8 +59,8 @@
\section2 Includes
- QtMobility Sensors installed headers into a \c QtSensors directory. This is
- also the directory that QtSensors uses. It is therefore expected that includes
+ QtMobility Sensors installed headers into a \c Qt Sensors directory. This is
+ also the directory that Qt Sensors uses. It is therefore expected that includes
that worked with QtMobility Sensors should continue to work.
For example:
@@ -74,7 +74,7 @@
\section2 Macros and Namespace
QtMobility Sensors was built in a \c QtMobility namespace. This was enabled by
- the use of various macros. QtSensors does not normally build into a namespace
+ the use of various macros. Qt Sensors does not normally build into a namespace
and the macros from QtMobility no longer exist.
\list
@@ -85,7 +85,7 @@
\endlist
Note that Qt can be configured to build into a namespace. If Qt is built in this
- way then QtSensors is also built into the nominated namespace. However, as this
+ way then Qt Sensors is also built into the nominated namespace. However, as this
is optional, the macros for this are typically defined to do nothing.
\list
@@ -100,7 +100,7 @@
qtimestamp was previously defined as an opaque type equivalent to a quint64. It existed
as a class due to an implementation detail.
- In QtSensors, the API uses quint64 instead of qtimestamp. qtimestamp still exists as a
+ In Qt Sensors, the API uses quint64 instead of qtimestamp. qtimestamp still exists as a
typedef so that applications that refer to qtimestamp can be compiled.
\section1 Project Files
@@ -112,7 +112,7 @@
MOBILITY += sensors
\endcode
- Applications should remove these lines and instead use this to enable the QtSensors API.
+ Applications should remove these lines and instead use this to enable the Qt Sensors API.
\code
QT += sensors
diff --git a/doc/src/qtsensors-backend.qdoc b/doc/src/qtsensors-backend.qdoc
index 5fad1bf2..8e79100d 100644
--- a/doc/src/qtsensors-backend.qdoc
+++ b/doc/src/qtsensors-backend.qdoc
@@ -27,10 +27,10 @@
/*!
\group sensors_backend_topics
-\title QtSensors Backend
-\brief Information about the QtSensors back end
+\title Qt Sensors Backend
+\brief Information about the Qt Sensors back end
-The QtSensors backend connects the QtSensors API to the platform services or hardware sensors.
+The Qt Sensors backend connects the Qt Sensors API to the platform services or hardware sensors.
\tableofcontents
@@ -39,7 +39,7 @@ The QtSensors backend connects the QtSensors API to the platform services or har
\section1 Backend API
QSensor instances talk to a backend object. Backends are usually supplied
-with the QtSensors library for a specific device although third party
+with the Qt Sensors library for a specific device although third party
backends may be used as well. A backend may talk
directly to hardware or it may talk to a system service. In some instances
it may even talk to another sensor.
diff --git a/doc/src/qtsensors-cpp.qdoc b/doc/src/qtsensors-cpp.qdoc
index ecb54b43..6740441d 100644
--- a/doc/src/qtsensors-cpp.qdoc
+++ b/doc/src/qtsensors-cpp.qdoc
@@ -27,23 +27,23 @@
/*!
\page qtsensors-cpp.html
-\title QtSensors C++ API
-\brief Information about the QtSensors C++ API
+\title Qt Sensors C++ API
+\brief Information about the Qt Sensors C++ API
\tableofcontents
\section1 Sensor Types
-On a device there can be many types of sensors. Not all of the types that the QtSensors API
+On a device there can be many types of sensors. Not all of the types that the Qt Sensors API
supports may be available. There may also be types available that are not defined in the
-QtSensors API. The types of sensors available on a device is found using the
+Qt Sensors API. The types of sensors available on a device is found using the
\l QSensor::sensorTypes() function.
For a list of built-in sensor types, see the \l{Sensor Classes} section below.
\section1 Common Conventions
-Unless otherwise specified, QtSensors uses the
+Unless otherwise specified, Qt Sensors uses the
\l{http://en.wikipedia.org/wiki/Cartesian_coordinate_system}{Right Hand Cartesian coordinate system}.
\image sensors-coordinates.jpg
@@ -106,7 +106,7 @@ shows you information about available sensors.
\section1 Front end, back end
-The QtSensors API has a front end, for application developers to use and a back end,
+The Qt Sensors API has a front end, for application developers to use and a back end,
where device implementors write code to access their hardware. As an application
developer you do not need to access the back end though it may be useful to understand
how it works.
@@ -116,11 +116,11 @@ device plugin. Data comes back through the QSensorReading class.
\image sensors-overview.png
-More information about the back end can be found in \l{QtSensors Backend}.
+More information about the back end can be found in \l{Qt Sensors Backend}.
\section1 Main Classes
-The primary classes that make up the QtSensors API.
+The primary classes that make up the Qt Sensors API.
\annotatedlist sensors_main
@@ -133,7 +133,7 @@ The best way to access sensor data is via one of these classes.
\section1 Sensor Classes
These classes provide convenience wrappers that reduce the need for casting.
-Each of these classes represents a sensor type that the QtSensors API knows
+Each of these classes represents a sensor type that the Qt Sensors API knows
about. Note that additional types may be made available at run-time. See
\l{Sensor Types} for more information.
diff --git a/doc/src/qtsensors.qdoc b/doc/src/qtsensors.qdoc
index 9a9a2b4b..e19570fd 100644
--- a/doc/src/qtsensors.qdoc
+++ b/doc/src/qtsensors.qdoc
@@ -28,33 +28,33 @@
/*!
\page qtsensors.html
\title Qt Sensors
- \brief The QtSensors API provides access to sensors via QML and C++ interfaces.
+ \brief The Qt Sensors API provides access to sensors via QML and C++ interfaces.
\ingroup technology-apis
- The QtSensors API provides access to sensors via QML and C++ interfaces.
+ The Qt Sensors API provides access to sensors via QML and C++ interfaces.
\section1 Information for Application Writers
- Applications can access QtSensors using QML or C++.
+ Applications can access Qt Sensors using QML or C++.
\table
\row
- \o \l {QtSensors 5.x}{QML API}
- \o Information about the QtSensors QML API
+ \o \l {Qt Sensors QML API}{QML API}
+ \o Information about the Qt Sensors QML API
\row
- \o \l {QtSensors C++ API}{C++ API}
- \o Information about the QtSensors C++ API
+ \o \l {Qt Sensors C++ API}{C++ API}
+ \o Information about the Qt Sensors C++ API
\row
- \o \l {QtSensors Examples}{Examples}
- \o Examples demonstrating use of the QtSensors APIs
+ \o \l {Qt Sensors Examples}{Examples}
+ \o Examples demonstrating use of the Qt Sensors APIs
\endtable
\section1 Information for Backend Implementors
\table
\row
- \o \l {QtSensors Backend}{Backend}
- \o Information about the QtSensors back end
+ \o \l {Qt Sensors Backend}{Backend}
+ \o Information about the Qt Sensors back end
\row
\o \l {Grue Sensor Example}
\o The Grue Sensor Example demonstrates creation of a sensor backend
@@ -62,41 +62,41 @@
\section1 Compatibility with QtMobility Sensors API
- QtSensors 5.0 (the initial release) is generally expected to be source compatible
+ Qt Sensors 5.0 (the initial release) is generally expected to be source compatible
with QtMobility Sensors 1.2.
\table
\row
- \o \l {Porting Applications from QtMobility Sensors to QtSensors}{Porting Guide}
- \o Information about the steps needed to port applications to the QtSensors API.
+ \o \l {Porting Applications from QtMobility Sensors to Qt Sensors}{Porting Guide}
+ \o Information about the steps needed to port applications to the Qt Sensors API.
\row
\o \l {QtMobility.sensors 1.x}{Legacy QML API}
\o Information about the legacy QtMobility.sensors QML API
\endtable
- \section1 Information for QtSensorGestures API
+ \section1 Information for Qt SensorGestures API
- QtSensorGestures provides a motion gesture recognition API for devices.
+ Qt SensorGestures provides a motion gesture recognition API for devices.
\table
\row
\o \l {SensorGesture}{QML API}
- \o Information about the QtSensorGestures QML API
+ \o Information about the Qt SensorGestures QML API
\row
\o \l {QtSensorGestures C++ API}{C++ API}
- \o Information about the QtSensorGestures C++ API
+ \o Information about the Qt SensorGestures C++ API
\endtable
- \section1 Information for QtSensorGestures Recognizer Plugin Implementors.
+ \section1 Information for Qt SensorGestures Recognizer Plugin Implementors.
\table
\row
\o \l {QtSensorGestures Plugins}{Plugins}
- \o Information about the QtSensorGestures recognizer plugins.
+ \o Information about the Qt SensorGestures recognizer plugins.
\row
\o \l {QtSensorGestures Emulator}{Emulator}
- \o Information about QtSensorGestures use in the Emulator.
+ \o Information about Qt SensorGestures use in the Emulator.
\endtable
*/
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-19 23:50:50 +0000