summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2016-10-06 10:55:03 +0200
committerMitch Curtis <mitch.curtis@qt.io>2016-10-06 11:40:48 +0000
commit2c2150c61315a1bed3f638fc228f0ef9532ecd41 (patch)
treefd8bc5a8f37cd06a420e9cc1e97ab3b912891b7c
parent822ed893ecb973f0f42cb431b42a811a2bdcaa29 (diff)
downloadqtdoc-2c2150c61315a1bed3f638fc228f0ef9532ecd41.tar.gz
Update QML Coding Conventions to mention semicolon usage
The concensus to use semicolons for blocks of code was reached on the mailing list: http://lists.qt-project.org/pipermail/development/2016-October/027441.html Change-Id: I98ce87c623c189bdfac8cfac5c0fa80e5a831c18 Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io> Reviewed-by: Robin Burchell <robin.burchell@viroteck.net> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
-rw-r--r--doc/snippets/qmlapp/codingconventions/javascript-semicolons.qml61
-rw-r--r--doc/src/qmlapp/codingconventions.qdoc5
2 files changed, 66 insertions, 0 deletions
diff --git a/doc/snippets/qmlapp/codingconventions/javascript-semicolons.qml b/doc/snippets/qmlapp/codingconventions/javascript-semicolons.qml
new file mode 100644
index 00000000..5229f189
--- /dev/null
+++ b/doc/snippets/qmlapp/codingconventions/javascript-semicolons.qml
@@ -0,0 +1,61 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, 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 The Qt Company Ltd 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.7
+
+//![0]
+MouseArea {
+ anchors.fill: parent
+ onClicked: {
+ var scenePos = mapToItem(null, mouseX, mouseY);
+ console.log("MouseArea was clicked at scene pos " + scenePos);
+ }
+}
+//![0]
diff --git a/doc/src/qmlapp/codingconventions.qdoc b/doc/src/qmlapp/codingconventions.qdoc
index 501ebfad..029bf402 100644
--- a/doc/src/qmlapp/codingconventions.qdoc
+++ b/doc/src/qmlapp/codingconventions.qdoc
@@ -103,4 +103,9 @@ For long scripts, we will put the functions in their own JavaScript file and imp
\snippet qmlapp/codingconventions/javascript-imports.qml 0
+If the code is longer than one line and hence within a block,
+we use semicolons to indicate the end of each statement:
+
+\snippet qmlapp/codingconventions/javascript-semicolons.qml 0
+
*/