From cdd62709b06def6bd78f7a3c4b5dff8173bc6130 Mon Sep 17 00:00:00 2001
From: Denis Shienkov <denis.shienkov@gmail.com>
Date: Fri, 15 Feb 2019 18:56:40 +0300
Subject: doc: Add information about KeilProbe

Change-Id: Ia8eb378f322c0127729b2531fb3406134623b324
Reviewed-by: Ivan Komissarov <ABBAPOH@gmail.com>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
---
 doc/reference/items/probe/keil-probe.qdoc | 93 +++++++++++++++++++++++++++++++
 1 file changed, 93 insertions(+)
 create mode 100644 doc/reference/items/probe/keil-probe.qdoc

(limited to 'doc')

diff --git a/doc/reference/items/probe/keil-probe.qdoc b/doc/reference/items/probe/keil-probe.qdoc
new file mode 100644
index 000000000..f5aa07d83
--- /dev/null
+++ b/doc/reference/items/probe/keil-probe.qdoc
@@ -0,0 +1,93 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 Denis Shienkov <denis.shienkov@gmail.com>
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qbs.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+/*!
+    \contentspage list-of-probes.html
+    \qmltype KeilProbe
+    \ingroup list-of-probes
+    \ingroup list-of-items
+    \keyword QML.KeilProbe
+    \inherits PathProbe
+    \brief Collects KEIL toolchain compiler information.
+    \since Qbs 1.13
+    \internal
+
+    Detects the version, supported architecture and the platform
+    endianness of the specified compiler executable file from the
+    \l{https://www.keil.com/}{KEIL} toolchain.
+*/
+
+/*!
+    \qmlproperty string KeilProbe::compilerFilePath
+
+    An input property which is a full path to the KEIL compiler executable file.
+
+    \nodefaultvalue
+*/
+
+/*!
+    \qmlproperty string KeilProbe::architecture
+
+    Detected architecture of the target platform's processor.
+
+    The possible values are \c "arm" and \c "mcs51".
+
+    \nodefaultvalue
+*/
+
+/*!
+    \qmlproperty string KeilProbe::endianness
+
+    Detected endianness of the target platform's processor architecture.
+
+    The possible values are \c "big" or \c "little".
+
+    \nodefaultvalue
+*/
+
+/*!
+    \qmlproperty int KeilProbe::versionMajor
+
+    Detected major compiler version.
+
+    \nodefaultvalue
+*/
+
+/*!
+    \qmlproperty int KeilProbe::versionMinor
+
+    Detected minor compiler version.
+
+    \nodefaultvalue
+*/
+
+/*!
+    \qmlproperty int KeilProbe::versionPatch
+
+    Detected patch compiler version.
+
+    \nodefaultvalue
+*/
-- 
cgit v1.2.3