From 1fb66c77d55cfdbe5df9919cbe2f42ddde34fb22 Mon Sep 17 00:00:00 2001 From: Yann Bodson Date: Wed, 18 Jul 2012 12:29:16 +1000 Subject: [PATCH] Minor doc fixes Don't capitalize minor words in titles to be consistent with Qt doc. Change-Id: Ib39ec50d7f9730a5bbf2b574ade8270e9290ec90 Reviewed-by: Alan Alpert --- src/qml/doc/src/qtqml.qdoc | 10 +++--- src/qml/doc/src/typesystem/basictypes.qdoc | 2 +- .../doc/snippets/qml/codingconventions/photo.qml | 10 +++--- .../doc/snippets/qml/codingconventions/private.qml | 2 +- .../doc/src/appdevguide/applicationdevelopers.qdoc | 42 +++++++++++----------- src/quick/doc/src/appdevguide/qtquicktest.qdoc | 2 +- .../doc/src/appdevguide/quickstart/basics.qdoc | 10 +++--- .../doc/src/appdevguide/quickstart/essentials.qdoc | 2 +- src/quick/doc/src/qmltypereference.qdoc | 8 ++--- src/quick/doc/src/qtquick.qdoc | 16 ++++----- src/quick/doc/src/whatsnew.qdoc | 2 +- 11 files changed, 53 insertions(+), 53 deletions(-) diff --git a/src/qml/doc/src/qtqml.qdoc b/src/qml/doc/src/qtqml.qdoc index b25867e..7bb3453 100644 --- a/src/qml/doc/src/qtqml.qdoc +++ b/src/qml/doc/src/qtqml.qdoc @@ -29,7 +29,7 @@ \title Qt QML Module \brief The Qt QML module defines and implements the QML language -\section1 Overview Of The Qt QML Module +\section1 Overview of the Qt QML Module The Qt QML module provides a framework for developing applications. It defines and implements the QML language, and provides API which allows clients to @@ -40,7 +40,7 @@ Application developers who are interested in writing applications using QML should start by reading the \l{qtquick-applicationdevelopers.html} {QML Application Developer Resources}. -\section2 What Is QML +\section2 What is QML? QML is a user-interface specification and programming language. It was designed specifically to enable and ease the development of modern, @@ -49,7 +49,7 @@ touch-driven, fluidly animated and visually-appealling applications. One of the core goals of QML is to allow closer interaction between designers and programmers during the development of an application. -\section2 What Does The Qt QML Module Provide +\section2 What Does the Qt QML Module Provide? The Qt QML module provides the definition and an implementation of the QML language. It uses a JavaScript engine to provide JavaScript integration, and @@ -58,7 +58,7 @@ object instantiation and manipulation along with strong typing, which can be integrated with a visual canvas and an animation framework to enable the development of highly-appealling interactive applications. -\section2 What Does The Qt QML Module Not Provide +\section2 What Does the Qt QML Module Not Provide? It does not provide a visual canvas, visual items, or an animation framework. These are provided instead by the \l{QtQuick} module. @@ -70,7 +70,7 @@ types, animation classes, and canvas integration) for the QML language. \section1 Qt QML Module Documentation \list - \li \l{qtqml-cppclasses-topic.html}{C++ Classes Provided By The Qt QML Module} + \li \l{qtqml-cppclasses-topic.html}{C++ Classes Provided by the Qt QML Module} \list \li \l{qtqml-cppclasses-engine.html}{QQmlEngine} \li \l{qtqml-cppclasses-context.html}{QQmlContext} diff --git a/src/qml/doc/src/typesystem/basictypes.qdoc b/src/qml/doc/src/typesystem/basictypes.qdoc index 060a22d..f234873 100644 --- a/src/qml/doc/src/typesystem/basictypes.qdoc +++ b/src/qml/doc/src/typesystem/basictypes.qdoc @@ -534,7 +534,7 @@ property is only invoked when the property is reassigned to a different object v \list \li \l enumeration \c font.weight \li \l bool \c font.overline - \li \l bool \c font.sstrikeout + \li \l bool \c font.strikeout \li \l enumeration \c font.capitalization \li \l real \c font.letterSpacing \li \l real \c font.wordSpacing diff --git a/src/quick/doc/snippets/qml/codingconventions/photo.qml b/src/quick/doc/snippets/qml/codingconventions/photo.qml index 1bd2811..6de72c9 100644 --- a/src/quick/doc/snippets/qml/codingconventions/photo.qml +++ b/src/quick/doc/snippets/qml/codingconventions/photo.qml @@ -57,11 +57,11 @@ Rectangle { color: "gray" // object properties x: 20; y: 20; height: 150 // try to group related properties together width: { // large bindings - if(photoImage.width > 200){ - photoImage.width; - }else{ - 200; - } + if (photoImage.width > 200) { + photoImage.width; + } else { + 200; + } } Rectangle { // child objects diff --git a/src/quick/doc/snippets/qml/codingconventions/private.qml b/src/quick/doc/snippets/qml/codingconventions/private.qml index 9aba1d0..6aeaa5a 100644 --- a/src/quick/doc/snippets/qml/codingconventions/private.qml +++ b/src/quick/doc/snippets/qml/codingconventions/private.qml @@ -44,6 +44,6 @@ import QtQuick 2.0 Item { id: component width: 40; height: 50 - property real __area: width * height * 0.5 //not meant for outside use + property real __area: width * height * 0.5 // not meant for outside use } //! [0] diff --git a/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc b/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc index 0253c00..606cffe 100644 --- a/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc +++ b/src/quick/doc/src/appdevguide/applicationdevelopers.qdoc @@ -28,7 +28,7 @@ /* XXX -The "Features And Use-Case Solutions" section has been temporarily removed +The "Features and Use-Case Solutions" section has been temporarily removed from the "QML Application Developer Resources" page as we do not have any content for them yet. @@ -36,19 +36,19 @@ Once we have written content for these sections, they can be re-integrated. See QTBUG-26428 -\section1 Features And Use-Case Solutions +\section1 Features and Use-Case Solutions \list -\li \l{qtquick-usecase-visual.html}{Placing Visual Content And Images In The Window} -\li \l{qtquick-usecase-userinput.html}{Responding To User Input} +\li \l{qtquick-usecase-visual.html}{Placing Visual Content and Images in the Window} +\li \l{qtquick-usecase-userinput.html}{Responding to User Input} \li \l{qtquick-usecase-animations.html}{Animating UI Elements} -\li \l{qtquick-usecase-text.html}{Formatting And Displaying Text} +\li \l{qtquick-usecase-text.html}{Formatting and Displaying Text} \li \l{qtquick-usecase-layouts.html}{Complex Layouts} -\li \l{qtquick-usecase-styling.html}{Style And Theme: Look And Feel} -\li \l{qtquick-usecase-integratingjs.html}{Integrating With JavaScript} -\li \l{qtquick-usecase-integratingcpp.html}{Integrating With C++} -\li \l{qtquick-usecase-modules.html}{Creating Modules For QML} -\li \l{qtquick-usecase-multimedia.html}{Playing Sounds And Video In QML} +\li \l{qtquick-usecase-styling.html}{Style and Theme: Look and Feel} +\li \l{qtquick-usecase-integratingjs.html}{Integrating with JavaScript} +\li \l{qtquick-usecase-integratingcpp.html}{Integrating with C++} +\li \l{qtquick-usecase-modules.html}{Creating Modules for QML} +\li \l{qtquick-usecase-multimedia.html}{Playing Sounds and Video in QML} \endlist */ @@ -58,9 +58,9 @@ See QTBUG-26428 \title QML Application Developer Resources \brief Essential documentation for QML application developers -\section1 Overview Of QML and Qt Quick +\section1 Overview of QML and Qt Quick -\section2 What Is QML? +\section2 What is QML? QML is a user-interface specification and programming language. It allows highly performant, fluidly animated, visually appealing applications @@ -73,7 +73,7 @@ See the \l{qtqml-main.html}{Qt QML Module Documentation} for in-depth information about using the QML language.} -\section2 What Is Qt Quick? +\section2 What is Qt Quick? Qt Quick is the standard library of types and functionality for QML. It includes visual elements, interactive elements, animations, models and views, @@ -90,24 +90,24 @@ Qt Quick.} \list \li \l{qtquick-quickstart-basics.html}{QML Basics} \list - \li \l{qtquick-quickstart-basics.html#creating-a-qml-document}{Creating A QML Document} - \li \l{qtquick-quickstart-basics.html#loading-and-displaying-the-qml-document}{Loading And Displaying The QML Document} + \li \l{qtquick-quickstart-basics.html#creating-a-qml-document}{Creating a QML Document} + \li \l{qtquick-quickstart-basics.html#loading-and-displaying-the-qml-document}{Loading and Displaying the QML Document} \endlist \li \l{qtquick-quickstart-essentials.html}{QML Essentials} \list \li \l{qtquick-quickstart-essentials.html#handling-user-input}{Handling User Input} - \li \l{qtquick-quickstart-essentials.html#property-bindings-and-animations}{Property Bindings And Animations} - \li \l{qtquick-quickstart-essentials.html#defining-custom-qml-types-for-re-use}{Defining Custom QML Types For Re-use} + \li \l{qtquick-quickstart-essentials.html#property-bindings-and-animations}{Property Bindings and Animations} + \li \l{qtquick-quickstart-essentials.html#defining-custom-qml-types-for-re-use}{Defining Custom QML Types for Re-use} \endlist \endlist \section1 Important Application Development Topics \list -\li \l{qml-intro.html}{Introduction To QML Application Development} -\li \l{qtquick-performance.html}{Performance Considerations And Suggestions} -\li \l{qtquick-internationalization.html}{Internationalization And Localization} -\li \l{qtquick-glossary.html}{Glossary Of Terms} +\li \l{qml-intro.html}{Introduction to QML Application Development} +\li \l{qtquick-performance.html}{Performance Considerations and Suggestions} +\li \l{qtquick-internationalization.html}{Internationalization and Localization} +\li \l{qtquick-glossary.html}{Glossary of Terms} \endlist \section1 Testing and Debugging diff --git a/src/quick/doc/src/appdevguide/qtquicktest.qdoc b/src/quick/doc/src/appdevguide/qtquicktest.qdoc index 50ce424..c667f14 100644 --- a/src/quick/doc/src/appdevguide/qtquicktest.qdoc +++ b/src/quick/doc/src/appdevguide/qtquicktest.qdoc @@ -27,7 +27,7 @@ /*! \page qtquick-qtquicktest.html -\inqmlmodule QtQuick 2 + \inqmlmodule QtQuick 2 \title QtQuickTest Reference Documentation \keyword QtQuickTest Reference Documentation \brief unit testing framework for QML diff --git a/src/quick/doc/src/appdevguide/quickstart/basics.qdoc b/src/quick/doc/src/appdevguide/quickstart/basics.qdoc index 7f63d53..5f9d5c0 100644 --- a/src/quick/doc/src/appdevguide/quickstart/basics.qdoc +++ b/src/quick/doc/src/appdevguide/quickstart/basics.qdoc @@ -29,7 +29,7 @@ \title Quick Start Guide - QML Basics \brief Basic QML application development examples -\section1 Creating A QML Document +\section1 Creating a QML Document A QML document defines a hierarchy of objects with a highly-readable, structured layout. Every QML document consists of two parts: an imports @@ -37,7 +37,7 @@ section and an object declaration section. The types and functionality most common to user interfaces are provided in the \l{Qt Quick Module}{QtQuick} import. -\section2 Importing And Using The QtQuick Module +\section2 Importing and Using the QtQuick Module To use the \l{Qt Quick Module}{QtQuick} module, a QML document needs to import it. The import syntax looks like this: @@ -49,7 +49,7 @@ import QtQuick 2.0 The types and functionality that \l{Qt Quick Module}{QtQuick} provides can now be used in the QML document! -\section2 Defining An Object Hierarchy +\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 @@ -77,7 +77,7 @@ which has a child \l Text object. The \c parent of the \l Text object is automatically set to the \l Rectangle, and similarly, the \l Text object is added to the \c children property of the \l Rectangle object, by QML. -\section2 Putting It Together +\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 @@ -101,7 +101,7 @@ Rectangle { If we save that document as "HelloWorld.qml" we can load and display it. -\section1 Loading And Displaying The QML Document +\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 diff --git a/src/quick/doc/src/appdevguide/quickstart/essentials.qdoc b/src/quick/doc/src/appdevguide/quickstart/essentials.qdoc index 8219bd4..0ab782b 100644 --- a/src/quick/doc/src/appdevguide/quickstart/essentials.qdoc +++ b/src/quick/doc/src/appdevguide/quickstart/essentials.qdoc @@ -153,7 +153,7 @@ Rectangle { The value being displayed will vary from 0 to 150 periodically. -\section1 Defining Custom QML Types For Re-use +\section1 Defining Custom QML Types for Re-use One of the most important concepts in QML is that of type re-use. An application will probably have multiple visual elements which are all similar diff --git a/src/quick/doc/src/qmltypereference.qdoc b/src/quick/doc/src/qmltypereference.qdoc index a2cb4df..def84a3 100644 --- a/src/quick/doc/src/qmltypereference.qdoc +++ b/src/quick/doc/src/qmltypereference.qdoc @@ -27,7 +27,7 @@ /*! \page qtquick-qmltypereference.html -\title QML Types Provided By Qt Quick +\title QML Types Provided by Qt Quick \brief Description of the QML types provided by the Qt Quick module This page contains links to documentation for every QML type provided by the @@ -112,7 +112,7 @@ User input events \li \l {LayoutMirroring} - Attached property used to mirror layout behavior \endlist -\section1 States, Transitions And Animations +\section1 States, Transitions and Animations States \list @@ -186,7 +186,7 @@ Visual object transformations \li \l {Behavior} - Triggers animations when a property value is set \endlist -\section1 Model/View Types And Data Storage And Access +\section1 Model/View Types and Data Storage and Access Models And Model Data \list @@ -214,7 +214,7 @@ Data Storage \li \l {LocalStorage} - Module API providing simplified SQL access \endlist -\section1 Particles And Graphical Effects +\section1 Particles and Graphical Effects \list \li \l {ShaderEffect} - Allows GLSL shaders to be used as graphical effects diff --git a/src/quick/doc/src/qtquick.qdoc b/src/quick/doc/src/qtquick.qdoc index f839b3a..3b980c5 100644 --- a/src/quick/doc/src/qtquick.qdoc +++ b/src/quick/doc/src/qtquick.qdoc @@ -30,7 +30,7 @@ \title Qt Quick Module \brief The Qt Quick module implements the "standard library" for QML -\section1 Overview Of The Qt Quick Module +\section1 Overview of the Qt Quick Module The Qt Quick module is the standard library for the QML language (which is defined and implemented by the \l{qtqml-main.html}{Qt QML module}). @@ -42,7 +42,7 @@ a user-interface written in Qt Quick. In summary, Qt Quick provides a library of visual types to allow building a user-interface, and the C++ API to instantiate and interact with it. -\section1 Important Concepts In Qt Quick +\section1 Important Concepts in Qt Quick Qt Quick provides everything needed to create a rich application with a fluid and dynamic user interface. It is based around behavior declaration rather @@ -56,9 +56,9 @@ a first-class concept in Qt Quick. \li \l{qtquick-positioning-topic.html}{Positioning} \li \l{qtquick-input-topic.html}{User Input} \li \l{qtquick-eventinterceptors-topic.html}{Event Interceptors} -\li \l{qtquick-statesanimations-topic.html}{States, Transitions And Animations} +\li \l{qtquick-statesanimations-topic.html}{States, Transitions and Animations} \li \l{qtquick-modelviewsdata-topic.html}{Data - Models, Views and Data Storage} -\li \l{qtquick-effects-topic.html}{Graphical Effects And Particles} +\li \l{qtquick-effects-topic.html}{Graphical Effects and Particles} \li \l{qtquick-dynamicinstantiation-topic.html}{Dynamic and Lazy Instantiation} \endlist @@ -74,15 +74,15 @@ To find out more about using the QML language, see the \l{Qt QML Module Document \list - \li \l{qtquick-qmltypereference.html}{QML Types Provided By The Qt Quick Module} + \li \l{qtquick-qmltypereference.html}{QML Types provided by the Qt Quick Module} \list \li \l{qtquick-qmltypereference.html#visual-types}{Visual Types} \li \l{qtquick-qmltypereference.html#user-input-types}{User Input Types} \li \l{qtquick-qmltypereference.html#positioning}{Positioning} - \li \l{qtquick-qmltypereference.html#states-transitions-and-animations}{States, Transitions And Animations} + \li \l{qtquick-qmltypereference.html#states-transitions-and-animations}{States, Transitions and Animations} \li \l{qtquick-qmltypereference.html#interceptors}{Interceptors} - \li \l{qtquick-qmltypereference.html#model-view-types-and-data-storage-and-access}{Model/View Types And Data Storage And Access} - \li \l{qtquick-qmltypereference.html#particles-and-graphical-effects}{Particles And Graphical Effects} + \li \l{qtquick-qmltypereference.html#model-view-types-and-data-storage-and-access}{Model/View Types and Data Storage and Access} + \li \l{qtquick-qmltypereference.html#particles-and-graphical-effects}{Particles and Graphical Effects} \li \l{qtquick-qmltypereference.html#canvas-similar-to-html5-canvas}{Canvas (similar to HTML5 Canvas)} \li \l{qtquick-qmltypereference.html#dynamic-instantiation-enablers}{Dynamic Instantiation Enablers} \endlist diff --git a/src/quick/doc/src/whatsnew.qdoc b/src/quick/doc/src/whatsnew.qdoc index 1b2a27e..d04e590 100644 --- a/src/quick/doc/src/whatsnew.qdoc +++ b/src/quick/doc/src/whatsnew.qdoc @@ -32,7 +32,7 @@ \section1 Qt 5.0 - QtQuick C++ Module -The QtQuick C++ module is new in Qt 5. It provides the visual canvas and scenegraph backend +The QtQuick C++ module is new in Qt 5. It provides the visual canvas and scenegraph back-end as well as the QtQuick QML module for QML application development. As of Qt 5, the QtQuick module is based on an OpenGL scenegraph. Many of the classes in -- 2.7.4