aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2013-03-28 20:39:13 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-03-30 01:12:39 +0100
commit049763350775cdb037bbbcd1371cc111290537ba (patch)
treed36d3d6d62e7835f157294aa6263ada1b7733787 /src/qml/doc
parent064c99b87ed13ecc82311cc166361a409a969b45 (diff)
Doc: Fix some titles and links
Make page titles follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation. Make class/type list titles follow the "<Qt Module> C++ Classes" and "<Qt Module> QML Types" formats. Links are updated accordingly, along with broken links found during this sweep. Some inline links also have their surrounding text modified, to improve flow. Change-Id: I0ed7788caa250085d7ea0080a77d8a2655debf39 Reviewed-by: Alan Alpert <aalpert@blackberry.com>
Diffstat (limited to 'src/qml/doc')
-rw-r--r--src/qml/doc/qtqml.qdocconf2
-rw-r--r--src/qml/doc/src/cppintegration/extending-tutorial.qdoc2
-rw-r--r--src/qml/doc/src/qmltypereference.qdoc6
-rw-r--r--src/qml/doc/src/qtqml-cpp.qdoc2
-rw-r--r--src/qml/doc/src/qtqml.qdoc8
5 files changed, 10 insertions, 10 deletions
diff --git a/src/qml/doc/qtqml.qdocconf b/src/qml/doc/qtqml.qdocconf
index ecd6b81823..2f92f45245 100644
--- a/src/qml/doc/qtqml.qdocconf
+++ b/src/qml/doc/qtqml.qdocconf
@@ -18,7 +18,7 @@ qhp.QtQml.customFilters.Qt.name = QtQml $QT_VERSION
qhp.QtQml.customFilters.Qt.filterAttributes = qtqml $QT_VERSION
qhp.QtQml.subprojects = classes examples
qhp.QtQml.subprojects.classes.title = C++ Classes
-qhp.QtQml.subprojects.classes.indexTitle = Qt QML Module C++ Classes
+qhp.QtQml.subprojects.classes.indexTitle = Qt QML C++ Classes
qhp.QtQml.subprojects.classes.selectors = class fake:headerfile
qhp.QtQml.subprojects.classes.sortPages = true
qhp.QtQml.subprojects.examples.title = Examples
diff --git a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
index bea464c8f6..82c04b1457 100644
--- a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
+++ b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
@@ -67,7 +67,7 @@ and \l {qtqml-cppintegration-definetypes.html}{Defining QML Types from C++}.
\example quick/tutorials/extending/chapter1-basics
A common task when extending QML is to provide a new QML type that supports some
- custom functionality beyond what is provided by the built-in \l {Qt Quick QML Types}{QtQuick types}.
+ custom functionality beyond what is provided by the built-in \l {Qt Quick QML Types}{Qt Quick types}.
For example, this could be done to implement particular data models, or provide
types with custom painting and drawing capabilities, or access system features
like network programming that are not accessible through built-in QML features.
diff --git a/src/qml/doc/src/qmltypereference.qdoc b/src/qml/doc/src/qmltypereference.qdoc
index cce8d108d8..799945fa37 100644
--- a/src/qml/doc/src/qmltypereference.qdoc
+++ b/src/qml/doc/src/qmltypereference.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
\qmlmodule QtQml 2
-\title Qt Qml QML Types
+\title Qt QML QML Types
\ingroup qmlmodules
\brief List of QML types provided by the Qt QML module
@@ -60,11 +60,11 @@ and functionality provided by the \c QtQml namespace are also provided by the
import QtQuick 2.0
\endqml
-See the \l{QtQuick}{QtQuick} module documentation for more information about the
+See the \l{Qt Quick} module documentation for more information about the
\c QtQuick namespace and what it provides to QML application developers.
The documentation for the types below applies equally to the types of the same
-name provided by the \l{QtQuick}{QtQuick} module, as they are in fact identical.
+name provided by the \l{Qt Quick} module, as they are in fact identical.
\section1 Basic Types
diff --git a/src/qml/doc/src/qtqml-cpp.qdoc b/src/qml/doc/src/qtqml-cpp.qdoc
index 5470b00fb8..74e59d2540 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++ Classes
+\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
diff --git a/src/qml/doc/src/qtqml.qdoc b/src/qml/doc/src/qtqml.qdoc
index 12a791899e..05a33f351a 100644
--- a/src/qml/doc/src/qtqml.qdoc
+++ b/src/qml/doc/src/qtqml.qdoc
@@ -39,8 +39,8 @@ 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{Qt QML Module - C++ Classes}{a set of core QML types} for creating QML
-applications, and the \c QtQml C++ module, which supplies \l{Qt QML Module - C++ Classes}{a set of C++
+\l{Qt QML QML Types}{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.
@@ -102,7 +102,7 @@ for an introduction to writing QML applications.
\li \l{qtqml-documents-scope.html}{Scope and Naming Resolution}
\endlist
- \li \l{qtqml-typereference-topic.html}{QML Types Provided by the QtQml Module}
+ \li \l{qtqml-typereference-topic.html}{QML Types Provided by the Qt QML Module}
\list
\li \l{qtqml-typereference-topic.html#importing-qtqml}{Importing \c QtQml}
\li \l{qtqml-typereference-topic.html#basic-types}{Basic Types}
@@ -170,7 +170,7 @@ for an introduction to writing QML applications.
Additional Qt QML information:
\list
-\li \l{Qt QML Module - C++ Classes} - the C++ API provided by the
+\li \l{Qt QML C++ Classes} - the C++ API provided by the
Qt QML module
\li \l{Qt QML Release Notes} - list of changes and
additions in the Qt QML module