aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/appdevguide
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2012-08-23 14:16:11 +1000
committerQt by Nokia <qt-info@nokia.com>2012-08-24 02:52:30 +0200
commit8fe246768fb5305b64810bff8ce8b21e2234e4e1 (patch)
tree1156155232ca218546b4b8027e35becae55ca4a5 /src/quick/doc/src/appdevguide
parentfb2961b14ced82e05ae1fbfaf3b4e4c10c3b4d66 (diff)
Improvements for coding conventions docs
Shouldn't advise using "__" for "private" properties since this mightn't be the best solution. This doesn't work with the onXChanged handler syntax. Also grouped and dot property syntax are both valid. We use both throughout our code. Change-Id: Ibd86f20136dc0e7225558e234afb79f566ca1039 Reviewed-by: Yann Bodson <yann.bodson@nokia.com>
Diffstat (limited to 'src/quick/doc/src/appdevguide')
-rw-r--r--src/quick/doc/src/appdevguide/codingconventions.qdoc17
1 files changed, 3 insertions, 14 deletions
diff --git a/src/quick/doc/src/appdevguide/codingconventions.qdoc b/src/quick/doc/src/appdevguide/codingconventions.qdoc
index cf653f8116..a1ffc01a8b 100644
--- a/src/quick/doc/src/appdevguide/codingconventions.qdoc
+++ b/src/quick/doc/src/appdevguide/codingconventions.qdoc
@@ -58,29 +58,18 @@ For example, a hypothetical \e photo QML object would look like this:
\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.
+consider using \e {group notation} instead of \e {dot notation} if it
+improves readability.
For example, this:
\snippet qml/codingconventions/dotproperties.qml 0
-can be written like this:
+could be written like this:
\snippet qml/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 qml/codingconventions/private.qml 0
-
-
\section1 Lists
If a list contains only one element, we generally omit the square brackets.