summaryrefslogtreecommitdiff
path: root/doc/reference
diff options
context:
space:
mode:
authorJoerg Bornemann <joerg.bornemann@digia.com>2013-10-10 12:55:48 +0200
committerJoerg Bornemann <joerg.bornemann@digia.com>2013-10-10 14:41:15 +0200
commit92b0191f2847c7bc57da12e3890c85f55cc162a0 (patch)
tree23c2a72d0576a01be17ab95cb3640525f2057d6b /doc/reference
parent8d459124cbf7b689970e1d8958e9c6aeed49b3ad (diff)
downloadqbs-92b0191f2847c7bc57da12e3890c85f55cc162a0.tar.gz
Doc: add rudimentary Module item reference
Change-Id: I763486128efbc6e49e3bdb4d563444cee0851ffc Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/items/group.qdoc2
-rw-r--r--doc/reference/items/module.qdoc70
-rw-r--r--doc/reference/items/product.qdoc2
3 files changed, 72 insertions, 2 deletions
diff --git a/doc/reference/items/group.qdoc b/doc/reference/items/group.qdoc
index db16612d0..17eb57799 100644
--- a/doc/reference/items/group.qdoc
+++ b/doc/reference/items/group.qdoc
@@ -31,7 +31,7 @@
\contentspage list-of-items.html
\previouspage filetagger-item.html
\page group-item.html
- \nextpage product-item.html
+ \nextpage module-item.html
\ingroup list-of-items
\title Group Item
diff --git a/doc/reference/items/module.qdoc b/doc/reference/items/module.qdoc
new file mode 100644
index 000000000..3f5bab634
--- /dev/null
+++ b/doc/reference/items/module.qdoc
@@ -0,0 +1,70 @@
+/****************************************************************************
+**
+** 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
+ \previouspage group-item.html
+ \page module-item.html
+ \nextpage product-item.html
+ \ingroup list-of-items
+
+ \title Module Item
+ \brief Represents a collection of properties and items that can be loaded into a product.
+
+ A \c Module item is a collection of properties and language items that are used for building a
+ product if the product depends on (or loads) the module.
+
+ A Module can be loaded by adding a dependency to it in a product.
+ For example, the following product will load the \c cpp module:
+ \code
+ Product {
+ Depends { name: "cpp" }
+ ...
+ }
+ \endcode
+
+ \table
+ \header
+ \li Property
+ \li Type
+ \li Default
+ \li Description
+ \row
+ \li setupBuildEnvironment
+ \li script
+ \li \c undefined
+ \li Script for setting up the environment in which the project is built.
+ Use the \c putenv and \c getenv functions to alter the environment.
+ The return value of this script is ignored.
+ \row
+ \li setupRunEnvironment
+ \li script
+ \li \c setupBuildEnvironment
+ \li Script for setting up the environment in which the project is run.
+ \endtable
+*/
diff --git a/doc/reference/items/product.qdoc b/doc/reference/items/product.qdoc
index 3172e06c9..8015f0269 100644
--- a/doc/reference/items/product.qdoc
+++ b/doc/reference/items/product.qdoc
@@ -28,7 +28,7 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage group-item.html
+ \previouspage module-item.html
\page product-item.html
\nextpage project-item.html
\ingroup list-of-items