diff options
author | Bea Lam <bea.lam@nokia.com> | 2012-08-27 17:04:17 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-28 04:32:48 +0200 |
commit | c5e46a63b2dac24e411b904019ef9e87a832791b (patch) | |
tree | eb20cfd12dcef0d17fb84ee5005418b19cf0b5ff /src/quick/doc | |
parent | 4a4a08d61a9771b5f49d7377b48d821075df3d97 (diff) |
Fix various doc errors
Also restore the main module "reference documentation" links
added in 0e0f46c01cf6a183996d36c31987ca4a46b50bd9
Change-Id: I421f5a17e2946a2569537d8ba8a021f219aaf75a
Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
Diffstat (limited to 'src/quick/doc')
-rw-r--r-- | src/quick/doc/src/appdevguide/quickstart/basics.qdoc | 16 | ||||
-rw-r--r-- | src/quick/doc/src/concepts/positioning/layouts.qdoc | 2 | ||||
-rw-r--r-- | src/quick/doc/src/concepts/statesanimations/topic.qdoc | 2 | ||||
-rw-r--r-- | src/quick/doc/src/qtquick.qdoc | 18 |
4 files changed, 23 insertions, 15 deletions
diff --git a/src/quick/doc/src/appdevguide/quickstart/basics.qdoc b/src/quick/doc/src/appdevguide/quickstart/basics.qdoc index 5f9d5c0eb9..2cb4bdccf3 100644 --- a/src/quick/doc/src/appdevguide/quickstart/basics.qdoc +++ b/src/quick/doc/src/appdevguide/quickstart/basics.qdoc @@ -34,25 +34,25 @@ A QML document defines a hierarchy of objects with a highly-readable, structured layout. Every QML document consists of two parts: an imports section and an object declaration section. The types and functionality most -common to user interfaces are provided in the \l{Qt Quick Module}{QtQuick} +common to user interfaces are provided in the \l{QtQuick} import. \section2 Importing and Using the QtQuick Module -To use the \l{Qt Quick Module}{QtQuick} module, a QML document needs to +To use the \l{QtQuick} module, a QML document needs to import it. The import syntax looks like this: \qml import QtQuick 2.0 \endqml -The types and functionality that \l{Qt Quick Module}{QtQuick} provides can now +The types and functionality that \l{QtQuick} provides can now be used in the QML document! \section2 Defining an Object Hierarchy The object declaration in a QML document defines what will be displayed in the -visual scene. \l{Qt Quick Module}{QtQuick} provides the basic building blocks +visual scene. \l{QtQuick} provides the basic building blocks for all user interfaces, including objects to display images and text, and to handle user input. @@ -80,8 +80,8 @@ added to the \c children property of the \l Rectangle object, by QML. \section2 Putting it Together The \l Rectangle and \l Text types used in the above example are both provided -by the \l{Qt Quick Module}{QtQuick} import. To use them, we need to import -\l{Qt Quick Module}{QtQuick}. Putting the import and object declaration +by the \l{QtQuick} import. To use them, we need to import +\l{QtQuick}. Putting the import and object declaration together, we get a complete QML document: \qml @@ -104,8 +104,8 @@ If we save that document as "HelloWorld.qml" we can load and display it. \section1 Loading and Displaying the QML Document To display the graphical scene defined by the QML document, it may be loaded -with the \l{Protoyping with qmlscene}{qmlscene} tool. The -\l{Protoyping with qmlscene}{qmlscene} tool should be installed into the +with the \l{Prototyping with qmlscene}{qmlscene} tool. The +\l{Prototyping with qmlscene}{qmlscene} tool should be installed into the Qt installation directory. Assuming that the Qt binaries are installed into or are available in the system executable path, you can display the QML document with the following command: diff --git a/src/quick/doc/src/concepts/positioning/layouts.qdoc b/src/quick/doc/src/concepts/positioning/layouts.qdoc index 05b3eb9d51..f211e79f73 100644 --- a/src/quick/doc/src/concepts/positioning/layouts.qdoc +++ b/src/quick/doc/src/concepts/positioning/layouts.qdoc @@ -28,7 +28,7 @@ /*! \ingroup qtquick-positioners \page qtquick-positioning-layouts.html -\iningroup qml-features +\ingroup qml-features \title Item Layouts Positioner items are container items that manage the positions and sizes of diff --git a/src/quick/doc/src/concepts/statesanimations/topic.qdoc b/src/quick/doc/src/concepts/statesanimations/topic.qdoc index b498a28079..c80b239a70 100644 --- a/src/quick/doc/src/concepts/statesanimations/topic.qdoc +++ b/src/quick/doc/src/concepts/statesanimations/topic.qdoc @@ -27,7 +27,7 @@ /*! \page qtquick-statesanimations-topic.html -\title Import Concepts in Qt Quick - States, Transitions and Animations +\title Important Concepts in Qt Quick - States, Transitions and Animations \brief Description of the concepts of states, transitions and animations in Qt Quick In any modern user-interface, transitioning between states and animating diff --git a/src/quick/doc/src/qtquick.qdoc b/src/quick/doc/src/qtquick.qdoc index a70f2de31b..af978a40a7 100644 --- a/src/quick/doc/src/qtquick.qdoc +++ b/src/quick/doc/src/qtquick.qdoc @@ -108,12 +108,20 @@ To find out more about using the QML language, see the \l{Qt QML Module Document \section1 Reference Documentation +Additional Qt Quick information: \list -\li \l{QML Types Provided by Qt Quick} -\li \l{Qt Quick Module - C++ Classes} -\li \l{Qt QML} module documentation -\li \l{QML Application Developer Resources} - information for application development with QML and Qt Quick -\li \l{Qt Quick Release Notes} +\li \l{Qt Quick Module - C++ Classes} - the C++ API provided by the + Qt Quick module +\li \l{Qt Quick Release Notes} - list of changes and + additions in the Qt Quick module +\endlist + +Further information for writing QML applications: +\list +\li \l{QML Application Developer Resources} + - essential information for application development with QML and Qt Quick +\li \l{Qt Qml} - documentation for the + Qt QML module, which provides the QML engine and language infrastructure \endlist */ |