/****************************************************************************
**
** Copyright (C) 2014 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 staticlibrary-item.html
    \page subproject-item.html
    \nextpage transformer-item.html
    \ingroup list-of-items

    \title SubProject Item
    \brief Adds a project from a different file.

    A \c SubProject item is used to add a project defined in another file as a sub-project to
    the surrounding project:
    \code
    SubProject {
        filePath: "subdir/project.qbs"
        Properties {
            name: "A sub-project"
        }
    }
    \endcode

    If you don't need to set any properties on the sub-project, you can also use the \c references
    property, the same way you would do for a product:
    \code
    references: "subdir/project.qbs"
    \endcode

    It is also possible to nest \c Project items directly in the same file.

    \table
        \header
            \li Property
            \li Type
            \li Default
            \li Description
        \row
            \li filePath
            \li path
            \li empty
            \li The file path of the project to add as a sub-project. If the top-level item in this
                file is a \c Product, it gets wrapped automatically in a new project.
        \row
            \li inheritProperties
            \li bool
            \li true
            \li Whether the sub-project should inherit the properties of the surrounding project.
                You can use this feature to share "global" settings between (sub-)projects.
    \endtable
*/
