diff options
author | Jake Petroules <jake.petroules@theqtcompany.com> | 2015-11-11 19:23:37 -0800 |
---|---|---|
committer | Jake Petroules <jake.petroules@theqtcompany.com> | 2015-11-27 10:26:08 +0000 |
commit | a08c71b90d7dc88fd4175bb64797a43254cc14d7 (patch) | |
tree | 667f75eb37e5e6f21f5295809ec8ee4482c1641e /doc/reference/jsextensions | |
parent | 8035c6a5babd0e41e54dc7bce06842978a34cbd9 (diff) |
Move global auxiliary functions into a new Utilities extension.
Change-Id: If0f12b9d28b83080f4435d91b55d70d5cff5d42e
Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
Diffstat (limited to 'doc/reference/jsextensions')
-rw-r--r-- | doc/reference/jsextensions/jsextension-utilities.qdoc | 59 | ||||
-rw-r--r-- | doc/reference/jsextensions/jsextensions-general.qdoc | 17 |
2 files changed, 59 insertions, 17 deletions
diff --git a/doc/reference/jsextensions/jsextension-utilities.qdoc b/doc/reference/jsextensions/jsextension-utilities.qdoc new file mode 100644 index 000000000..3f9b8c40c --- /dev/null +++ b/doc/reference/jsextensions/jsextension-utilities.qdoc @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing +** +** 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 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 index.html + \page jsextension-utilities.html + \ingroup list-of-builtin-services + + \title Utilities Service + \brief Provides miscellaneous operations. + + The \c Utilities service offers miscellaneous operations. + + \section1 Available Operations + + \section2 getHash + \code + Utilities.getHash(key: string): string + \endcode + Calculates a 16-byte hash of the input and returns it. + Rules in modules should use this function to find unique locations for output + artifacts in the build directory without duplicating the whole directory structure of + the respective input file (to deal with the case of two files with the same name in different + subdirectories of the same product). + + \section2 rfc1034Identifier + \code + Utilities.rfc1034Identifier(str: string): string + \endcode + Returns an RFC 1034 compliant identifier based on the given string by replacing each character + that is not Latin alphanumeric or \c{.} with \c{-}. +*/ diff --git a/doc/reference/jsextensions/jsextensions-general.qdoc b/doc/reference/jsextensions/jsextensions-general.qdoc index d031dbf52..409b4c838 100644 --- a/doc/reference/jsextensions/jsextensions-general.qdoc +++ b/doc/reference/jsextensions/jsextensions-general.qdoc @@ -56,23 +56,6 @@ 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 qbs.getHash - \code - qbs.getHash(key: string): string - \endcode - Calculates a 16-byte hash of the input and returns it. - Rules in modules should use this function to find unique locations for output - artifacts in the build directory without duplicating the whole directory structure of - the respective input file (to deal with the case of two files with the same name in different - subdirectories of the same product). - - \section2 qbs.rfc1034Identifier - \code - qbs.rfc1034Identifier(str: string): string - \endcode - Returns an RFC 1034 compliant identifier based on the given string by replacing each character - that is not Latin alphanumeric or \c{.} with \c{-}. - \section2 loadFile \code loadFile(filePath: string): any |