From 423c8c4986c2aa62a8b49ba9289ea75be4b1bc27 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Wed, 29 Nov 2017 17:49:36 +0100
Subject: Doc: Use QDoc QML commands to document Qbs language items

Task-number: QBS-1245
Change-Id: I470a629312b1c65ea9e51c603607c486115a304c
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
---
 doc/reference/items/language/scanner.qdoc | 98 +++++++++++++++++--------------
 1 file changed, 54 insertions(+), 44 deletions(-)

(limited to 'doc/reference/items/language/scanner.qdoc')

diff --git a/doc/reference/items/language/scanner.qdoc b/doc/reference/items/language/scanner.qdoc
index 607af3965..9c5b28f75 100644
--- a/doc/reference/items/language/scanner.qdoc
+++ b/doc/reference/items/language/scanner.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2017 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of Qbs.
@@ -26,17 +26,16 @@
 ****************************************************************************/
 /*!
     \contentspage list-of-language-items.html
-    \previouspage rule-item.html
-    \page scanner-item.html
-    \nextpage subproject-item.html
-    \ingroup list-of-language-items
+    \previouspage Rule
+    \nextpage SubProject
+    \qmltype Scanner
+    \inqmlmodule QbsLanguageItems
     \ingroup list-of-items
     \keyword QML.Scanner
 
-    \title Scanner Item
     \brief Creates custom dependency scanners in modules.
 
-    A \c Scanner item can appear inside a \l{Module Item}, and allows to extract
+    A Scanner item can appear inside a \l{Module} item, and allows to extract
     dependencies for artifacts from the artifacts' file contents.
     For example, this is what a scanner for "qrc" files might look like:
     \code
@@ -54,42 +53,53 @@
       }
     }
     \endcode
+*/
+
+/*!
+    \qmlproperty bool Scanner::condition
+
+    If \c true, the scanner is enabled, otherwise it does nothing.
+
+    \defaultvalue \c true
+*/
+
+/*!
+    \qmlproperty stringList Scanner::inputs
+
+    A list of \l{FileTagger}{file tags} the input artifacts must match.
+
+    \nodefaultvalue
+*/
+
+/*!
+    \qmlproperty bool Scanner::recursive
+
+    Determines whether to scan the returned \l{Depends}{dependencies} using
+    the same scanner.
+
+    \defaultvalue \c false
+*/
+
+/*!
+    \qmlproperty script Scanner::searchPaths
+
+    A script that returns the paths where to look for \l{Depends}
+    {dependencies}.
+
+    The code in this script is treated as a function with the signature
+    \c{function(project, product, input)}.
+
+    \nodefaultvalue
+*/
+
+/*!
+    \qmlproperty script Scanner::scan
+
+    A script that reads the input artifact and returns a string list with
+    \l{Depends}{dependencies}.
+
+    The code in this script is treated as a function with the signature
+    \c{function(project, product, input)}.
 
-    \section1 Scanner Properties
-    \table
-    \header
-        \li Property
-        \li Type
-        \li Default
-        \li Description
-    \row
-        \li condition
-        \li bool
-        \li true
-        \li If true, the scanner is enabled, otherwise it does nothing.
-    \row
-        \li inputs
-        \li string list
-        \li undefined
-        \li File tags the input artifacts must match.
-    \row
-        \li recursive
-        \li bool
-        \li false
-        \li Determines whether to scan the returned dependencies using the same scanner.
-    \row
-        \li searchPaths
-        \li script
-        \li undefined
-        \li Script that returns paths to look for dependencies.
-            The code in this script is treated as a function with the signature
-            \c{function(project, product, input)}.
-    \row
-        \li scan
-        \li script
-        \li undefined
-        \li Script that reads the input artifact and returns string list with dependencies.
-            The code in this script is treated as a function with the signature
-            \c{function(project, product, input)}.
-    \endtable
+    \nodefaultvalue
 */
-- 
cgit v1.2.3