diff options
Diffstat (limited to 'doc/reference/jsextensions')
12 files changed, 164 insertions, 35 deletions
diff --git a/doc/reference/jsextensions/jsextension-binaryfile.qdoc b/doc/reference/jsextensions/jsextension-binaryfile.qdoc index 59def1af4..c8c3bd4b1 100644 --- a/doc/reference/jsextensions/jsextension-binaryfile.qdoc +++ b/doc/reference/jsextensions/jsextension-binaryfile.qdoc @@ -28,7 +28,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-binaryfile.html \ingroup list-of-builtin-services diff --git a/doc/reference/jsextensions/jsextension-environment.qdoc b/doc/reference/jsextensions/jsextension-environment.qdoc index 8579ecee5..465a157a2 100644 --- a/doc/reference/jsextensions/jsextension-environment.qdoc +++ b/doc/reference/jsextensions/jsextension-environment.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-environment.html \ingroup list-of-builtin-services diff --git a/doc/reference/jsextensions/jsextension-file.qdoc b/doc/reference/jsextensions/jsextension-file.qdoc index c12fcc4ef..f04055593 100644 --- a/doc/reference/jsextensions/jsextension-file.qdoc +++ b/doc/reference/jsextensions/jsextension-file.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-file.html \ingroup list-of-builtin-services @@ -48,6 +47,9 @@ \note \c targetFilePath must be the counterpart of \c sourceFilePath at the new location, \b{not} the new parent directory. This allows the copy to have a different name and is true even if \c sourceFilePath is a directory. + \note The file is not copied if the source file timestamp is older than the destination file + timestamp. If you want to replace the newer file, you need to remove it first via + File.remove(). \section2 exists \code diff --git a/doc/reference/jsextensions/jsextension-fileinfo.qdoc b/doc/reference/jsextensions/jsextension-fileinfo.qdoc index 967606ea7..d58c1a9e9 100644 --- a/doc/reference/jsextensions/jsextension-fileinfo.qdoc +++ b/doc/reference/jsextensions/jsextension-fileinfo.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-fileinfo.html \ingroup list-of-builtin-services @@ -150,4 +149,26 @@ FileInfo.toWindowsSeparators(filePath: string): string \endcode Returns \c filePath with all '/' characters replaced by '\\'. + + \section2 pathListSeparator + \code + FileInfo.pathListSeparator(): string + \endcode + Returns the host operating system separator for a path list that is used in environment + variables or other contexts. + \funsince 1.22 + + \section2 pathSeparator + \code + FileInfo.pathSeparator(): string + \endcode + Returns the host operating system path separator. + \funsince 1.22 + + \section2 executableSuffix + \code + FileInfo.executableSuffix(): string + \endcode + Returns the host operating system executable suffix. + \funsince 1.23 */ diff --git a/doc/reference/jsextensions/jsextension-host.qdoc b/doc/reference/jsextensions/jsextension-host.qdoc new file mode 100644 index 000000000..c011e90eb --- /dev/null +++ b/doc/reference/jsextensions/jsextension-host.qdoc @@ -0,0 +1,139 @@ +/**************************************************************************** +** +** Copyright (C) 2022 Raphaël Cotty <raphael.cotty@gmail.com> +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qbs. +** +** $QT_BEGIN_LICENSE:LGPL$ +** 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 https://www.qt.io/terms-conditions. For further +** information use the contact form at https://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 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page jsextension-host.html + \ingroup list-of-builtin-services + + \title Host Service + \brief Provides host information. + + The \c Host service offers various information about the host environment, such as operating + system names, platform name. + + \section1 Available Operations + + \section2 architecture + \code + Host.architecture(): string + \endcode + Returns the host operating system architecture. + + See \l{qbs::architecture}{qbs.architecture} for the target-specific equivalent property. + architecture. + \funsince 1.22 + + \section2 os + \code + Host.os(): string[] + \endcode + Returns the host operating system names. + + See the \l{qbs::targetOS}{qbs.targetOS} for the target-specific equivalent property. + \funsince 1.22 + + \section2 platform + \code + Host.platform(): string + \endcode + Returns the host operating system platform. + + See the \l{qbs::targetPlatform}{qbs.targetPlatform} for the target-specific equivalent property. + \funsince 1.22 + + + \section2 osVersion + \code + Host.osVersion(): string + \endcode + Returns the host operating system version. Currently, only defined for Windows and Apple + platforms. + + Consists of two or three numbers separated by dots. For example, \c "10.9" or \c "6.3.9600". + \funsince 1.22 + + \section2 osBuildVersion + \code + Host.osBuildVersion(): string + \endcode + Returns the host operating system build version. Currently, only defined for Windows and Apple + platforms. + + On Windows, this is the 4 or 5 digit Windows build number and is equivalent + to \l{qbs::}{versionPatch}. On Apple platforms, this is a standard build number in the Apple + versioning scheme. For example, \c "13C64". + \funsince 1.22 + + \section2 osVersionParts + \code + Host.osVersionParts(): string[] + \endcode + Returns the host operating system version as a list. + + For example, Windows 8.1 (version 6.3.9600) would correspond to a value of \c[6, 3, 9600]. + \funsince 1.22 + + \section2 osVersionMajor + \code + Host.osVersionMajor(): number + \endcode + Returns the host operating system major version. + \funsince 1.22 + + \section2 osVersionMinor + \code + Host.osVersionMinor(): number + \endcode + Returns the host operating system minor version. + \funsince 1.22 + + \section2 osVersionPatch + \code + Host.osVersionPatch(): number + \endcode + Returns the host operating system patch level. + \funsince 1.22 + + \section2 nullDevice + \code + Host.nullDevice(): string[] + \endcode + Returns the platform-specific file path corresponding to the null device. + \funsince 1.22 +*/ diff --git a/doc/reference/jsextensions/jsextension-process.qdoc b/doc/reference/jsextensions/jsextension-process.qdoc index dd942ecff..49b47f4b2 100644 --- a/doc/reference/jsextensions/jsextension-process.qdoc +++ b/doc/reference/jsextensions/jsextension-process.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-process.html \ingroup list-of-builtin-services diff --git a/doc/reference/jsextensions/jsextension-propertylist.qdoc b/doc/reference/jsextensions/jsextension-propertylist.qdoc index 869873aec..e1dad6e38 100644 --- a/doc/reference/jsextensions/jsextension-propertylist.qdoc +++ b/doc/reference/jsextensions/jsextension-propertylist.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-propertylist.html \ingroup list-of-builtin-services diff --git a/doc/reference/jsextensions/jsextension-temporarydir.qdoc b/doc/reference/jsextensions/jsextension-temporarydir.qdoc index 750653143..29f62725d 100644 --- a/doc/reference/jsextensions/jsextension-temporarydir.qdoc +++ b/doc/reference/jsextensions/jsextension-temporarydir.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-temporarydir.html \ingroup list-of-builtin-services diff --git a/doc/reference/jsextensions/jsextension-textfile.qdoc b/doc/reference/jsextensions/jsextension-textfile.qdoc index 65758b3bd..b2cf2c729 100644 --- a/doc/reference/jsextensions/jsextension-textfile.qdoc +++ b/doc/reference/jsextensions/jsextension-textfile.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-textfile.html \ingroup list-of-builtin-services diff --git a/doc/reference/jsextensions/jsextension-utilities.qdoc b/doc/reference/jsextensions/jsextension-utilities.qdoc index 793581999..686e17a99 100644 --- a/doc/reference/jsextensions/jsextension-utilities.qdoc +++ b/doc/reference/jsextensions/jsextension-utilities.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-utilities.html \ingroup list-of-builtin-services diff --git a/doc/reference/jsextensions/jsextension-xml.qdoc b/doc/reference/jsextensions/jsextension-xml.qdoc index b5d3891ae..26e2e6de8 100644 --- a/doc/reference/jsextensions/jsextension-xml.qdoc +++ b/doc/reference/jsextensions/jsextension-xml.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \contentspage index.html \page jsextension-xml.html \ingroup list-of-builtin-services diff --git a/doc/reference/jsextensions/jsextensions-general.qdoc b/doc/reference/jsextensions/jsextensions-general.qdoc index 383f7b2bf..495e90f39 100644 --- a/doc/reference/jsextensions/jsextensions-general.qdoc +++ b/doc/reference/jsextensions/jsextensions-general.qdoc @@ -26,7 +26,6 @@ ** ****************************************************************************/ /*! - \contentspage index.html \page jsextensions-general.html \ingroup list-of-builtin-services @@ -58,12 +57,6 @@ \section1 Extensions to JavaScript Built-in Objects - \section2 Array.contains - \code - Array.contains(e: any): boolean - \endcode - Returns \c{true} if the array contains the element \c{e}. Returns \c{false} otherwise. - \section2 Array.containsAll \code Array.containsAll(other: any[]): boolean @@ -86,24 +79,6 @@ Duplicates that would originate from the concatenation are removed. The order of elements is preserved. - \section2 String.contains - \code - String.contains(s: string): boolean - \endcode - Returns \c{true} if the string contains the substring \c{s}. Returns \c{false} otherwise. - - \section2 startsWith - \code - String.startsWith(s: string): boolean - \endcode - Returns \c{true} if the string starts with the substring \c{s}. Returns \c{false} otherwise. - - \section2 endsWith - \code - String.endsWith(s: string): boolean - \endcode - Returns \c{true} if the string ends with the substring \c{s}. Returns \c{false} otherwise. - \section1 Console API |