summaryrefslogtreecommitdiffstats
path: root/doc/src/declarative
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@nokia.com>2010-12-06 16:43:31 (GMT)
committerJerome Pasion <jerome.pasion@nokia.com>2010-12-06 16:44:49 (GMT)
commit1eb7dca7fe6a81bada556c1310905be08e1b1d10 (patch)
tree379d783bd15d9591783d54680bd240dc389f27f5 /doc/src/declarative
parent686dfda2146a84e6653faa56a1484e84571cc4fa (diff)
downloadQt-1eb7dca7fe6a81bada556c1310905be08e1b1d10.zip
Qt-1eb7dca7fe6a81bada556c1310905be08e1b1d10.tar.gz
Qt-1eb7dca7fe6a81bada556c1310905be08e1b1d10.tar.bz2
Added QML coding convention for "private" properties.
Private properties start with two underscores. __property Reviewed-by: David Boddie
Diffstat (limited to 'doc/src/declarative')
-rw-r--r--doc/src/declarative/codingconventions.qdoc18
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/src/declarative/codingconventions.qdoc b/doc/src/declarative/codingconventions.qdoc
index ba789e0..3f92d46 100644
--- a/doc/src/declarative/codingconventions.qdoc
+++ b/doc/src/declarative/codingconventions.qdoc
@@ -35,7 +35,7 @@ This page assumes that you are already familiar with the QML language.
If you need an introduction to the language, please read \l {Introduction to the QML language}{the QML introduction} first.
-\section1 QML objects
+\section1 QML Objects
Through our documentation and examples, QML objects are always structured in the following order:
@@ -58,7 +58,7 @@ For example, a hypothetical \e photo QML object would look like this:
\snippet doc/src/snippets/declarative/codingconventions/photo.qml 0
-\section1 Grouped properties
+\section1 Grouped Properties
If using multiple properties from a group of properties,
we use the \e {group notation} rather than the \e {dot notation} to improve readability.
@@ -72,6 +72,18 @@ can be written like this:
\snippet doc/src/snippets/declarative/codingconventions/dotproperties.qml 1
+\section1 Private Properties
+
+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
+\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.
+
+\snippet doc/src/snippets/declarative/codingconventions/private.qml 0
+
+
\section1 Lists
If a list contains only one element, we generally omit the square brackets.
@@ -87,7 +99,7 @@ we will write this:
\snippet doc/src/snippets/declarative/codingconventions/lists.qml 1
-\section1 JavaScript code
+\section1 JavaScript Code
If the script is a single expression, we recommend writing it inline: