aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@digia.com>2013-12-06 14:34:29 +0100
committerChristian Kandeler <christian.kandeler@digia.com>2013-12-12 11:13:25 +0100
commit32b7a5042535262501af40acb0fe7219608d70a9 (patch)
tree533f2ddb4754e804eb6fe0114557ff8b8b60eedc
parent928f81c194d43155d50f654df70347405ad236ff (diff)
Docs: Add documentation for convenience items.
Change-Id: I835d1ed8835577fab5434ae89c058fc710d708b1 Reviewed-by: Jake Petroules <jake.petroules@petroules.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
-rw-r--r--doc/reference/items/application.qdoc57
-rw-r--r--doc/reference/items/artifact.qdoc3
-rw-r--r--doc/reference/items/cppapplication.qdoc44
-rw-r--r--doc/reference/items/depends.qdoc4
-rw-r--r--doc/reference/items/dynamiclibrary.qdoc57
-rw-r--r--doc/reference/items/export.qdoc2
-rw-r--r--doc/reference/items/rule.qdoc2
-rw-r--r--doc/reference/items/staticlibrary.qdoc46
-rw-r--r--doc/reference/items/subproject.qdoc2
9 files changed, 211 insertions, 6 deletions
diff --git a/doc/reference/items/application.qdoc b/doc/reference/items/application.qdoc
new file mode 100644
index 000000000..ebbfec4a0
--- /dev/null
+++ b/doc/reference/items/application.qdoc
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+/*!
+ \contentspage list-of-items.html
+ \page application-item.html
+ \nextpage artifact-item.html
+ \ingroup list-of-items
+
+ \title Application Item
+ \brief Represents a product of application type.
+
+ An \c Application item is a \c Product that has its type set to "application"
+ (or "applicationbundle" on Darwin platforms such as OS X and iOS). It exists for the convenience
+ of project file authors.
+
+ \section1 Application Properties
+ The following properties are available in addition to the ones inherited from \c Product.
+
+ \table
+ \header
+ \li Property
+ \li Type
+ \li Default
+ \li Description
+ \row
+ \li bundleExtension
+ \li string
+ \li empty
+ \li The extension to use for the product's bundle. Only relevant on Darwin systems.
+ \endtable
+*/
diff --git a/doc/reference/items/artifact.qdoc b/doc/reference/items/artifact.qdoc
index f136e2201..ca3a79a8b 100644
--- a/doc/reference/items/artifact.qdoc
+++ b/doc/reference/items/artifact.qdoc
@@ -30,7 +30,8 @@
/*!
\contentspage list-of-items.html
\page artifact-item.html
- \nextpage depends-item.html
+ \previouspage application-item.html
+ \nextpage cppapplication-item.html
\ingroup list-of-items
\title Artifact Item
diff --git a/doc/reference/items/cppapplication.qdoc b/doc/reference/items/cppapplication.qdoc
new file mode 100644
index 000000000..0534b887d
--- /dev/null
+++ b/doc/reference/items/cppapplication.qdoc
@@ -0,0 +1,44 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+/*!
+ \contentspage list-of-items.html
+ \page cppapplication-item.html
+ \previouspage artifact-item.html
+ \nextpage depends-item.html
+ \ingroup list-of-items
+
+ \title CppApplication Item
+ \brief Represents a product of application type with a dependency to the cpp module.
+
+ A \c CppApplication is a convenience item that is entirely equivalent to the following:
+ \code
+ Application {
+ Depends { name: "cpp" } }
+ \endcode
+*/
diff --git a/doc/reference/items/depends.qdoc b/doc/reference/items/depends.qdoc
index 2e60eed47..1bb7c0142 100644
--- a/doc/reference/items/depends.qdoc
+++ b/doc/reference/items/depends.qdoc
@@ -29,9 +29,9 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage artifact-item.html
+ \previouspage cppapplication-item.html
\page depends-item.html
- \nextpage export-item.html
+ \nextpage dynamiclibrary-item.html
\ingroup list-of-items
\title Depends Item
diff --git a/doc/reference/items/dynamiclibrary.qdoc b/doc/reference/items/dynamiclibrary.qdoc
new file mode 100644
index 000000000..8001af019
--- /dev/null
+++ b/doc/reference/items/dynamiclibrary.qdoc
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+/*!
+ \contentspage list-of-items.html
+ \page dynamiclibrary-item.html
+ \previouspage depends-item.html
+ \nextpage export-item.html
+ \ingroup list-of-items
+
+ \title DynamicLibrary Item
+ \brief Represents a product that is a dynamic library.
+
+ A \c DynamicLibrary item is a \c Product that has its type set to "dynamiclibrary". It exists
+ for the convenience of project file authors.
+
+ \section1 DynamicLibrary Properties
+ The following properties are available in addition to the ones inherited from \c Product.
+
+ \table
+ \header
+ \li Property
+ \li Type
+ \li Default
+ \li Description
+ \row
+ \li bundleExtension
+ \li string
+ \li empty
+ \li The extension to use for the product's bundle. Only relevant on Darwin systems.
+ \endtable
+*/
diff --git a/doc/reference/items/export.qdoc b/doc/reference/items/export.qdoc
index d37514dfa..633bdaca7 100644
--- a/doc/reference/items/export.qdoc
+++ b/doc/reference/items/export.qdoc
@@ -28,7 +28,7 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage depends-item.html
+ \previouspage dynamiclibrary-item.html
\page export-item.html
\nextpage filetagger-item.html
\ingroup list-of-items
diff --git a/doc/reference/items/rule.qdoc b/doc/reference/items/rule.qdoc
index aca2acbb9..d23b90e93 100644
--- a/doc/reference/items/rule.qdoc
+++ b/doc/reference/items/rule.qdoc
@@ -30,7 +30,7 @@
\contentspage list-of-items.html
\previouspage propertyoptions-item.html
\page rule-item.html
- \nextpage subproject-item.html
+ \nextpage staticlibrary-item.html
\ingroup list-of-items
\title Rule Item
diff --git a/doc/reference/items/staticlibrary.qdoc b/doc/reference/items/staticlibrary.qdoc
new file mode 100644
index 000000000..b9ac04265
--- /dev/null
+++ b/doc/reference/items/staticlibrary.qdoc
@@ -0,0 +1,46 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+/*!
+ \contentspage list-of-items.html
+ \page staticlibrary-item.html
+ \previouspage rule-item.html
+ \nextpage subproject-item.html
+ \ingroup list-of-items
+
+ \title StaticLibrary Item
+ \brief Represents a product that is a static library.
+
+ A \c StaticLibrary item is a convenience item that is entirely equivalent to
+ the following:
+ \code
+ Product {
+ type: "staticlibrary"
+ }
+ \endcode
+*/
diff --git a/doc/reference/items/subproject.qdoc b/doc/reference/items/subproject.qdoc
index c89807ded..2be7b0ac0 100644
--- a/doc/reference/items/subproject.qdoc
+++ b/doc/reference/items/subproject.qdoc
@@ -28,7 +28,7 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage rule-item.html
+ \previouspage staticlibrary-item.html
\page subproject-item.html
\nextpage transformer-item.html
\ingroup list-of-items