aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick
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
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')
-rw-r--r--src/quick/doc/snippets/qml/codingconventions/private.qml49
-rw-r--r--src/quick/doc/src/appdevguide/codingconventions.qdoc17
2 files changed, 3 insertions, 63 deletions
diff --git a/src/quick/doc/snippets/qml/codingconventions/private.qml b/src/quick/doc/snippets/qml/codingconventions/private.qml
deleted file mode 100644
index 6aeaa5a6e8..0000000000
--- a/src/quick/doc/snippets/qml/codingconventions/private.qml
+++ /dev/null
@@ -1,49 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** You may use this file under the terms of the BSD license as follows:
-**
-** "Redistribution and use in source and binary forms, with or without
-** modification, are permitted provided that the following conditions are
-** met:
-** * Redistributions of source code must retain the above copyright
-** notice, this list of conditions and the following disclaimer.
-** * Redistributions in binary form must reproduce the above copyright
-** notice, this list of conditions and the following disclaimer in
-** the documentation and/or other materials provided with the
-** distribution.
-** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
-** the names of its contributors may be used to endorse or promote
-** products derived from this software without specific prior written
-** permission.
-**
-** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-import QtQuick 2.0
-
-//! [0]
-Item {
- id: component
- width: 40; height: 50
- property real __area: width * height * 0.5 // not meant for outside use
-}
-//! [0]
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.