summaryrefslogtreecommitdiffstats
path: root/doc/src/howtos/qmlbestpractices
diff options
context:
space:
mode:
authorhjk <qthjk@ovi.com>2012-12-11 10:47:50 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-12-11 11:53:10 +0100
commitcd3a7bd9853b7cf87bb3bb0b24f95e0d49e38131 (patch)
tree71db3c2b560906f6e6c6fe1517fff56a02517cd6 /doc/src/howtos/qmlbestpractices
parent7a36fbd462f14f735e772b611a2c2b1c2976eba0 (diff)
Add qtdeclarative.qdocconf to get a example_manifest.xml
Change-Id: I52b87947559c10d3e60af81fe8d4f3189dd1614e Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'doc/src/howtos/qmlbestpractices')
-rw-r--r--doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc97
-rw-r--r--doc/src/howtos/qmlbestpractices/qmlbestpractices-datatypes.qdoc49
2 files changed, 0 insertions, 146 deletions
diff --git a/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc b/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc
deleted file mode 100644
index ffa013f5..00000000
--- a/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc
+++ /dev/null
@@ -1,97 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/legal
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** 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 Digia. For licensing terms and
-** conditions see http://qt.digia.com/licensing. For further information
-** use the contact form at http://qt.digia.com/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
-\page qml-best-practices-coding.html
-\ingroup qml-best-practices
-\contentspage QML Best Practices Guides
-\previouspage QML Best Practices Guides
-\startpage QML Best Practices Guides
-\title QML Best Practices: Coding Conventions
-
-\brief QML Coding Conventions and Importing Files
-
-There are many different ways to code using QML. These are a set of
-guidelines to help your code look better and consistent.
-
-\section1 Coding Conventions
-
-The official QML Coding Conventions may be found at
-\l {QML Coding Conventions}. This is the recommended convention that will be
-used throughout the QML documentation.
-
-In addition, Qt's official code style may be found at the \l {Qt Coding Style}.
-
-\section1 Importing Files into QML
-
-To import items such as directories, use the "import" keyword, similar to
-the way the \c {import QtQuick 1.0} statement is used.
-
-\snippet doc/src/snippets/declarative/imports/best-practices.qml imports
-
-To facilitate the import of QML components, it is best to begin the QML
-file with an uppercase character. This way, the user can simply declare the
-component using the file name as the component name. For example, if a QML
-component is in a file named \c Button.qml, then the user may import the
-component by declaring a \c {Button {}}. Note that this method only works if
-the QML files are in the same directory.
-
-It is also possible to import QML files which have file names that begin in
-lower case or files in a different directory by using a \c qmldir file.
-
-A \c qmldir file tells your QML application which QML components, plugins,
-or directories to import. The \c qmldir file must reside in an imported
-directory. By using the \c qmldir file, users may import any QML file and assign any
-valid QML component name to the component.
-
-For more information, read the section on
-\l{qml-loading-components}{Loading a Component}.
-
-\section1 Commenting Code
-
-Commenting code allows others to read the source code better. As well, comments
-allow the programmer to think about his or her code; a confusing comment may
-mean the code is confusing.
-
-Similar to JavaScript or C++, there are two ways of commenting QML code:
-\list
-\li Single line comments start with \c{//} and finish at the end of the line
-\li Multiline comments start with \c{/*} and finish with *\/
-\endlist
-
-\section1 Group Properties
-
-Many QML properties are \l{attached-properties}{attached} or
-\l {qml-grouped-properties}{group} properties. For convenience, you may treat
-them as another element when dealing with multiple properties belonging to the
-same group.
-
-\snippet doc/src/snippets/declarative/bestpractices/group.qml not grouped
-Treating groups of properties as a block can ease confusion and help relate the
-properties with other properties.
-\snippet doc/src/snippets/declarative/bestpractices/group.qml grouped
-*/
diff --git a/doc/src/howtos/qmlbestpractices/qmlbestpractices-datatypes.qdoc b/doc/src/howtos/qmlbestpractices/qmlbestpractices-datatypes.qdoc
deleted file mode 100644
index 518f76e4..00000000
--- a/doc/src/howtos/qmlbestpractices/qmlbestpractices-datatypes.qdoc
+++ /dev/null
@@ -1,49 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/legal
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** 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 Digia. For licensing terms and
-** conditions see http://qt.digia.com/licensing. For further information
-** use the contact form at http://qt.digia.com/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-/*!
- \page qml-best-practices-datatypes.html
- \ingroup qml-best-practices
- \contentspage QML Best Practices Guides
- \previouspage QML Best Practices Guides
- \startpage QML Best Practices Guides
- \title QML Best Practices: Data Types
-
- \brief Using Basic Data Types and Custom Types in QML
-
- QML supports many basic data types, Qt data types, and custom data types.
-
- \section1 Basic Data Types
-
- \section1 Qt Data Types
-
- \section1 Exporting Qt Types to QML
-
- Programmers may create C++ data structures and expose them to QML, making
- data accessible from QML.
-
- \section2 Using QStringLists in QML
-*/