summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2009-11-24 02:56:46 (GMT)
committerBea Lam <bea.lam@nokia.com>2009-11-24 02:56:46 (GMT)
commite111b77a1c1a02c3508db4981ae7daf4730f23dd (patch)
treebaa1a53c7745238d4682ee39cd03d0c21f3970c4
parent8bbbb67aa06077678a0bd865783efc1212a918c3 (diff)
downloadQt-e111b77a1c1a02c3508db4981ae7daf4730f23dd.zip
Qt-e111b77a1c1a02c3508db4981ae7daf4730f23dd.tar.gz
Qt-e111b77a1c1a02c3508db4981ae7daf4730f23dd.tar.bz2
Minor doc improvements
-rw-r--r--doc/src/declarative/qmldocument.qdoc4
-rw-r--r--doc/src/declarative/qmlintro.qdoc24
-rw-r--r--doc/src/declarative/scope.qdoc20
3 files changed, 24 insertions, 24 deletions
diff --git a/doc/src/declarative/qmldocument.qdoc b/doc/src/declarative/qmldocument.qdoc
index 2775ea6..453c023 100644
--- a/doc/src/declarative/qmldocument.qdoc
+++ b/doc/src/declarative/qmldocument.qdoc
@@ -44,9 +44,9 @@
\title QML Documents
A QML document is a block of QML source code. QML documents generally correspond to files
-stored on a disk or network resource, but can be constructed directly from text data.
+stored on a disk or network resource, but can also be constructed directly from text data.
-A simple QML document looks like this:
+Here is a simple QML document:
\code
import Qt 4.6
diff --git a/doc/src/declarative/qmlintro.qdoc b/doc/src/declarative/qmlintro.qdoc
index f84d614..a97d0d1 100644
--- a/doc/src/declarative/qmlintro.qdoc
+++ b/doc/src/declarative/qmlintro.qdoc
@@ -48,7 +48,7 @@
\section1 What is QML?
QML is a declarative language designed to describe the user interface of a
-program: both what it looks like and how it behaves. In QML, a user
+program: both what it looks like, and how it behaves. In QML, a user
interface is specified as a tree of objects with properties.
\section1 What should I know before starting?
@@ -56,8 +56,8 @@ interface is specified as a tree of objects with properties.
This introduction is meant for those with little or no programming
experience. JavaScript is used as a scripting language in QML, so you may want
to learn a bit more about it (\l{JavaScript: The Definitive Guide}) before diving
-too deep into QML. It's also helpful to have a basic understanding of other web
-technologies like HTML and CSS, but not required.
+deeper into QML. It's also helpful to have a basic understanding of other web
+technologies like HTML and CSS, but it's not required.
\section1 Basic QML Syntax
@@ -131,18 +131,18 @@ Item {
}
\endcode
-In the example above, the Text2 object will display the same text as Text1. If Text1 is updated,
-Text2 will be updated as well.
+In the example above, the \c text2 object will display the same text as \c text1. If \c text1 is changed,
+\c text2 is automatically changed to the same value.
-Note that to refer to other objects, we use their \e id (more information on the id property can be
-found in a following section).
+Note that to refer to other objects, we use their \e id values. (See below for more
+information on the \e id property.)
\section1 QML Comments
Commenting in QML is similar to JavaScript.
\list
-\o Single line comments begin with // and end at the end of the line.
-\o Multiline comments begin with /* and end with *\/
+\o Single line comments start with // and finish at the end of the line.
+\o Multiline comments start with /* and finish with *\/
\endlist
\quotefile doc/src/snippets/declarative/comments.qml
@@ -173,7 +173,7 @@ Properties begin with a lowercase letter (with the exception of \l{Attached Prop
\section2 Property types
-QML supports properties of many types (\l{Common QML Types}). The basic types include int,
+QML supports properties of many types (see \l{Common QML Types}). The basic types include int,
real, bool, string, color, and lists.
\code
@@ -186,12 +186,12 @@ Item {
\endcode
QML properties are what is known as \e typesafe. That is, they only allow you to assign a value that
-matches the property type. For example, the scale property of item is a real, and if you try to assign
+matches the property type. For example, the \c x property of item is a real, and if you try to assign
a string to it you will get an error.
\badcode
Item {
- scale: "hello" //illegal!
+ x: "hello" // illegal!
}
\endcode
diff --git a/doc/src/declarative/scope.qdoc b/doc/src/declarative/scope.qdoc
index fc678d1..f7f25f5 100644
--- a/doc/src/declarative/scope.qdoc
+++ b/doc/src/declarative/scope.qdoc
@@ -44,7 +44,7 @@
\title QML Scope
\l {Property Binding}s and \l {ECMAScript Blocks} are executed in a scope chain automatically
-established by QML when constructing a component instance. QML is a \e {dynamically scoped}
+established by QML when a component instance is constructed. QML is a \e {dynamically scoped}
language. Different object instances instantiated from the same component can exist in
different scope chains.
@@ -91,8 +91,8 @@ Text {
\section1 QML Local Scope
Most variables references are resolved in the local scope. The local scope is controlled by the
-QML component in which the binding or script block was declarated. The following example shows
-three different bindings, and the component that dictates their local scope.
+QML component in which the binding or script block was defined. The following example shows
+three different bindings, and the component that dictates each local scope.
\table
\row
@@ -135,15 +135,15 @@ Rectangle { // Local scope component for binding 3
\endcode
\endtable
-Inside the local scope, four "sub-scopes" exist. Each "sub-scope" is searched in order when
-resolving a name - names in a higher "sub-scopes" shadow those in lower sub-scopes.
+Inside the local scope, four "sub-scopes" exist. Each sub-scope is searched in order when
+resolving a name; names in higher sub-scopes shadow those in lower sub-scopes.
\section2 IDs
IDs present in the component take precendence over other names. The QML engine enforces
uniqueness of IDs within a component, so their names cannot conflict with one another.
-This is an example of using IDs within bindings.
+Here is an example of using IDs within bindings:
\code
Item {
@@ -192,7 +192,7 @@ scope object appear in the scope chain, immediately after \l {Script Methods}.
In bindings and script blocks established explicitly in \l {QML Documents}, the scope object is
always the element containing the binding or script block. The following example shows two
bindings, one using grouped properties, and the corresponding scope object. These two bindings
-use the scope object to resolve variable references - \c height is a property on \l Rectangle,
+use the scope object to resolve variable references: \c height is a property on \l Rectangle,
and \c parent is a property on \l Text.
\code
@@ -269,7 +269,7 @@ Item {
\section1 QML Component chain
When a QML component is instantiated it is given a parent component instance. The parent
-component instance is immutable - it is not effected, for example, by changes in the instance's
+component instance is immutable - it is not affected, for example, by changes in the instance's
visual parent (in the case of visual elements). Should name resolution fail within the
\l {QML Local Scope}, this parent chain is searched.
@@ -283,8 +283,8 @@ For each component instance in the chain, the following are examined:
This list is a sub-set of that in the \l {QML Local Scope}.
-Sub-components used within a component have their parent component instance set to the component
-instance that created them. In the following example, the two \c Button instances have the
+A sub-component's parent component instance is set to the component that created it.
+In the following example, the two \c Button instances have the
\c main.qml instance as their parent component instance. If the \c Button type was used from
within another QML file, it may have a difference parent component instance, and consequently
the \c buttonClicked() method may resolve differently.