From e72f5776583b071c14ce087efc637ba1cc97d9a6 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Sat, 20 Apr 2013 00:33:27 +0800 Subject: [PATCH] Doc: Fix module name format Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtGui -> Qt GUI QtMultimedia -> Qt Multimedia QtScript -> Qt Script QtSensors -> Qt Sensors QtSvg -> Qt SVG QtWebkit -> Qt WebKit Also fix a broken link to "Qt WebKit QML Types" Change-Id: Ica6081024d3957a3ca2ef3d870f623506c69d877 Reviewed-by: Jerome Pasion --- src/qml/qml/v8/qqmlbuiltinfunctions.cpp | 2 +- src/qml/qml/v8/qv8qobjectwrapper.cpp | 3 ++- src/quick/doc/src/appdevguide/applicationdevelopers.qdoc | 4 ++-- src/quick/doc/src/appdevguide/deployment.qdoc | 2 +- src/quick/doc/src/appdevguide/usecases/text.qdoc | 2 +- src/quick/doc/src/appdevguide/usecases/userinput.qdoc | 6 +++--- src/quick/doc/src/appdevguide/usecases/visual.qdoc | 2 +- src/quick/doc/src/examples.qdoc | 2 +- src/quick/util/qquicksvgparser.cpp | 2 +- tests/auto/qml/qjsengine/tst_qjsengine.cpp | 2 +- tools/qmlplugindump/main.cpp | 2 +- 11 files changed, 15 insertions(+), 14 deletions(-) diff --git a/src/qml/qml/v8/qqmlbuiltinfunctions.cpp b/src/qml/qml/v8/qqmlbuiltinfunctions.cpp index 4d20e3c..1be2a0b 100644 --- a/src/qml/qml/v8/qqmlbuiltinfunctions.cpp +++ b/src/qml/qml/v8/qqmlbuiltinfunctions.cpp @@ -1130,7 +1130,7 @@ Example (where \c parentItem is the id of an existing QML item): \snippet qml/createQmlObject.qml 0 -In the case of an error, a QtScript Error object is thrown. This object has an additional property, +In the case of an error, a \l {Qt Script} Error object is thrown. This object has an additional property, \c qmlErrors, which is an array of the errors encountered. Each object in this array has the members \c lineNumber, \c columnNumber, \c fileName and \c message. For example, if the above snippet had misspelled color as 'colro' then the array would contain an object like the following: diff --git a/src/qml/qml/v8/qv8qobjectwrapper.cpp b/src/qml/qml/v8/qv8qobjectwrapper.cpp index 0982f17..0336457 100644 --- a/src/qml/qml/v8/qv8qobjectwrapper.cpp +++ b/src/qml/qml/v8/qv8qobjectwrapper.cpp @@ -1612,7 +1612,8 @@ static v8::Handle CallMethod(QObject *object, int index, int returnTy Returns the match score for converting \a actual to be of type \a conversionType. A zero score means "perfect match" whereas a higher score is worse. - The conversion table is copied out of the QtScript callQtMethod() function. + The conversion table is copied out of the \l QScript::callQtMethod() + function. */ static int MatchScore(v8::Handle actual, int conversionType) { diff --git a/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc b/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc index c1b5a93..80fdc36 100644 --- a/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc +++ b/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc @@ -49,8 +49,8 @@ through other modules. If you require the functionality of those modules, you sh their QML documentation. Qt Essentials modules exposing QML types include: \list -\li \l QtMultimedia for playing and managing multimedia content and cameras. -\li \l QtWebkit for rendering web content. +\li \l {Qt Multimedia} for playing and managing multimedia content and cameras. +\li \l {Qt WebKit} for rendering web content. \endlist \section1 Quick Start diff --git a/src/quick/doc/src/appdevguide/deployment.qdoc b/src/quick/doc/src/appdevguide/deployment.qdoc index 1c8bd20..8511ef5 100644 --- a/src/quick/doc/src/appdevguide/deployment.qdoc +++ b/src/quick/doc/src/appdevguide/deployment.qdoc @@ -130,7 +130,7 @@ loaded as a QQmlComponent instance rather than placed into a view: QGuiApplication can be replaced by a QCoreApplication in the code above in case you are not using any graphical items from Qt Quick. This allows using QML as a language without any -dependencies to the Qt Gui module. +dependencies to the \l {Qt GUI} module. See \l{qtqml-cppintegration-data.html}{qtqml-cppintegration-exposecppattributes.html}{Exposing Attributes of C++ Types to QML} for more information about using QQmlEngine, QQmlContext and QQmlComponent, as well diff --git a/src/quick/doc/src/appdevguide/usecases/text.qdoc b/src/quick/doc/src/appdevguide/usecases/text.qdoc index 94400ff..7b8e21e 100644 --- a/src/quick/doc/src/appdevguide/usecases/text.qdoc +++ b/src/quick/doc/src/appdevguide/usecases/text.qdoc @@ -29,7 +29,7 @@ \title Use Case - Displaying Text In QML \brief Example of how to display text in QML To display text the Text type is provided by the \l {Qt Quick} module. For related uses, the \l{TextInput} and -\l{TextEdit} types provide editable text controls. For full HTML markup, see the \c{QtWebkit} module. +\l{TextEdit} types provide editable text controls. For full HTML markup, see the \l {Qt WebKit} module. \section1 Displaying and Formatting Text diff --git a/src/quick/doc/src/appdevguide/usecases/userinput.qdoc b/src/quick/doc/src/appdevguide/usecases/userinput.qdoc index 460f86a..7e93a26 100644 --- a/src/quick/doc/src/appdevguide/usecases/userinput.qdoc +++ b/src/quick/doc/src/appdevguide/usecases/userinput.qdoc @@ -34,11 +34,11 @@ The \l {Qt Quick} module provides support for the most common types of user input, including mouse and touch events, text input and key-press events. Other modules provide support for other types of user input (for example, the -\l QtSensors module provides support for shake-gestures in QML applications). +\l {Qt Sensors} module provides support for shake-gestures in QML applications). This article covers how to handle basic user input; for further information -about motion-gesture support, please see the \l QtSensors documentation. For -information about audio-visual input, please see the \l QtMultimedia documentation. +about motion-gesture support, please see the \l {Qt Sensors} documentation. For +information about audio-visual input, please see the \l {Qt Multimedia} documentation. \section2 Mouse and Touch Events diff --git a/src/quick/doc/src/appdevguide/usecases/visual.qdoc b/src/quick/doc/src/appdevguide/usecases/visual.qdoc index 7e9e654..fc7b96c 100644 --- a/src/quick/doc/src/appdevguide/usecases/visual.qdoc +++ b/src/quick/doc/src/appdevguide/usecases/visual.qdoc @@ -54,7 +54,7 @@ borders. \l AnimatedImage plays animated .gif and .mng images. \l AnimatedSprite and \l SpriteSequence play animations comprised of multiple frames stored adjacently in a non animated image format. -For displaying video files and camera data, see the \l QtMultimedia module. +For displaying video files and camera data, see the \l {Qt Multimedia} module. \section1 Shared Visual Properties diff --git a/src/quick/doc/src/examples.qdoc b/src/quick/doc/src/examples.qdoc index 6db5308..8d3bc30 100644 --- a/src/quick/doc/src/examples.qdoc +++ b/src/quick/doc/src/examples.qdoc @@ -130,7 +130,7 @@ code using the \l{Qt QML} module. \li \l{external: Qt Mobility QML Plugins}{QML Plugins} \li \l{external: Qt Quick Components for Symbian}{Symbian Components} \li MeeGo Components - \li \l{QtWebKit QML Module} + \li \l{Qt WebKit QML Types} \endlist \enddiv \div {class="threecolumn_piece"} diff --git a/src/quick/util/qquicksvgparser.cpp b/src/quick/util/qquicksvgparser.cpp index 760b4b0..ece6d24 100644 --- a/src/quick/util/qquicksvgparser.cpp +++ b/src/quick/util/qquicksvgparser.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE static const double Q_PI = 3.14159265358979323846; // pi -//copied from QtSvg (qsvghandler.cpp). +//copied from Qt SVG (qsvghandler.cpp). Q_CORE_EXPORT double qstrtod(const char *s00, char const **se, bool *ok); // '0' is 0x30 and '9' is 0x39 static inline bool isDigit(ushort ch) diff --git a/tests/auto/qml/qjsengine/tst_qjsengine.cpp b/tests/auto/qml/qjsengine/tst_qjsengine.cpp index 70b718c..89289f3 100644 --- a/tests/auto/qml/qjsengine/tst_qjsengine.cpp +++ b/tests/auto/qml/qjsengine/tst_qjsengine.cpp @@ -246,7 +246,7 @@ void tst_QJSEngine::newArray_HooliganTask233836() } { QJSValue ret = eng.newArray(0xFFFFFFFF); - QEXPECT_FAIL("", "The maximum length of arrays is defined by v8 currently and differs from QtScript", Abort); + QEXPECT_FAIL("", "The maximum length of arrays is defined by v8 currently and differs from Qt Script", Abort); QCOMPARE(ret.property("length").toUInt(), uint(0xFFFFFFFF)); ret.setProperty(0xFFFFFFFF, 123); QCOMPARE(ret.property("length").toUInt(), uint(0xFFFFFFFF)); diff --git a/tools/qmlplugindump/main.cpp b/tools/qmlplugindump/main.cpp index 3d816e5..a31bbe9 100644 --- a/tools/qmlplugindump/main.cpp +++ b/tools/qmlplugindump/main.cpp @@ -562,7 +562,7 @@ int main(int argc, char *argv[]) #endif #ifdef QT_SIMULATOR - // Running this application would bring up the Qt Simulator (since it links QtGui), avoid that! + // Running this application would bring up the Qt Simulator (since it links Qt GUI), avoid that! QtSimulatorPrivate::SimulatorConnection::createStubInstance(); #endif -- 2.7.4