From 61b4e90a0fe3d864ac03be2a318d7eec74e3cf0a Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Tue, 23 Apr 2013 22:19:05 +0800 Subject: [PATCH] Doc: Qt Quick: Fix module name format (Pt 2/2) Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation Attempt to differentiate between the whole module ("Qt Quick") and the QML import ("QtQuick") by encoding the latter with monospace font. There are places in the text where both representations are valid. Change-Id: If398304757e0a5106542c09099e1814084e54c5c Reviewed-by: Jerome Pasion --- src/imports/widgets/widgetsplugin.cpp | 2 +- src/plugins/accessible/shared/qqmlaccessible.h | 4 ++-- src/qml/doc/src/cppintegration/definetypes.qdoc | 4 ++-- src/qml/doc/src/javascript/dynamicobjectcreation.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/qqmlglobal_p.h | 2 +- src/qml/qml/qqmllist.cpp | 4 ++-- src/qml/qml/qqmllocale.cpp | 2 +- src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp | 2 +- src/qml/qml/qqmlproperty.cpp | 2 +- src/quick/doc/src/appdevguide/glossary.qdoc | 4 ++-- src/quick/doc/src/appdevguide/porting.qdoc | 4 ++-- src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc | 2 +- src/quick/doc/src/qmltypereference.qdoc | 2 +- src/quick/doc/src/whatsnew.qdoc | 8 ++++---- src/quick/items/context2d/qquickcanvasitem.cpp | 2 +- src/quick/util/qquickimageprovider.cpp | 2 +- 21 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/imports/widgets/widgetsplugin.cpp b/src/imports/widgets/widgetsplugin.cpp index a29c9b3..be9d59f 100644 --- a/src/imports/widgets/widgetsplugin.cpp +++ b/src/imports/widgets/widgetsplugin.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \brief Provides QML types for certain QWidgets \internal - This QML module contains types which should not be depended upon in QtQuick + This QML module contains types which should not be depended upon in Qt Quick applications, but are available if the Widgets module is linked. It is recommended to load components from this module conditionally, if at all, and to provide fallback implementations in case they fail to load. diff --git a/src/plugins/accessible/shared/qqmlaccessible.h b/src/plugins/accessible/shared/qqmlaccessible.h index c6ac4e4..5280c78 100644 --- a/src/plugins/accessible/shared/qqmlaccessible.h +++ b/src/plugins/accessible/shared/qqmlaccessible.h @@ -54,8 +54,8 @@ QT_BEGIN_NAMESPACE -- Declarative Accessibility Overview. -- * Item interface classes: - QAccessibleDeclarativeItem for QtQuick1 - QAccessibleQuickItem for for QtQuick2 + QAccessibleDeclarativeItem for Qt Quick 1 + QAccessibleQuickItem for for Qt Quick 2 Common base class: QQmlAccessible * View interface classes. diff --git a/src/qml/doc/src/cppintegration/definetypes.qdoc b/src/qml/doc/src/cppintegration/definetypes.qdoc index af7aed2..1aab159 100644 --- a/src/qml/doc/src/cppintegration/definetypes.qdoc +++ b/src/qml/doc/src/cppintegration/definetypes.qdoc @@ -675,7 +675,7 @@ to be declared for an item without explicitly assigning them to the \l{Item::}{children} property.) -\section2 Defining Visual Items with the QtQuick Module +\section2 Defining Visual Items with the Qt Quick Module When building user interfaces with the \l {Qt Quick} module, all QML objects that are to be visually rendered must derive from the \l Item type, as it is the base @@ -687,7 +687,7 @@ QML-based user interface. See the QQuickItem documentation for more information. Additionally, the \l{Writing QML Extensions with C++} tutorial demonstrates how a QQuickItem-based -visual item can be implemented in C++ and integrated into a QtQuick-based user +visual item can be implemented in C++ and integrated into a Qt Quick-based user interface. diff --git a/src/qml/doc/src/javascript/dynamicobjectcreation.qdoc b/src/qml/doc/src/javascript/dynamicobjectcreation.qdoc index 27fcc7b..421b180 100644 --- a/src/qml/doc/src/javascript/dynamicobjectcreation.qdoc +++ b/src/qml/doc/src/javascript/dynamicobjectcreation.qdoc @@ -109,7 +109,7 @@ the \c finishCreation() function and call \l {Component::createObject()} Notice in both instances, \l {Component::createObject()}{createObject()} is called with \c appWindow passed as the parent argument, since the dynamically -created object is a visual (QtQuick) object. The created object will become a +created object is a visual (Qt Quick) object. The created object will become a child of the \c appWindow object in \c main.qml, and appear in the scene. When using files with relative paths, the path should diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp index 2ad887a..aadcbd0 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 QtQuick 1 version is named QDeclarativeComponent. + Note that the Qt Quick 1 version is named QDeclarativeComponent. */ /*! diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp index 63f579e..5dda7ea 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 QtQuick 1 version is called QDeclarativeEngine. + Note that the 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 88129b7..96e867d 100644 --- a/src/qml/qml/qqmlerror.cpp +++ b/src/qml/qml/qqmlerror.cpp @@ -71,7 +71,7 @@ QT_BEGIN_NAMESPACE ^ \endcode - Note that the QtQuick 1 version is named QDeclarativeError + Note that the 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 3bc0c50..c35a495 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 QtQuick 1 version is called QDeclarativeExpression. + Note that the Qt Quick 1 version is called QDeclarativeExpression. */ /*! diff --git a/src/qml/qml/qqmlextensionplugin.cpp b/src/qml/qml/qqmlextensionplugin.cpp index edef5a9..827b9da 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 QtQuick 1 version is called QDeclarativeExtensionPlugin. + Note that the Qt Quick 1 version is called QDeclarativeExtensionPlugin. \sa QQmlEngine::importPlugin(), {How to Create Qt Plugins} */ diff --git a/src/qml/qml/qqmlglobal_p.h b/src/qml/qml/qqmlglobal_p.h index 6ca54f6..19139ce 100644 --- a/src/qml/qml/qqmlglobal_p.h +++ b/src/qml/qml/qqmlglobal_p.h @@ -317,7 +317,7 @@ class QQmlApplicationPrivate; class Q_QML_PRIVATE_EXPORT QQmlApplication : public QObject { - //Application level logic, subclassed by QtQuick if available via QQmlGuiProvider + //Application level logic, subclassed by Qt Quick if available via QQmlGuiProvider Q_OBJECT Q_PROPERTY(QStringList arguments READ args CONSTANT) Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged) diff --git a/src/qml/qml/qqmllist.cpp b/src/qml/qml/qqmllist.cpp index e6913f0..57f9577 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 QtQuick 1 version of this class is named QDeclarativeListReference. +The 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 QtQuick 1 version of this class is named QDeclarativeListProperty. +The 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/qqmllocale.cpp b/src/qml/qml/qqmllocale.cpp index 018c55a..15ddcc7 100644 --- a/src/qml/qml/qqmllocale.cpp +++ b/src/qml/qml/qqmllocale.cpp @@ -812,7 +812,7 @@ V8_DEFINE_EXTENSION(QV8LocaleDataDeletable, localeV8Data); } \endcode - QtQuick Locale's data is based on Common Locale Data Repository v1.8.1. + Qt Quick Locale's data is based on Common Locale Data Repository v1.8.1. \target FormatType diff --git a/src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp b/src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp index 156c341..02b22be 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 QtQuick 1 version of this class is named QDeclarativeNetworkAccessManagerFactory. + The Qt Quick 1 version of this class is named QDeclarativeNetworkAccessManagerFactory. \sa {qml/networkaccessmanagerfactory}{NetworkAccessManagerFactory example} */ diff --git a/src/qml/qml/qqmlproperty.cpp b/src/qml/qml/qqmlproperty.cpp index fa728fe..ee06d3b 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 QtQuick 1 version of this class was named QDeclarativeProperty. +The Qt Quick 1 version of this class was named QDeclarativeProperty. */ /*! diff --git a/src/quick/doc/src/appdevguide/glossary.qdoc b/src/quick/doc/src/appdevguide/glossary.qdoc index 2ece382..3c02918 100644 --- a/src/quick/doc/src/appdevguide/glossary.qdoc +++ b/src/quick/doc/src/appdevguide/glossary.qdoc @@ -28,7 +28,7 @@ /*! \page qtquick-glossary.html \title Qt Quick Glossary Of Terms -\brief Glossary of terms used in the documentation for QML and QtQuick +\brief Glossary of terms used in the documentation for QML and Qt Quick \section1 Common Terms @@ -56,7 +56,7 @@ The QML language provides a number of built in (\l{qtqml-typesystem-basictypes.html}{basic types}), and the - QtQuick module provides various \l{qtquick-qmltypereference.html} + Qt Quick module provides various \l{qtquick-qmltypereference.html} {Qt Quick types} for building QML applications. Types can also be provided by third-party developers through (\l{qtqml-modules-topic.html}{modules}) or by the application diff --git a/src/quick/doc/src/appdevguide/porting.qdoc b/src/quick/doc/src/appdevguide/porting.qdoc index c560a5c..eac50a9 100644 --- a/src/quick/doc/src/appdevguide/porting.qdoc +++ b/src/quick/doc/src/appdevguide/porting.qdoc @@ -149,7 +149,7 @@ locations. The class name changes are as follows: \table \header \li Qt QML - \li QtQuick + \li Qt Quick \row \li \list @@ -245,7 +245,7 @@ To use the \c {Qt Quick 1} module, add "quick1" to your qmake \c .pro file: QT += quick1 \endcode -Required header files can be included from the QtQuick 1 module: +Required header files can be included from the Qt Quick 1 module: \code #include diff --git a/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc b/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc index 7b8d66f..7310d25 100644 --- a/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc +++ b/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc @@ -28,7 +28,7 @@ /*! \page qtquick-modelviewsdata-cppmodels.html \title Using C++ Models with Qt Quick Views -\brief using QtQuick views with models defined in C++ +\brief using Qt Quick views with models defined in C++ \section1 Data Provided In A Custom C++ Model diff --git a/src/quick/doc/src/qmltypereference.qdoc b/src/quick/doc/src/qmltypereference.qdoc index 413d5aa..43d6b95 100644 --- a/src/quick/doc/src/qmltypereference.qdoc +++ b/src/quick/doc/src/qmltypereference.qdoc @@ -259,7 +259,7 @@ Data Storage \li \l {ShaderEffect} - Allows GLSL shaders to be used as graphical effects \li \l {ShaderEffectSource} - Usable as a texture in ShaderEffect \li \l {GridMesh} - Generates a grid mesh of vertices for use by ShaderEffect -\li The \l{QtQuick.Particles 2} module provides a set of Particle System types for QtQuick 2 +\li The \l{QtQuick.Particles 2} module provides a set of Particle System types for Qt Quick 2 \endlist \section2 Convenience Types diff --git a/src/quick/doc/src/whatsnew.qdoc b/src/quick/doc/src/whatsnew.qdoc index c6f1196..18ffff5 100644 --- a/src/quick/doc/src/whatsnew.qdoc +++ b/src/quick/doc/src/whatsnew.qdoc @@ -29,9 +29,9 @@ \title Qt Quick Release Notes \page qtquick-releasenotes.html -\section1 Qt 5.0 - QtQuick C++ Module +\section1 Qt 5.0 - Qt Quick C++ Module -The QtQuick C++ module is new in Qt 5. It provides the visual canvas and scenegraph back-end +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. As of Qt 5, the \l {Qt Quick} module is based on an OpenGL scenegraph. Many of the classes in @@ -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 QtQuick. Properties of +QMatrix4x4 and QQuaternion, as well as QColor and QFont, are now provided by 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. -QtQuick also provides implementation for the various value type factory or utility functions of the +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 diff --git a/src/quick/items/context2d/qquickcanvasitem.cpp b/src/quick/items/context2d/qquickcanvasitem.cpp index 1054da3..3efb1ae 100644 --- a/src/quick/items/context2d/qquickcanvasitem.cpp +++ b/src/quick/items/context2d/qquickcanvasitem.cpp @@ -760,7 +760,7 @@ void QQuickCanvasItem::getContext(QQmlV8Function *args) /*! \qmlmethod long QtQuick2::Canvas::requestAnimationFrame(callback) - This function schedules callback to be invoked before composing the QtQuick + This function schedules callback to be invoked before composing the Qt Quick scene. */ diff --git a/src/quick/util/qquickimageprovider.cpp b/src/quick/util/qquickimageprovider.cpp index 4e3748f..2073bdc 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 QtQuick 1 version of this class is named QDeclarativeImageProvider. + The Qt Quick 1 version of this class is named QDeclarativeImageProvider. \sa QQmlEngine::addImageProvider() */ -- 2.7.4