aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2017-07-06 11:39:40 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2017-07-07 13:15:51 +0000
commit68245a2c800ef52d2ebd921b82c06e0d6ff3c43c (patch)
tree35f00de1f1c932a485243419c3f4af2ddab971f3
parent74454897c95b828557b1023a8c8d836586434cc6 (diff)
Doc: Enable context-sensitive help (F1) for Qbs items
By adding the \keyword command with the value QML.<itemName> to the documentation of each item. Change-Id: Ieb24a33bddafbf135e9477350ba082cf630c9353 Task-number: QBS-1149 Reviewed-by: Jake Petroules <jake.petroules@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
-rw-r--r--doc/reference/items/convenience/androidapk.qdoc1
-rw-r--r--doc/reference/items/convenience/appleapplicationdiskimage.qdoc1
-rw-r--r--doc/reference/items/convenience/applediskimage.qdoc1
-rw-r--r--doc/reference/items/convenience/application.qdoc1
-rw-r--r--doc/reference/items/convenience/applicationextension.qdoc1
-rw-r--r--doc/reference/items/convenience/autotestrunner.qdoc1
-rw-r--r--doc/reference/items/convenience/cppapplication.qdoc1
-rw-r--r--doc/reference/items/convenience/dynamiclibrary.qdoc1
-rw-r--r--doc/reference/items/convenience/innosetup.qdoc1
-rw-r--r--doc/reference/items/convenience/installpackage.qdoc1
-rw-r--r--doc/reference/items/convenience/javaclasscollection.qdoc1
-rw-r--r--doc/reference/items/convenience/javajarfile.qdoc1
-rw-r--r--doc/reference/items/convenience/loadablemodule.qdoc1
-rw-r--r--doc/reference/items/convenience/qtapplication.qdoc1
-rw-r--r--doc/reference/items/convenience/qtguiapplication.qdoc1
-rw-r--r--doc/reference/items/convenience/staticlibrary.qdoc1
-rw-r--r--doc/reference/items/convenience/xpcservice.qdoc1
-rw-r--r--doc/reference/items/language/artifact.qdoc1
-rw-r--r--doc/reference/items/language/depends.qdoc1
-rw-r--r--doc/reference/items/language/export.qdoc1
-rw-r--r--doc/reference/items/language/filetagger.qdoc1
-rw-r--r--doc/reference/items/language/group.qdoc1
-rw-r--r--doc/reference/items/language/module.qdoc1
-rw-r--r--doc/reference/items/language/parameter.qdoc1
-rw-r--r--doc/reference/items/language/parameters.qdoc1
-rw-r--r--doc/reference/items/language/probe.qdoc1
-rw-r--r--doc/reference/items/language/product.qdoc1
-rw-r--r--doc/reference/items/language/project.qdoc1
-rw-r--r--doc/reference/items/language/properties.qdoc1
-rw-r--r--doc/reference/items/language/propertyoptions.qdoc1
-rw-r--r--doc/reference/items/language/rule.qdoc1
-rw-r--r--doc/reference/items/language/scanner.qdoc1
-rw-r--r--doc/reference/items/language/subproject.qdoc1
33 files changed, 33 insertions, 0 deletions
diff --git a/doc/reference/items/convenience/androidapk.qdoc b/doc/reference/items/convenience/androidapk.qdoc
index c3cce0ea1..f718df554 100644
--- a/doc/reference/items/convenience/androidapk.qdoc
+++ b/doc/reference/items/convenience/androidapk.qdoc
@@ -30,6 +30,7 @@
\nextpage applediskimage-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.AndroidApk
\title AndroidApk Item
\brief Represents an Android application package.
diff --git a/doc/reference/items/convenience/appleapplicationdiskimage.qdoc b/doc/reference/items/convenience/appleapplicationdiskimage.qdoc
index 7612d60bf..9c6746e48 100644
--- a/doc/reference/items/convenience/appleapplicationdiskimage.qdoc
+++ b/doc/reference/items/convenience/appleapplicationdiskimage.qdoc
@@ -31,6 +31,7 @@
\nextpage application-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.AppleApplicationDiskImage
\title AppleApplicationDiskImage Item
\brief Represents a product that is an Apple application drag 'n' drop disk image installer.
diff --git a/doc/reference/items/convenience/applediskimage.qdoc b/doc/reference/items/convenience/applediskimage.qdoc
index ffd335212..773cb7f44 100644
--- a/doc/reference/items/convenience/applediskimage.qdoc
+++ b/doc/reference/items/convenience/applediskimage.qdoc
@@ -31,6 +31,7 @@
\nextpage appleapplicationdiskimage-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.AppleDiskImage
\title AppleDiskImage Item
\brief Represents a product that is an Apple disk image.
diff --git a/doc/reference/items/convenience/application.qdoc b/doc/reference/items/convenience/application.qdoc
index d254e84ee..5d8760350 100644
--- a/doc/reference/items/convenience/application.qdoc
+++ b/doc/reference/items/convenience/application.qdoc
@@ -31,6 +31,7 @@
\nextpage applicationextension-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.Application
\title Application Item
\brief Represents a product of application type.
diff --git a/doc/reference/items/convenience/applicationextension.qdoc b/doc/reference/items/convenience/applicationextension.qdoc
index dd7b43468..432dafd08 100644
--- a/doc/reference/items/convenience/applicationextension.qdoc
+++ b/doc/reference/items/convenience/applicationextension.qdoc
@@ -32,6 +32,7 @@
\nextpage autotestrunner-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.ApplicationExtension
\title ApplicationExtension Item
\brief Represents a product that is an iOS, macOS, tvOS, or watchOS Application Extension.
diff --git a/doc/reference/items/convenience/autotestrunner.qdoc b/doc/reference/items/convenience/autotestrunner.qdoc
index d73d442a2..99b0d0a09 100644
--- a/doc/reference/items/convenience/autotestrunner.qdoc
+++ b/doc/reference/items/convenience/autotestrunner.qdoc
@@ -31,6 +31,7 @@
\nextpage cppapplication-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.AutotestRunner
\title AutotestRunner Item
\brief A product that runs all autotests in the project.
diff --git a/doc/reference/items/convenience/cppapplication.qdoc b/doc/reference/items/convenience/cppapplication.qdoc
index 85338ed46..e7e89ac13 100644
--- a/doc/reference/items/convenience/cppapplication.qdoc
+++ b/doc/reference/items/convenience/cppapplication.qdoc
@@ -31,6 +31,7 @@
\nextpage dynamiclibrary-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.CppApplication
\title CppApplication Item
\brief Represents a product of application type with a dependency to the cpp module.
diff --git a/doc/reference/items/convenience/dynamiclibrary.qdoc b/doc/reference/items/convenience/dynamiclibrary.qdoc
index f73a9a721..3c601bcec 100644
--- a/doc/reference/items/convenience/dynamiclibrary.qdoc
+++ b/doc/reference/items/convenience/dynamiclibrary.qdoc
@@ -31,6 +31,7 @@
\nextpage innosetup-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.DynamicLibrary
\title DynamicLibrary Item
\brief Represents a product that is a dynamic library.
diff --git a/doc/reference/items/convenience/innosetup.qdoc b/doc/reference/items/convenience/innosetup.qdoc
index 8dc153302..db8c483f4 100644
--- a/doc/reference/items/convenience/innosetup.qdoc
+++ b/doc/reference/items/convenience/innosetup.qdoc
@@ -31,6 +31,7 @@
\nextpage installpackage-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.InnoSetup
\title InnoSetup Item
\brief Represents a product that is an Inno Setup installer executable.
diff --git a/doc/reference/items/convenience/installpackage.qdoc b/doc/reference/items/convenience/installpackage.qdoc
index 7a8f6130c..db6e21f26 100644
--- a/doc/reference/items/convenience/installpackage.qdoc
+++ b/doc/reference/items/convenience/installpackage.qdoc
@@ -31,6 +31,7 @@
\nextpage javaclasscollection-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.InstallPackage
\title InstallPackage Item
\brief Represents an archive of an installed project.
diff --git a/doc/reference/items/convenience/javaclasscollection.qdoc b/doc/reference/items/convenience/javaclasscollection.qdoc
index f16f7a812..38ef1d46a 100644
--- a/doc/reference/items/convenience/javaclasscollection.qdoc
+++ b/doc/reference/items/convenience/javaclasscollection.qdoc
@@ -31,6 +31,7 @@
\nextpage javajarfile-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.JavaClassCollection
\title JavaClassCollection Item
\brief Represents a collection of Java class files not bundled in a jar file.
diff --git a/doc/reference/items/convenience/javajarfile.qdoc b/doc/reference/items/convenience/javajarfile.qdoc
index 2f596ef16..6b6009b8c 100644
--- a/doc/reference/items/convenience/javajarfile.qdoc
+++ b/doc/reference/items/convenience/javajarfile.qdoc
@@ -31,6 +31,7 @@
\nextpage loadablemodule-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.JavaJarFile
\title JavaJarFile Item
\brief Represents a collection of Java class files bundled in a jar file.
diff --git a/doc/reference/items/convenience/loadablemodule.qdoc b/doc/reference/items/convenience/loadablemodule.qdoc
index 191b74096..010384cb7 100644
--- a/doc/reference/items/convenience/loadablemodule.qdoc
+++ b/doc/reference/items/convenience/loadablemodule.qdoc
@@ -32,6 +32,7 @@
\nextpage qtapplication-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.LoadableModule
\title LoadableModule Item
\brief Represents a product that is a loadable module.
diff --git a/doc/reference/items/convenience/qtapplication.qdoc b/doc/reference/items/convenience/qtapplication.qdoc
index b5d8a408e..0a3b61528 100644
--- a/doc/reference/items/convenience/qtapplication.qdoc
+++ b/doc/reference/items/convenience/qtapplication.qdoc
@@ -31,6 +31,7 @@
\nextpage qtguiapplication-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.QtApplication
\title QtApplication Item
\brief Represents a product of application type with a dependency to the Qt Core module.
diff --git a/doc/reference/items/convenience/qtguiapplication.qdoc b/doc/reference/items/convenience/qtguiapplication.qdoc
index 7a1131263..9b286bf9a 100644
--- a/doc/reference/items/convenience/qtguiapplication.qdoc
+++ b/doc/reference/items/convenience/qtguiapplication.qdoc
@@ -31,6 +31,7 @@
\nextpage staticlibrary-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.QtGuiApplication
\title QtGuiApplication Item
\brief Represents a product of application type with a dependency to the Qt GUI module.
diff --git a/doc/reference/items/convenience/staticlibrary.qdoc b/doc/reference/items/convenience/staticlibrary.qdoc
index 20ddb82ee..7f8a8c311 100644
--- a/doc/reference/items/convenience/staticlibrary.qdoc
+++ b/doc/reference/items/convenience/staticlibrary.qdoc
@@ -31,6 +31,7 @@
\nextpage xpcservice-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.StaticLibrary
\title StaticLibrary Item
\brief Represents a product that is a static library.
diff --git a/doc/reference/items/convenience/xpcservice.qdoc b/doc/reference/items/convenience/xpcservice.qdoc
index 7ed89b8f0..929753029 100644
--- a/doc/reference/items/convenience/xpcservice.qdoc
+++ b/doc/reference/items/convenience/xpcservice.qdoc
@@ -31,6 +31,7 @@
\previouspage staticlibrary-item.html
\ingroup list-of-convenience-items
\ingroup list-of-items
+ \keyword QML.XPCService
\title XPCService Item
\brief Represents a product that is a macOS, iOS, tvOS, or watchOS XPC service.
diff --git a/doc/reference/items/language/artifact.qdoc b/doc/reference/items/language/artifact.qdoc
index 9bda03e59..6c4a8d37c 100644
--- a/doc/reference/items/language/artifact.qdoc
+++ b/doc/reference/items/language/artifact.qdoc
@@ -30,6 +30,7 @@
\nextpage depends-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Artifact
\title Artifact Item
\brief Describes a file produced by a \c Rule.
diff --git a/doc/reference/items/language/depends.qdoc b/doc/reference/items/language/depends.qdoc
index 66627c9e2..77bc840dd 100644
--- a/doc/reference/items/language/depends.qdoc
+++ b/doc/reference/items/language/depends.qdoc
@@ -31,6 +31,7 @@
\nextpage export-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Depends
\title Depends Item
\brief Represents dependencies between products and modules.
diff --git a/doc/reference/items/language/export.qdoc b/doc/reference/items/language/export.qdoc
index 16d073df4..74e3cc4c4 100644
--- a/doc/reference/items/language/export.qdoc
+++ b/doc/reference/items/language/export.qdoc
@@ -31,6 +31,7 @@
\nextpage filetagger-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Export
\title Export Item
\brief Exports dependencies and properties to other products.
diff --git a/doc/reference/items/language/filetagger.qdoc b/doc/reference/items/language/filetagger.qdoc
index 578dad21c..4a87824f2 100644
--- a/doc/reference/items/language/filetagger.qdoc
+++ b/doc/reference/items/language/filetagger.qdoc
@@ -31,6 +31,7 @@
\nextpage group-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.FileTagger
\title FileTagger Item
\brief Maps file patterns to tags.
diff --git a/doc/reference/items/language/group.qdoc b/doc/reference/items/language/group.qdoc
index 220eba867..72b9c7f95 100644
--- a/doc/reference/items/language/group.qdoc
+++ b/doc/reference/items/language/group.qdoc
@@ -32,6 +32,7 @@
\nextpage module-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Group
\title Group Item
\brief Groups files in a product.
diff --git a/doc/reference/items/language/module.qdoc b/doc/reference/items/language/module.qdoc
index a9e9ebd44..9956b3ac5 100644
--- a/doc/reference/items/language/module.qdoc
+++ b/doc/reference/items/language/module.qdoc
@@ -31,6 +31,7 @@
\nextpage parameter-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Module
\title Module Item
\brief Represents a collection of properties and items that can be loaded into a product.
diff --git a/doc/reference/items/language/parameter.qdoc b/doc/reference/items/language/parameter.qdoc
index 168a7ce0d..da700f3da 100644
--- a/doc/reference/items/language/parameter.qdoc
+++ b/doc/reference/items/language/parameter.qdoc
@@ -31,6 +31,7 @@
\nextpage parameters-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Parameter
\title Parameter Item
\brief Declares a dependency parameter.
diff --git a/doc/reference/items/language/parameters.qdoc b/doc/reference/items/language/parameters.qdoc
index d7143290a..afeb9f30e 100644
--- a/doc/reference/items/language/parameters.qdoc
+++ b/doc/reference/items/language/parameters.qdoc
@@ -31,6 +31,7 @@
\nextpage probe-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Parameters
\title Parameters Item
\brief Defines default values for dependency parameters within
diff --git a/doc/reference/items/language/probe.qdoc b/doc/reference/items/language/probe.qdoc
index 89683086c..d2684b4c2 100644
--- a/doc/reference/items/language/probe.qdoc
+++ b/doc/reference/items/language/probe.qdoc
@@ -31,6 +31,7 @@
\nextpage product-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Probe
\title Probe Item
\brief Locates files outside the project.
diff --git a/doc/reference/items/language/product.qdoc b/doc/reference/items/language/product.qdoc
index 3b317143c..2d3a63cdf 100644
--- a/doc/reference/items/language/product.qdoc
+++ b/doc/reference/items/language/product.qdoc
@@ -31,6 +31,7 @@
\nextpage project-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Product
\title Product Item
\brief Represents the result of a build process.
diff --git a/doc/reference/items/language/project.qdoc b/doc/reference/items/language/project.qdoc
index 33d4eb50b..1b97bcb02 100644
--- a/doc/reference/items/language/project.qdoc
+++ b/doc/reference/items/language/project.qdoc
@@ -31,6 +31,7 @@
\nextpage properties-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Project
\title Project Item
\brief Represents a collection of products and properties.
diff --git a/doc/reference/items/language/properties.qdoc b/doc/reference/items/language/properties.qdoc
index d9f601ddb..93056b37c 100644
--- a/doc/reference/items/language/properties.qdoc
+++ b/doc/reference/items/language/properties.qdoc
@@ -31,6 +31,7 @@
\nextpage propertyoptions-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Properties
\title Properties Item
\brief Provides conditional setting of properties.
diff --git a/doc/reference/items/language/propertyoptions.qdoc b/doc/reference/items/language/propertyoptions.qdoc
index 701f5ab43..37399c9f3 100644
--- a/doc/reference/items/language/propertyoptions.qdoc
+++ b/doc/reference/items/language/propertyoptions.qdoc
@@ -31,6 +31,7 @@
\nextpage rule-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.PropertyOptions
\title PropertyOptions Item
\brief Provides inline documentation for properties within product and module items.
diff --git a/doc/reference/items/language/rule.qdoc b/doc/reference/items/language/rule.qdoc
index bb617aa29..b4066a43b 100644
--- a/doc/reference/items/language/rule.qdoc
+++ b/doc/reference/items/language/rule.qdoc
@@ -31,6 +31,7 @@
\nextpage scanner-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Rule
\title Rule Item
\brief Creates transformers for input tags.
diff --git a/doc/reference/items/language/scanner.qdoc b/doc/reference/items/language/scanner.qdoc
index 62fcb643c..736f26aa0 100644
--- a/doc/reference/items/language/scanner.qdoc
+++ b/doc/reference/items/language/scanner.qdoc
@@ -31,6 +31,7 @@
\nextpage subproject-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.Scanner
\title Scanner Item
\brief Creates custom dependency scanners in modules.
diff --git a/doc/reference/items/language/subproject.qdoc b/doc/reference/items/language/subproject.qdoc
index 644b600aa..bd14d0af5 100644
--- a/doc/reference/items/language/subproject.qdoc
+++ b/doc/reference/items/language/subproject.qdoc
@@ -30,6 +30,7 @@
\page subproject-item.html
\ingroup list-of-language-items
\ingroup list-of-items
+ \keyword QML.SubProject
\title SubProject Item
\brief Adds a project from a different file.