aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/qml/codingconventions.qdoc
diff options
context:
space:
mode:
authorKent Hansen <kent.hansen@nokia.com>2012-03-19 12:29:32 +0100
committerKent Hansen <kent.hansen@nokia.com>2012-03-19 12:37:03 +0100
commit4821058f10118be55a541ad39e25ec9165cca3b3 (patch)
tree167973e3c68fc442b0e37d6f628f3fdbe759f15a /doc/src/qml/codingconventions.qdoc
parent83f11e33745180e9370d484cbcedd0bac020c9dd (diff)
parent26d5f2e833f0e3686aaa27e695bbfab5fbd808ad (diff)
Merge master into api_changes
Conflicts: src/qml/debugger/qqmlenginedebugservice.cpp src/qml/qml/v8/qv8qobjectwrapper.cpp src/quick/util/qquickimageprovider.cpp tests/auto/qml/qqmlecmascript/tst_qqmlecmascript.cpp Change-Id: Ie78ba2fabd32f4812bcae9dbdd66ed289dc11dcb
Diffstat (limited to 'doc/src/qml/codingconventions.qdoc')
-rw-r--r--doc/src/qml/codingconventions.qdoc22
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/src/qml/codingconventions.qdoc b/doc/src/qml/codingconventions.qdoc
index 9e1ce34c2c..92d8ee112a 100644
--- a/doc/src/qml/codingconventions.qdoc
+++ b/doc/src/qml/codingconventions.qdoc
@@ -37,20 +37,20 @@ This document contains the QML coding conventions that we follow in our document
Through our documentation and examples, QML objects are always structured in the following order:
\list
-\o id
-\o property declarations
-\o signal declarations
-\o JavaScript functions
-\o object properties
-\o child objects
-\o states
-\o transitions
+\li id
+\li property declarations
+\li signal declarations
+\li JavaScript functions
+\li object properties
+\li child objects
+\li states
+\li transitions
\endlist
For better readability, we separate these different parts with an empty line.
-For example, a hypothetical \i photo QML object would look like this:
+For example, a hypothetical \e photo QML object would look like this:
\snippet doc/src/snippets/qml/codingconventions/photo.qml 0
@@ -58,7 +58,7 @@ For example, a hypothetical \i photo QML object would look like this:
\section1 Grouped Properties
If using multiple properties from a group of properties,
-we use the \i {group notation} rather than the \i {dot notation} to improve readability.
+we use the \e {group notation} rather than the \e {dot notation} to improve readability.
For example, this:
@@ -74,7 +74,7 @@ can be written like this:
QML and JavaScript do not enforce private properties like C++. There is a need
to hide these private properties, for example, when the properties are part of
the implementation. As a convention, private properties begin with two
-\i underscore characters. For example, \c __area, is a property that is
+\e underscore characters. For example, \c __area, is a property that is
accessible but is not meant for public use. Note that QML and JavaScript will
grant the user access to these properties.