From be4e63b220108a959f1d016403aa95389060630e Mon Sep 17 00:00:00 2001 From: Lincoln Ramsay Date: Fri, 17 Aug 2012 12:02:20 +1000 Subject: Rename QtMobility.sensors 1.3 to QtSensors 5.0 Change-Id: I2b24533d38db1f8e205de19b67fe0b21625bbf6b Reviewed-by: Lorn Potter --- doc/src/examples/cubehouse.qdoc | 4 +- doc/src/examples/qmlqtsensors.qdoc | 6 +-- doc/src/imports/qtmobilitysensors1.qdoc | 72 --------------------------------- doc/src/imports/qtsensors5.qdoc | 69 +++++++++++++++++++++++++++++++ doc/src/porting.qdoc | 8 +++- doc/src/qtsensors.qdoc | 5 +-- 6 files changed, 81 insertions(+), 83 deletions(-) delete mode 100644 doc/src/imports/qtmobilitysensors1.qdoc create mode 100644 doc/src/imports/qtsensors5.qdoc (limited to 'doc/src') diff --git a/doc/src/examples/cubehouse.qdoc b/doc/src/examples/cubehouse.qdoc index 31bad85c..37d5fe28 100644 --- a/doc/src/examples/cubehouse.qdoc +++ b/doc/src/examples/cubehouse.qdoc @@ -33,9 +33,9 @@ \image cubehouse.png \section1 Overview - To write a QML application that will use the QML Accelerometer type from the QtMobility.sensors import you need to to the following steps: + To write a QML application that will use the QML Accelerometer type from the QtSensors import you need to to the following steps: - Import the QtMobility.sensors declarative plugin: + Import the QtSensors declarative plugin: \snippet ../examples/sensors/cubehouse/cubehouse.qml 0 diff --git a/doc/src/examples/qmlqtsensors.qdoc b/doc/src/examples/qmlqtsensors.qdoc index 4016fc44..ed6c99f4 100644 --- a/doc/src/examples/qmlqtsensors.qdoc +++ b/doc/src/examples/qmlqtsensors.qdoc @@ -54,16 +54,16 @@ Reading the data can be done for each sensor type like following: - \l {QtMobility.sensors1::TiltSensor} {TiltSensor} + \l {QtSensors::TiltSensor} {TiltSensor} \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 3 \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 4 - \l {QtMobility.sensors1::AmbientLightSensor} {AmbientLightSensor} + \l {QtSensors::AmbientLightSensor} {AmbientLightSensor} \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 5 - \l {QtMobility.sensors1::ProximitySensor} {ProximitySensor} + \l {QtSensors::ProximitySensor} {ProximitySensor} \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 6 */ diff --git a/doc/src/imports/qtmobilitysensors1.qdoc b/doc/src/imports/qtmobilitysensors1.qdoc deleted file mode 100644 index e040413c..00000000 --- a/doc/src/imports/qtmobilitysensors1.qdoc +++ /dev/null @@ -1,72 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \qmlmodule QtMobility.sensors 1.3 - \title QtMobility.sensors 1.x - \brief Legacy QML import for QtSensors - - \section1 Overview - - This is the legacy QML import. It exists for compatibility with the QtMobiltiy 1.2 release - and is not recommended for new applications. - - See \l{Qt Sensors} for more information about the Sensors API. - - \section1 QML Module API - - If the module is imported into a namespace, some additional methods become available. - - \code - import QtMobility.sensors 1.3 as Sensors - ... - Component.onCompleted: { - var types = Sensors.sensorTypes(); - console.log(types.join(", ")); - } - \endcode - - The documentation for the module API can be found in SensorGlobal. - - \section1 QML Sensor types - - These types represent specific types of sensors. - - Note that most properties come from the abstract \l{QtMobility.sensors1::Sensor}{Sensor} element. - - \annotatedlist qml-sensors_type - - \section1 QML Reading types - - The data from a sensor comes through a reading class. - - \annotatedlist qml-sensors_reading - - \section1 Alphabetical Listing of QML Types - -*/ - diff --git a/doc/src/imports/qtsensors5.qdoc b/doc/src/imports/qtsensors5.qdoc new file mode 100644 index 00000000..02b53603 --- /dev/null +++ b/doc/src/imports/qtsensors5.qdoc @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmlmodule QtSensors 5.0 + \title Qt Sensors QML API + \brief QML import for QtSensors + + \section1 Overview + + This is the QtSensors QML import. + + \section1 QML Module API + + If the module is imported into a namespace, some additional methods become available. + + \code + import QtSensors 5.0 as Sensors + ... + Component.onCompleted: { + var types = Sensors.sensorTypes(); + console.log(types.join(", ")); + } + \endcode + + The documentation for the module API can be found in SensorGlobal. + + \section1 QML Sensor types + + These types represent specific types of sensors. + + Note that most properties come from the abstract \l{QtSensors::Sensor}{Sensor} element. + + \annotatedlist qml-sensors_type + + \section1 QML Reading types + + The data from a sensor comes through a reading class. + + \annotatedlist qml-sensors_reading + + \section1 Alphabetical Listing of QML Types + +*/ + diff --git a/doc/src/porting.qdoc b/doc/src/porting.qdoc index 9a3ff716..24e0d7e6 100644 --- a/doc/src/porting.qdoc +++ b/doc/src/porting.qdoc @@ -39,8 +39,12 @@ \section1 QML - QtSensors ships with a QML import that is mostly compatible with the QtMobility.sensors import. - See \l {QtMobility.sensors 1.x} for more information. + QtSensors ships with a QML import that is compatible with the QtMobility.sensors import. + The limitations of the QtMobility.sensors import have been fixed and some new properties + may exist so apps may need to be updated if they are using custom properties on their + sensor objects. + + See \l {Qt Sensors QML API} for more information. \section1 C++ diff --git a/doc/src/qtsensors.qdoc b/doc/src/qtsensors.qdoc index 0ab598e0..b437da28 100644 --- a/doc/src/qtsensors.qdoc +++ b/doc/src/qtsensors.qdoc @@ -39,7 +39,7 @@ \table \row - \li \l {QtMobility.sensors 1.x}{QML API} + \li \l {Qt Sensors QML API}{QML API} \li Information about the Qt Sensors QML API \row \li \l {Qt Sensors C++ API}{C++ API} @@ -69,9 +69,6 @@ \row \li \l {Porting Applications from QtMobility Sensors to Qt Sensors}{Porting Guide} \li Information about the steps needed to port applications to the Qt Sensors API. - \row - \li \l {QtMobility.sensors 1.x}{Legacy QML API} - \li Information about the legacy QtMobility.sensors QML API \endtable -- cgit v1.2.3