diff options
author | Christian Kandeler <christian.kandeler@digia.com> | 2013-10-31 16:57:33 +0100 |
---|---|---|
committer | Christian Kandeler <christian.kandeler@digia.com> | 2013-11-01 10:00:10 +0100 |
commit | d9908ae79cf1176722a3638c0dd9ca293dfd2ac7 (patch) | |
tree | cb6b37072aa6d2f6ba4d22d672553e24c9928594 | |
parent | 7f0cc84396dd3d729200d3c99aae6358b9ed647e (diff) |
Add documentation for "global" built-in functions.
Change-Id: Iba2a19d182da70b761f33532d47b0c43dfbf6ae5
Reviewed-by: Jake Petroules <jake.petroules@petroules.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
-rw-r--r-- | doc/reference/jsextensions/jsextensions-general.qdoc | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/reference/jsextensions/jsextensions-general.qdoc b/doc/reference/jsextensions/jsextensions-general.qdoc new file mode 100644 index 000000000..d503f6c8c --- /dev/null +++ b/doc/reference/jsextensions/jsextensions-general.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 index.html + \page jsextensions-general.html + \ingroup list-of-builtin-services + + \title General Services + \brief Provides various operations. + + These are operations that do not fit into any of the other categories. + They are automatically available in any qbs project file. + + \section1 Available Operations + + \section2 getenv + \code + qbs.getenv(name) + \endcode + Tries to find a variable with the given name in the build environment and returns its value. If + no such variable could be found, \c undefined is returned. + + \section2 getHostOS + \code + qbs.getHostOS(name) + \endcode + Returns the name of the operating system on which qbs is running. + \note Do not confuse this with the \c{qbs.targetOS} property, which represents the operating + system on which the binaries produced by qbs will run. +*/ |