/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** 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 The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
/*!
    \contentspage list-of-items.html
    \previouspage module-item.html
    \page probe-item.html
    \nextpage product-item.html
    \ingroup list-of-items

    \title Probe Item
    \brief Locates files outside the project.

    A \c Probe item can appear inside a \l{Product Item} and is run prior to building products in
    order to locate dependent headers, libraries, and other files outside the project directory
    whose locations are not known ahead of time. \c Probes are similar to configure scripts.
    \note Because Probes often invoke external processes, which is relatively expensive compared
          to evaluating normal properties, their results are cached. To force re-evaluation
          of a Probe, you can supply the \c{--force-probe-execution} command-line option.

    \section1 Probe Properties

    \table
    \header
        \li Property
        \li Type
        \li Default
        \li Description
    \row
        \li condition
        \li bool
        \li true
        \li Determines whether the probe will actually be run.
    \row
        \li found
        \li bool
        \li undefined
        \li Indicates whether the probe was run successfully. Set by \c configure.
    \row
        \li configure
        \li script
        \li undefined
        \li Script that is executed when the probe is run.
    \endtable

*/
