From 9baaeba10184c908267e1332d6ec4329d6a71fd3 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Mon, 22 Apr 2013 19:49:30 +0800 Subject: [PATCH] Doc: Un-overload the word "module" "The Qt Quick module contains the QtQuick QML module and the Qt Quick C++ module" is an odd way to describe things. The concept of a "QML module" is deeply entrenched so this patch won't touch it, but at least we can get rid of references to "C++ module"s. Change-Id: Ib06f8e3152551901dc6016cb37507cb9608d7863 Reviewed-by: Jerome Pasion --- src/qml/doc/src/cppintegration/definetypes.qdoc | 4 ++-- .../doc/src/cppintegration/extending-tutorial.qdoc | 2 +- src/qml/doc/src/cppintegration/topic.qdoc | 2 +- src/qml/doc/src/qmlfunctions.qdoc | 2 +- src/qml/doc/src/qtqml.qdoc | 3 ++- src/qml/doc/src/whatsnew.qdoc | 4 ++-- src/quick/doc/src/qtquick.qdoc | 8 +++----- src/quick/doc/src/whatsnew.qdoc | 4 ++-- 8 files changed, 14 insertions(+), 15 deletions(-) diff --git a/src/qml/doc/src/cppintegration/definetypes.qdoc b/src/qml/doc/src/cppintegration/definetypes.qdoc index 1aab159..995fb1b 100644 --- a/src/qml/doc/src/cppintegration/definetypes.qdoc +++ b/src/qml/doc/src/cppintegration/definetypes.qdoc @@ -680,8 +680,8 @@ to be declared for an item without explicitly assigning them to the 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 type for all visual objects in \l {Qt Quick}. This \l Item type is -implemented by the QQuickItem C++ class, which is provided as part of the -\l {Qt Quick} C++ module. Therefore, this class should be subclassed when it is +implemented by the QQuickItem C++ class, which is provided by the +\l {Qt Quick} module. Therefore, this class should be subclassed when it is necessary to implement a visual type in C++ that can be integrated into a QML-based user interface. diff --git a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc index ffa36c3..763e724 100644 --- a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc +++ b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc @@ -30,7 +30,7 @@ \title Writing QML Extensions with C++ \brief tutorial about extending QML with Qt C++ -The \l Qt QML} C++ module provides a set of APIs for extending QML through +The \l {Qt QML} module provides a set of APIs for extending QML through C++ extensions. You can write extensions to add your own QML types, extend existing Qt types, or call C/C++ functions that are not accessible from ordinary QML code. diff --git a/src/qml/doc/src/cppintegration/topic.qdoc b/src/qml/doc/src/cppintegration/topic.qdoc index b6df231..4d12ab9 100644 --- a/src/qml/doc/src/cppintegration/topic.qdoc +++ b/src/qml/doc/src/cppintegration/topic.qdoc @@ -29,7 +29,7 @@ \title Integrating QML and C++ \brief Description of how to integrate QML and C++ code -QML is designed to be easily extensible through C++ code. The classes in the \l {Qt QML} C++ module +QML is designed to be easily extensible through C++ code. The classes in the \l {Qt QML} module enables QML objects to be loaded and manipulated from C++, and the nature of QML engine's integration with Qt's \l{Meta Object System}{meta object system} enables C++ functionality to be invoked directly from QML. This allows the development of hybrid applications which are implemented diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc index 5db2754..976403a 100644 --- a/src/qml/doc/src/qmlfunctions.qdoc +++ b/src/qml/doc/src/qmlfunctions.qdoc @@ -392,7 +392,7 @@ url must be an absolute URL, i.e. url.isRelative() == false. Normally QML files can be loaded as types directly from other QML files, or using a qmldir file. This function allows - registration of files to types from a C++ module, such as when the type mapping needs to be procedurally determined at startup. + registration of files to types from C++ code, such as when the type mapping needs to be procedurally determined at startup. #include to use this function. diff --git a/src/qml/doc/src/qtqml.qdoc b/src/qml/doc/src/qtqml.qdoc index 3cb6fce..8bd4187 100644 --- a/src/qml/doc/src/qtqml.qdoc +++ b/src/qml/doc/src/qtqml.qdoc @@ -34,7 +34,8 @@ The Qt QML module provides a framework for developing applications and libraries with the \l{The QML Language}{QML language}. It defines and implements the language and engine infrastructure, and provides an API to enable application developers to extend the QML language with custom types and integrate QML code -with JavaScript and C++. +with JavaScript and C++. The Qt QML module provides both a \l{Qt QML QML Types} +{QML API} and a \l{Qt QML C++ Classes}{C++ API}. Note that while the Qt QML module provides the language and infrastructure for QML applications, the \l{Qt Quick} module provides many visual components, diff --git a/src/qml/doc/src/whatsnew.qdoc b/src/qml/doc/src/whatsnew.qdoc index 3ede480..154c7cf 100644 --- a/src/qml/doc/src/whatsnew.qdoc +++ b/src/qml/doc/src/whatsnew.qdoc @@ -35,8 +35,8 @@ 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 \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.) +has now been replaced by the new \l {Qt QML} and \l {Qt Quick} modules. See the +\l {Porting QML Applications to Qt 5} page for more information.) \section2 QML Engine diff --git a/src/quick/doc/src/qtquick.qdoc b/src/quick/doc/src/qtquick.qdoc index c570da5..9fba663 100644 --- a/src/quick/doc/src/qtquick.qdoc +++ b/src/quick/doc/src/qtquick.qdoc @@ -38,11 +38,9 @@ provides a visual canvas and includes types for creating and animating visual components, receiving user input, creating data models and views and delayed object instantiation. -The Qt Quick module provides both the \c QtQuick QML module, which supplies -\l{Qt Quick QML Types}{a set of QML types} for creating user -interfaces with the QML language, and the \c QtQuick C++ module, which supplies -\l{Qt Quick C++ Classes}{a set of C++ APIs} for integrating with user interfaces and -applications built with QML and the \c QtQuick QML module. +The Qt Quick module provides both a \l{Qt Quick QML Types}{QML API} which supplies +QML types for creating user interfaces with the QML language, and a +\l{Qt Quick C++ Classes}{C++ API} for extending QML applications with C++ code. \note From Qt 5.1, a set of Qt Quick based UI controls is available to create classic desktop-style user interfaces. Please see \l{Qt Quick Controls} diff --git a/src/quick/doc/src/whatsnew.qdoc b/src/quick/doc/src/whatsnew.qdoc index 174fa22..baa0312 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 - Qt Quick C++ Module +\section1 Qt Quick in Qt 5 -The \l {Qt Quick} C++ module is new in Qt 5. It provides the visual canvas and scenegraph back-end +The \l {Qt Quick} 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 -- 1.7.2.5