diff options
author | Christian Kandeler <christian.kandeler@digia.com> | 2013-07-25 15:30:17 +0200 |
---|---|---|
committer | Joerg Bornemann <joerg.bornemann@digia.com> | 2013-09-19 11:31:44 +0200 |
commit | 1f993c4cfe232a3596a32d64207d67cb1cdb49a3 (patch) | |
tree | 0516859156c5b24a87335a2ec58917d86bbfd489 /doc/reference/items/export.qdoc | |
parent | 79fe9d097c6923f93fc5e477556fb6e2e33539c1 (diff) |
Restructure the reference part of the documentation.
It does not scale to repeat the whole contents of the reference manually in
several tables of contents. Instead, make it opaque at the top-level
and use the \group feature to get at least an automatic table of contents
for the lowest level (items and modules at the moment).
Change-Id: I80a3334a43f62481f74c21ad9d68e913c8b3098a
Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
Diffstat (limited to 'doc/reference/items/export.qdoc')
-rw-r--r-- | doc/reference/items/export.qdoc | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/reference/items/export.qdoc b/doc/reference/items/export.qdoc new file mode 100644 index 000000000..7e3f46b88 --- /dev/null +++ b/doc/reference/items/export.qdoc @@ -0,0 +1,62 @@ +/**************************************************************************** +** +** 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 export-item.html + \nextpage filetagger-item.html + \ingroup list-of-items + + \title Export Item + \brief Exports dependencies and properties to other products. + + An \c Export item can appear inside a \l{Product Item}. The properties attached to it will + take effect in all products that depend on the product inside which the product module is defined. + As an example, consider these two products: + \code + Product { + name: "A" + Export { + Depends { name: "cpp" } + cpp.includePaths: "." + } + } + + Product { + name: "B" + Depends { name: "A" } + } + \endcode + + The sources in product B will be able to use headers from product A without specifiying + the full path to them, because the include path has been made known to the compiler via + A's product module. + + \note This relationship is transitive, so a product C depending on product B will also + get the include paths via A's product module. +*/ |