From b1a321a1d7762e8c20e244164bd42822c3bd0310 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Sat, 20 Apr 2013 01:14:53 +0800 Subject: [PATCH] Doc: Create links to Qt Quick 1 Point to the porting guide, so that users who search for the old names will be directed to an explanation of the name change. Also made some new links to Qt Quick 2, and changed "favour" -> "favor" (Sanity Bot complained) Change-Id: If30c8d619d8fdb9df72b7b5f3efd356f1e07b23a Reviewed-by: Jerome Pasion --- src/qml/doc/src/whatsnew.qdoc | 2 +- src/qml/qml/qqmlcomponent.cpp | 2 +- src/qml/qml/qqmlengine.cpp | 2 +- src/qml/qml/qqmlerror.cpp | 2 +- src/qml/qml/qqmlexpression.cpp | 2 +- src/qml/qml/qqmlextensionplugin.cpp | 2 +- src/qml/qml/qqmllist.cpp | 4 ++-- src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp | 2 +- src/qml/qml/qqmlparserstatus.cpp | 2 +- src/qml/qml/qqmlproperty.cpp | 2 +- src/qml/qml/v8/qqmlbuiltinfunctions.cpp | 4 ++-- src/quick/doc/src/appdevguide/porting.qdoc | 8 +++++--- src/quick/doc/src/whatsnew.qdoc | 14 +++++++------- src/quick/items/qquickpositioners.cpp | 8 ++++---- src/quick/items/qquickview.cpp | 2 +- src/quick/util/qquickimageprovider.cpp | 2 +- 16 files changed, 31 insertions(+), 29 deletions(-) diff --git a/src/qml/doc/src/whatsnew.qdoc b/src/qml/doc/src/whatsnew.qdoc index e561ec5..3ede480 100644 --- a/src/qml/doc/src/whatsnew.qdoc +++ b/src/qml/doc/src/whatsnew.qdoc @@ -34,7 +34,7 @@ The \l{Qt QML} module is new in Qt 5.0. It provides the QML engine and implements the QML language supporting infrastructure. -(Prior to Qt 5, this functionality was provided by the \c QtDeclarative module, which +(Prior to Qt 5, this functionality was provided by the \l {Qt Quick 1}{QtDeclarative} module, which has now been replaced by the new \l {Qt QML} and \l {Qt Quick} C++ modules. See the \l {Porting QML Applications to Qt 5} for more information.) diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp index aadcbd0..7cf7c54 100644 --- a/src/qml/qml/qqmlcomponent.cpp +++ b/src/qml/qml/qqmlcomponent.cpp @@ -186,7 +186,7 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject) } \endcode - Note that the Qt Quick 1 version is named QDeclarativeComponent. + Note that the \l {Qt Quick 1} version is named QDeclarativeComponent. */ /*! diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp index 5dda7ea..5fa5cfd 100644 --- a/src/qml/qml/qqmlengine.cpp +++ b/src/qml/qml/qqmlengine.cpp @@ -800,7 +800,7 @@ QQuickWorkerScriptEngine *QQmlEnginePrivate::getWorkerScriptEngine() In this case, the Text item will be created in the engine's \l {QQmlEngine::rootContext()}{root context}. - Note that the Qt Quick 1 version is called QDeclarativeEngine. + Note that the \l {Qt Quick 1} version is called QDeclarativeEngine. \sa QQmlComponent, QQmlContext */ diff --git a/src/qml/qml/qqmlerror.cpp b/src/qml/qml/qqmlerror.cpp index 96e867d..98d8259 100644 --- a/src/qml/qml/qqmlerror.cpp +++ b/src/qml/qml/qqmlerror.cpp @@ -71,7 +71,7 @@ QT_BEGIN_NAMESPACE ^ \endcode - Note that the Qt Quick 1 version is named QDeclarativeError + Note that the \l {Qt Quick 1} version is named QDeclarativeError \sa QQuickView::errors(), QQmlComponent::errors() */ diff --git a/src/qml/qml/qqmlexpression.cpp b/src/qml/qml/qqmlexpression.cpp index c35a495..accc645 100644 --- a/src/qml/qml/qqmlexpression.cpp +++ b/src/qml/qml/qqmlexpression.cpp @@ -162,7 +162,7 @@ QQmlExpressionPrivate::create(QQmlContextData *ctxt, QObject *object, int result = expr->evaluate().toInt(); // result = 400 \endcode - Note that the Qt Quick 1 version is called QDeclarativeExpression. + Note that the \l {Qt Quick 1} version is called QDeclarativeExpression. */ /*! diff --git a/src/qml/qml/qqmlextensionplugin.cpp b/src/qml/qml/qqmlextensionplugin.cpp index 827b9da..babdd6e 100644 --- a/src/qml/qml/qqmlextensionplugin.cpp +++ b/src/qml/qml/qqmlextensionplugin.cpp @@ -121,7 +121,7 @@ QT_BEGIN_NAMESPACE The \l {Writing QML Extensions with C++} tutorial also contains a chapter on creating QML plugins. - Note that the Qt Quick 1 version is called QDeclarativeExtensionPlugin. + Note that the \l {Qt Quick 1} version is called QDeclarativeExtensionPlugin. \sa QQmlEngine::importPlugin(), {How to Create Qt Plugins} */ diff --git a/src/qml/qml/qqmllist.cpp b/src/qml/qml/qqmllist.cpp index 57f9577..91c9bc2 100644 --- a/src/qml/qml/qqmllist.cpp +++ b/src/qml/qml/qqmllist.cpp @@ -112,7 +112,7 @@ Attempting to add objects of the incorrect type to a list property will fail. Like with normal lists, when accessing a list element by index, it is the callers responsibility to ensure that it does not request an out of range element using the count() method before calling at(). -The Qt Quick 1 version of this class is named QDeclarativeListReference. +The \l {Qt Quick 1} version of this class is named QDeclarativeListReference. */ /*! @@ -369,7 +369,7 @@ Q_PROPERTY(QQmlListProperty fruit READ fruit); QML list properties are typesafe - in this case \c {Fruit} is a QObject type that \c {Apple}, \c {Orange} and \c {Banana} all derive from. -The Qt Quick 1 version of this class is named QDeclarativeListProperty. +The \l {Qt Quick 1} version of this class is named QDeclarativeListProperty. \note QQmlListProperty can only be used for lists of QObject-derived object pointers. */ diff --git a/src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp b/src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp index 02b22be..b0271b1 100644 --- a/src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp +++ b/src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp @@ -80,7 +80,7 @@ QT_BEGIN_NAMESPACE For more information about signals and threads, see \l {Threads and QObjects} and \l {Signals and Slots Across Threads}. - The Qt Quick 1 version of this class is named QDeclarativeNetworkAccessManagerFactory. + The \l {Qt Quick 1} version of this class is named QDeclarativeNetworkAccessManagerFactory. \sa {qml/networkaccessmanagerfactory}{NetworkAccessManagerFactory example} */ diff --git a/src/qml/qml/qqmlparserstatus.cpp b/src/qml/qml/qqmlparserstatus.cpp index 4f4f2b7..41b7d96 100644 --- a/src/qml/qml/qqmlparserstatus.cpp +++ b/src/qml/qml/qqmlparserstatus.cpp @@ -84,7 +84,7 @@ QT_BEGIN_NAMESPACE } \endcode - The Qt Quick 1 version of this class is named QDeclarativeParserStatus. + The \l {Qt Quick 1} version of this class is named QDeclarativeParserStatus. */ /*! \internal */ diff --git a/src/qml/qml/qqmlproperty.cpp b/src/qml/qml/qqmlproperty.cpp index ee06d3b..0baf450 100644 --- a/src/qml/qml/qqmlproperty.cpp +++ b/src/qml/qml/qqmlproperty.cpp @@ -112,7 +112,7 @@ property.write(24); qWarning() << "Pixel size should now be 24:" << property.read().toInt(); \endcode -The Qt Quick 1 version of this class was named QDeclarativeProperty. +The \l {Qt Quick 1} version of this class was named QDeclarativeProperty. */ /*! diff --git a/src/qml/qml/v8/qqmlbuiltinfunctions.cpp b/src/qml/qml/v8/qqmlbuiltinfunctions.cpp index 1be2a0b..b5f4bf5 100644 --- a/src/qml/qml/v8/qqmlbuiltinfunctions.cpp +++ b/src/qml/qml/v8/qqmlbuiltinfunctions.cpp @@ -1634,9 +1634,9 @@ v8::Handle locale(const v8::Arguments &args) \snippet qml/qtBinding.4.qml 0 - Note: in \c {QtQuick 1.x}, all function assignment was treated as + \note In \l {Qt Quick 1}, all function assignment was treated as binding assignment, so the Qt.binding() function is new in - \c {QtQuick 2.0}. + \l {Qt Quick}{Qt Quick 2}. \since QtQuick 2.0 */ diff --git a/src/quick/doc/src/appdevguide/porting.qdoc b/src/quick/doc/src/appdevguide/porting.qdoc index eac50a9..fa7476f 100644 --- a/src/quick/doc/src/appdevguide/porting.qdoc +++ b/src/quick/doc/src/appdevguide/porting.qdoc @@ -77,7 +77,7 @@ into a \c QtQuick.LocalStorage singleton type. Any code that requires the local \e {QtQuick.LocalStorage} instead. See the \l {QtQuick.LocalStorage 2}{QtQuick.LocalStorage} documentation for examples. \li The \c LayoutItem type has been removed from the \c QtQuick module as it was specific to the -Graphics View framework backend used in \c {QtQuick 1}. +Graphics View framework backend used in \l {Qt Quick 1}. \endlist \section2 Behavioral Changes @@ -138,7 +138,7 @@ ShaderEffectItem type has been renamed to \l ShaderEffect. In Qt 5, all QML applications are rendered with an OpenGL scenegraph architecture rather than the Graphics View framework used in Qt 4. Due to the scale of this architectural change, the C++ API has -been extensively restructured and the \c QtDeclarative module has been deprecated in favour of two +been extensively restructured and the \c QtDeclarative module has been deprecated in favor of two new modules: \l {Qt QML}, which implements the QML engine and language infrastructure, and \l {Qt Quick}, which implements the visual canvas and scenegraph backend. @@ -192,7 +192,7 @@ Required header files can then be included: \endcode (The \c QtDeclarative module is still available to developers as the \c {Qt Quick 1} module, as -discussed in \l{Using the QtDeclarative module in Qt 5}{below}. However, it should not be used for +discussed \l {Qt Quick 1}{below}. However, it should not be used for new applications.) @@ -232,6 +232,8 @@ See the updated \l {qtqml-modules-cppplugins.html}{Creating C++ Plugins For QML} an overview of creating QML plugins in Qt 5. +\keyword Qt Quick 1 + \section2 QtDeclarative module in Qt 5 For the purposes of porting older applications, the \c {QtDeclarative} module is still available in Qt diff --git a/src/quick/doc/src/whatsnew.qdoc b/src/quick/doc/src/whatsnew.qdoc index 18ffff5..174fa22 100644 --- a/src/quick/doc/src/whatsnew.qdoc +++ b/src/quick/doc/src/whatsnew.qdoc @@ -31,11 +31,11 @@ \section1 Qt 5.0 - Qt Quick C++ Module -The Qt Quick C++ module is new in Qt 5. It provides the visual canvas and scenegraph back-end -as well as the QtQuick QML module for QML application development. +The \l {Qt Quick} C++ module is new in Qt 5. It provides the visual canvas and scenegraph back-end +as well as the \c QtQuick QML module for QML application development. As of Qt 5, the \l {Qt Quick} module is based on an OpenGL scenegraph. Many of the classes in -the Qt Quick module have been ported from the \c QtDeclarative module from Qt 4.8 to use +the \l {Qt Quick} module have been ported from the \l {Qt Quick 1}{QtDeclarative} module from Qt 4.8 to use the scenegraph architecture; these classes have been renamed to use a \c QQuick* prefix. (See the \l {Porting QML Applications to Qt 5} for porting information.) @@ -344,11 +344,11 @@ the window loses focus. \section2 Property types Support for various math and geometry-related value types, including QVector2D, QVector3D, QVector4D, -QMatrix4x4 and QQuaternion, as well as QColor and QFont, are now provided by Qt Quick. Properties of +QMatrix4x4 and QQuaternion, as well as QColor and QFont, are now provided by \l {Qt Quick}. Properties of these types can be declared in QML documents via the property syntax where the type name is \c vector2d, \c vector3d, \c vector4d, \c matrix4x4, \c quaternion, \c color and \c font respectively. -Qt Quick also provides implementation for the various value type factory or utility functions of the +\l {Qt Quick} also provides implementation for the various value type factory or utility functions of the \c Qt object which return or operate on values of the above types. The functions are: \table \header @@ -385,8 +385,8 @@ Qt Quick also provides implementation for the various value type factory or util \endtable The \c Qt.rgba(), \c Qt.hsla(), \c Qt.tint(), \c Qt.lighter(), \c Qt.darker() -and \c Qt.fontFamilies() functions already existed in \c QtDeclarative prior -to \c {QtQuick 2.0}; the other functions are all new in \c {QtQuick 2.0}. +and \c Qt.fontFamilies() functions already existed in \l {Qt Quick 1}{QtDeclarative} prior +to \l {Qt Quick}{Qt Quick 2}; the other functions are all new in \l {Qt Quick}{Qt Quick 2}. \section1 Qt 5.0 - Additional QML Modules diff --git a/src/quick/items/qquickpositioners.cpp b/src/quick/items/qquickpositioners.cpp index f2c0b94..66f4b44 100644 --- a/src/quick/items/qquickpositioners.cpp +++ b/src/quick/items/qquickpositioners.cpp @@ -700,7 +700,7 @@ void QQuickPositionerAttached::setIsLastItem(bool isLastItem) cases, these lists will be empty. See the \l ViewTransition documentation for more details and examples on using these transitions. - \note In Qt Quick 1, this transition was applied to all items that were part of the + \note In \l {Qt Quick 1}, this transition was applied to all items that were part of the positioner at the time of its creation. From \l {Qt Quick}{Qt Quick 2} onwards, positioners apply the \l populate transition to these items instead. @@ -854,7 +854,7 @@ void QQuickColumn::reportConflictingAnchors() cases, these lists will be empty. See the \l ViewTransition documentation for more details and examples on using these transitions. - \note In Qt Quick 1, this transition was applied to all items that were part of the + \note In \l {Qt Quick 1}, this transition was applied to all items that were part of the positioner at the time of its creation. From \l {Qt Quick}{QtQuick 2} onwards, positioners apply the \l populate transition to these items instead. @@ -1087,7 +1087,7 @@ void QQuickRow::reportConflictingAnchors() cases, these lists will be empty. See the \l ViewTransition documentation for more details and examples on using these transitions. - \note In Qt Quick 1, this transition was applied to all items that were part of the + \note In \l {Qt Quick 1}, this transition was applied to all items that were part of the positioner at the time of its creation. From \l {Qt Quick}{QtQuick 2} onwards, positioners apply the \l populate transition to these items instead. @@ -1628,7 +1628,7 @@ void QQuickGrid::reportConflictingAnchors() cases, these lists will be empty. See the \l ViewTransition documentation for more details and examples on using these transitions. - \note In Qt Quick 1, this transition was applied to all items that were part of the + \note In \l {Qt Quick 1}, this transition was applied to all items that were part of the positioner at the time of its creation. From \l {Qt Quick}{QtQuick 2} onwards, positioners apply the \l populate transition to these items instead. diff --git a/src/quick/items/qquickview.cpp b/src/quick/items/qquickview.cpp index 65343cd..cc32c40 100644 --- a/src/quick/items/qquickview.cpp +++ b/src/quick/items/qquickview.cpp @@ -494,7 +494,7 @@ void QQuickViewPrivate::setRootObject(QObject *obj) << "loaded has 'import QtQuick 1.0' or 'import Qt 4.7', this error will occur." << endl << endl << "To load files with 'import QtQuick 1.0' or 'import Qt 4.7', use the" << endl - << "QDeclarativeView class in the qtquick1 module." << endl; + << "QDeclarativeView class in the Qt Quick 1 module." << endl; delete obj; root = 0; } diff --git a/src/quick/util/qquickimageprovider.cpp b/src/quick/util/qquickimageprovider.cpp index 2073bdc..cd0005d 100644 --- a/src/quick/util/qquickimageprovider.cpp +++ b/src/quick/util/qquickimageprovider.cpp @@ -242,7 +242,7 @@ QImage QQuickTextureFactory::image() const \c cache property to \c false for the relevant \l Image, \l BorderImage or \l AnimatedImage object. - The Qt Quick 1 version of this class is named QDeclarativeImageProvider. + The \l {Qt Quick 1} version of this class is named QDeclarativeImageProvider. \sa QQmlEngine::addImageProvider() */ -- 1.7.2.5