From 540092608b26c469d4905d3c673374542cc32940 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Mon, 13 Aug 2012 15:16:51 +0200 Subject: [PATCH] Doc: Tidied links, titles, and HTML pages. -used "Qt Quick" and "Qt QML" to refer to the module -qtquick-index.html and qtqml-index.html for the landing pages Change-Id: I1569949f7875ac6008a5b80a169e327f93f330ae Reviewed-by: Chris Adams --- src/qml/doc/src/qtqml-cpp.qdoc | 4 +-- src/qml/doc/src/qtqml.qdoc | 32 +++++++------------- src/qml/doc/src/whatsnew.qdoc | 2 +- .../doc/src/appdevguide/applicationdevelopers.qdoc | 15 +++++----- src/quick/doc/src/appdevguide/glossary.qdoc | 2 +- src/quick/doc/src/appdevguide/qmlscene.qdoc | 2 +- src/quick/doc/src/qtquick-cpp.qdoc | 4 +-- src/quick/doc/src/qtquick.qdoc | 34 ++++++++-------------- src/quick/doc/src/whatsnew.qdoc | 2 +- 9 files changed, 38 insertions(+), 59 deletions(-) diff --git a/src/qml/doc/src/qtqml-cpp.qdoc b/src/qml/doc/src/qtqml-cpp.qdoc index 514a94d..e36ff77 100644 --- a/src/qml/doc/src/qtqml-cpp.qdoc +++ b/src/qml/doc/src/qtqml-cpp.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! \module QtQml -\title Qt QML Module C++ API Reference +\title Qt QML - C++ Classes \brief The C++ API provided by the Qt QML module To include the definitions of the module's classes, use the @@ -44,7 +44,7 @@ QT += qml \endcode For more information on the Qt QML module, see the -\l{qtqml-main.html}{Qt QML module} documentation. +\l{Qt QML} module documentation. */ diff --git a/src/qml/doc/src/qtqml.qdoc b/src/qml/doc/src/qtqml.qdoc index 416d957..1dc23fa 100644 --- a/src/qml/doc/src/qtqml.qdoc +++ b/src/qml/doc/src/qtqml.qdoc @@ -26,8 +26,8 @@ ****************************************************************************/ /*! -\page qtqml-main.html -\title Qt QML Module +\page qtqml-index.html +\title Qt QML \brief The Qt QML module defines and implements the QML language \section1 Overview of the Qt QML Module @@ -39,15 +39,15 @@ developers to extend the QML language with custom types and integrate QML code with JavaScript and C++. The Qt QML module provides both the \c QtQml QML module, which supplies -\l{qtquick-qmltypereference.html}{a set of core QML types} for creating QML -applications, and the QtQml C++ module, which supplies \l{QtQml}{a set of C++ +\l{Qt QML - C++ Classes}{a set of core QML types} for creating QML +applications, and the \c QtQml C++ module, which supplies \l{Qt QML - C++ Classes}{a set of C++ APIs} for extending QML applications with custom types and integrating C++ implementations with QML applications. Note that the Qt QML module provides only the language and infrastructure for the QML, and does not provide a visual canvas or rendering engine for creating user interfaces. These are provided instead by the -\l{qtquick-main.html}{Qt Quick module}, which provides many visual components, +\l{Qt Quick} module, which provides many visual components, model/view support, an animation framework and much more for building user interfaces with QML. @@ -105,7 +105,7 @@ for an introduction to writing QML applications. \li \l{qtqml-typereference-topic.html}{QML Types Provided by the QtQml Module} \list - \li \l{qtqml-typereference-topic.html#importing-qtqml}{Importing QtQml} + \li \l{qtqml-typereference-topic.html#importing-qtqml}{Importing \c QtQml} \li \l{qtqml-typereference-topic.html#basic-types}{Basic Types} \li \l{qtqml-typereference-topic.html#object-types}{Object Types} \list @@ -166,22 +166,12 @@ for an introduction to writing QML applications. \section1 Reference Documentation -Additional Qt QML information: \list -\li \l{QtQml}{QtQml Module C++ API Reference} - the C++ API provided by the - Qt QML module -\li \l{qtqml-releasenotes.html}{QtQml Release Notes} - list of changes and - additions in the Qt QML module -\endlist - -Further information for writing QML applications: -\list -\li \l{qtquick-applicationdevelopers.html}{QML Application Developer Resources} - - essential information for application development with QML and Qt Quick -\li \l{qtquick-main.html}{Qt Quick Module Documentation} - documentation for - the Qt Quick module, which provides a visual canvas, an animation - framework, model/view components and more for building fluid user - interfaces and applications with QML +\li \l{QML Types Provided By The QtQml Module}{Qt QML - QML Type Reference} +\li \l{Qt QML - C++ Classes} +\li \l{Qt Quick} module documentation +\li \l{QML Application Developer Resources} - information for application development with QML and Qt Quick +\li \l{Qt QML Release Notes} \endlist */ diff --git a/src/qml/doc/src/whatsnew.qdoc b/src/qml/doc/src/whatsnew.qdoc index b996157..a37927d 100644 --- a/src/qml/doc/src/whatsnew.qdoc +++ b/src/qml/doc/src/whatsnew.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! -\title QtQml Module Release Notes +\title Qt QML Release Notes \page qtqml-releasenotes.html \inqmlmodule QtQuick 2.0 diff --git a/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc b/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc index ca810f9..4305506 100644 --- a/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc +++ b/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc @@ -52,7 +52,7 @@ user interfaces in QML, and have the option of connecting these user interfaces to any back-end C++ libraries. This page links to all the information you need to start developing -applications with QML and QtQuick. +applications with \l{Qt QML}{QML} and \l{Qt Quick}. \section2 Other QML modules @@ -112,7 +112,7 @@ expressions combined with dynamic property bindings. The QML language and engine infrastructure is provided by the Qt QML module. For in-depth information about the QML language, please see the -\l{qtqml-main.html}{Qt QML Module Documentation}. +\l{Qt QML} module documentation. \section2 What is Qt Quick? @@ -121,10 +121,9 @@ includes visual elements, interactive elements, animations, models and views, particle effects and shader effects. A QML application developer can get access to all of that functionality with a single import statement. -The QtQuick QML library is provided by the Qt Quick module. +The \c QtQuick QML library is provided by the \l{Qt Quick} module. For in-depth information about the various QML types and other functionality -provided by Qt Quick, please see the \l{qtquick-main.html} -{Qt Quick Module Documentation}. +provided by Qt Quick, please see the \l{Qt Quick} module documentation. \section1 Advanced Application Development Topics @@ -144,9 +143,9 @@ provided by Qt Quick, please see the \l{qtquick-main.html} \section1 Release Notes and Porting Guides \list -\li \l{qtqml-releasenotes.html}{QtQml Module Release Notes} -\li \l{qtquick-releasenotes.html}{QtQuick Module Release Notes} -\li \l{qtquick-porting-qt5.html}{Porting QML Applications to Qt 5} +\li \l{Qt QML Release Notes} +\li \l{Qt Quick Release Notes} +\li \l{Porting QML Applications to Qt 5} \endlist */ diff --git a/src/quick/doc/src/appdevguide/glossary.qdoc b/src/quick/doc/src/appdevguide/glossary.qdoc index a3b6db8..9fb7bef 100644 --- a/src/quick/doc/src/appdevguide/glossary.qdoc +++ b/src/quick/doc/src/appdevguide/glossary.qdoc @@ -27,7 +27,7 @@ /*! \page qtquick-glossary.html -\title Glossary Of Terms +\title Qt Quick Glossary Of Terms \brief Glossary of terms used in the documentation for QML and QtQuick \section1 Common Terms diff --git a/src/quick/doc/src/appdevguide/qmlscene.qdoc b/src/quick/doc/src/appdevguide/qmlscene.qdoc index 7ca4045..759ece8 100644 --- a/src/quick/doc/src/appdevguide/qmlscene.qdoc +++ b/src/quick/doc/src/appdevguide/qmlscene.qdoc @@ -28,7 +28,7 @@ /*! \page qtquick-qmlscene.html \ingroup qtquick-tools -\title Protoyping with qmlscene +\title Prototyping with qmlscene \ingroup qttools \brief a tool for testing and loading QML files diff --git a/src/quick/doc/src/qtquick-cpp.qdoc b/src/quick/doc/src/qtquick-cpp.qdoc index 5a3384f..29dd772 100644 --- a/src/quick/doc/src/qtquick-cpp.qdoc +++ b/src/quick/doc/src/qtquick-cpp.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! \module QtQuick - \title Qt Quick Module C++ API Reference + \title Qt Quick Module - C++ Classes \brief The Qt Quick module provides classes for embedding Qt Quick in Qt/C++ applications. @@ -46,5 +46,5 @@ \endcode For more information on the Qt Quick module, see the - \l{qtquick-main.html}{Qt Quick module} documentation. + \l{Qt Quick} module documentation. */ diff --git a/src/quick/doc/src/qtquick.qdoc b/src/quick/doc/src/qtquick.qdoc index 45a4b76..a70f2de 100644 --- a/src/quick/doc/src/qtquick.qdoc +++ b/src/quick/doc/src/qtquick.qdoc @@ -26,14 +26,12 @@ ****************************************************************************/ /*! -\page qtquick-main.html -\title Qt Quick Module +\page qtquick-index.html +\title Qt Quick \brief The Qt Quick module implements the "standard library" for QML -\section1 Overview of the Qt Quick Module - The Qt Quick module is the standard library for writing QML applications. -While the \l{qtqml-main.html}{Qt QML module} provides the QML engine and +While the \l{Qt QML} module provides the QML engine and language infrastructure, the Qt Quick module provides all the basic elements necessary for creating user interfaces with QML. It provides a visual canvas and includes types for creating and animating @@ -41,13 +39,13 @@ 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{qtquick-qmltypereference.html}{a set of QML types} for creating user -interfaces with the QML language, and the QtQuick C++ module, which supplies -\l{QtQuick}{a set of C++ APIs} for integrating with user interfaces and +\l{QML Types Provided by Qt Quick}{a set of QML types} for creating user +interfaces with the QML language, and the \c QtQuick C++ module, which supplies +\l{Qt Quick Module - C++ Classes}{a set of C++ APIs} for integrating with user interfaces and applications built with QML and the \c QtQuick QML module. For those new to QML and Qt Quick, please see -\l{qtquick-applicationdevelopers.html}{QML Application Developer Resources} +\l{QML Application Developer Resources} for an introduction to writing QML applications. @@ -110,20 +108,12 @@ 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{QtQuick}{QtQuick Module C++ API Reference} - the C++ API provided by the - Qt Quick module -\li \l{qtquick-releasenotes.html}{QtQuick Release Notes} - list of changes and - additions in the Qt Quick module -\endlist - -Further information for writing QML applications: \list -\li \l{qtquick-applicationdevelopers.html}{QML Application Developer Resources} - - essential information for application development with QML and Qt Quick -\li \l{qtqml-main.html}{Qt QML Module Documentation} - documentation for the - Qt QML module, which provides the QML engine and language infrastructure +\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} \endlist */ diff --git a/src/quick/doc/src/whatsnew.qdoc b/src/quick/doc/src/whatsnew.qdoc index d1a8ed4..a182009 100644 --- a/src/quick/doc/src/whatsnew.qdoc +++ b/src/quick/doc/src/whatsnew.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! -\title QtQuick Module Release Notes +\title Qt Quick Release Notes \page qtquick-releasenotes.html \inqmlmodule QtQuick 2.0 -- 2.7.4