diff options
author | Jake Petroules <jake.petroules@qt.io> | 2016-12-05 04:04:29 -0800 |
---|---|---|
committer | Jake Petroules <jake.petroules@qt.io> | 2016-12-07 11:58:18 +0000 |
commit | a8df8bc969117eb49f13a65db5b7eeee45576afa (patch) | |
tree | 5ec083f0fb4e518a67ef311725f5bbdf16b87c09 | |
parent | eea6f82983fb209880f26039f7ddb692ba34e397 (diff) |
Documentation: split list of items into language and convenience items
Change-Id: Ia2f48518a4a78070a05a494c46debc8903308fa2
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
-rw-r--r-- | doc/reference/items/convenience/androidapk.qdoc (renamed from doc/reference/items/androidapk.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/convenience/application.qdoc (renamed from doc/reference/items/application.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/convenience/applicationextension.qdoc (renamed from doc/reference/items/applicationextension.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/convenience/autotestrunner.qdoc (renamed from doc/reference/items/autotestrunner.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/convenience/cppapplication.qdoc (renamed from doc/reference/items/cppapplication.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/convenience/dynamiclibrary.qdoc (renamed from doc/reference/items/dynamiclibrary.qdoc) | 7 | ||||
-rw-r--r-- | doc/reference/items/convenience/innosetup.qdoc (renamed from doc/reference/items/innosetup.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/convenience/installpackage.qdoc (renamed from doc/reference/items/installpackage.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/convenience/javaclasscollection.qdoc (renamed from doc/reference/items/javaclasscollection.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/convenience/javajarfile.qdoc (renamed from doc/reference/items/javajarfile.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/convenience/loadablemodule.qdoc (renamed from doc/reference/items/loadablemodule.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/convenience/qtapplication.qdoc (renamed from doc/reference/items/qtapplication.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/convenience/qtguiapplication.qdoc (renamed from doc/reference/items/qtguiapplication.qdoc) | 7 | ||||
-rw-r--r-- | doc/reference/items/convenience/staticlibrary.qdoc (renamed from doc/reference/items/staticlibrary.qdoc) | 7 | ||||
-rw-r--r-- | doc/reference/items/convenience/xpcservice.qdoc (renamed from doc/reference/items/xpcservice.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/language/artifact.qdoc (renamed from doc/reference/items/artifact.qdoc) | 6 | ||||
-rw-r--r-- | doc/reference/items/language/depends.qdoc (renamed from doc/reference/items/depends.qdoc) | 7 | ||||
-rw-r--r-- | doc/reference/items/language/export.qdoc (renamed from doc/reference/items/export.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/language/filetagger.qdoc (renamed from doc/reference/items/filetagger.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/language/group.qbs (renamed from doc/reference/items/group.qbs) | 0 | ||||
-rw-r--r-- | doc/reference/items/language/group.qdoc (renamed from doc/reference/items/group.qdoc) | 7 | ||||
-rw-r--r-- | doc/reference/items/language/module.qdoc (renamed from doc/reference/items/module.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/language/probe.qdoc (renamed from doc/reference/items/probe.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/language/product.qdoc (renamed from doc/reference/items/product.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/language/project.qdoc (renamed from doc/reference/items/project.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/language/properties.qdoc (renamed from doc/reference/items/properties.qdoc) | 3 | ||||
-rw-r--r-- | doc/reference/items/language/propertyoptions.qdoc (renamed from doc/reference/items/propertyoptions.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/language/rule.qdoc (renamed from doc/reference/items/rule.qdoc) | 7 | ||||
-rw-r--r-- | doc/reference/items/language/scanner.qdoc (renamed from doc/reference/items/scanner.qdoc) | 5 | ||||
-rw-r--r-- | doc/reference/items/language/subproject.qdoc (renamed from doc/reference/items/subproject.qdoc) | 6 | ||||
-rw-r--r-- | doc/reference/reference.qdoc | 25 |
31 files changed, 109 insertions, 57 deletions
diff --git a/doc/reference/items/androidapk.qdoc b/doc/reference/items/convenience/androidapk.qdoc index 94132dc76..17496bbc3 100644 --- a/doc/reference/items/androidapk.qdoc +++ b/doc/reference/items/convenience/androidapk.qdoc @@ -25,9 +25,10 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page androidapk-item.html \nextpage application-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title AndroidApk Item diff --git a/doc/reference/items/application.qdoc b/doc/reference/items/convenience/application.qdoc index 27c066b6c..1a13724b1 100644 --- a/doc/reference/items/application.qdoc +++ b/doc/reference/items/convenience/application.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page application-item.html \previouspage androidapk-item.html \nextpage applicationextension-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title Application Item diff --git a/doc/reference/items/applicationextension.qdoc b/doc/reference/items/convenience/applicationextension.qdoc index 96f3fbd2b..dd7b43468 100644 --- a/doc/reference/items/applicationextension.qdoc +++ b/doc/reference/items/convenience/applicationextension.qdoc @@ -26,10 +26,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page applicationextension-item.html \previouspage application-item.html - \nextpage artifact-item.html + \nextpage autotestrunner-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title ApplicationExtension Item diff --git a/doc/reference/items/autotestrunner.qdoc b/doc/reference/items/convenience/autotestrunner.qdoc index b698130cb..d73d442a2 100644 --- a/doc/reference/items/autotestrunner.qdoc +++ b/doc/reference/items/convenience/autotestrunner.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page autotestrunner-item.html - \previouspage artifact-item.html + \previouspage applicationextension-item.html \nextpage cppapplication-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title AutotestRunner Item diff --git a/doc/reference/items/cppapplication.qdoc b/doc/reference/items/convenience/cppapplication.qdoc index 4dc97ff0a..85338ed46 100644 --- a/doc/reference/items/cppapplication.qdoc +++ b/doc/reference/items/convenience/cppapplication.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page cppapplication-item.html \previouspage autotestrunner-item.html - \nextpage depends-item.html + \nextpage dynamiclibrary-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title CppApplication Item diff --git a/doc/reference/items/dynamiclibrary.qdoc b/doc/reference/items/convenience/dynamiclibrary.qdoc index 17c1f7363..f73a9a721 100644 --- a/doc/reference/items/dynamiclibrary.qdoc +++ b/doc/reference/items/convenience/dynamiclibrary.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page dynamiclibrary-item.html - \previouspage depends-item.html - \nextpage export-item.html + \previouspage cppapplication-item.html + \nextpage innosetup-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title DynamicLibrary Item diff --git a/doc/reference/items/innosetup.qdoc b/doc/reference/items/convenience/innosetup.qdoc index 1446bfb54..8dc153302 100644 --- a/doc/reference/items/innosetup.qdoc +++ b/doc/reference/items/convenience/innosetup.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page innosetup-item.html - \previouspage group-item.html + \previouspage dynamiclibrary-item.html \nextpage installpackage-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title InnoSetup Item diff --git a/doc/reference/items/installpackage.qdoc b/doc/reference/items/convenience/installpackage.qdoc index b58659569..7a8f6130c 100644 --- a/doc/reference/items/installpackage.qdoc +++ b/doc/reference/items/convenience/installpackage.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page installpackage-item.html - \previouspage group-item.html + \previouspage innosetup-item.html \nextpage javaclasscollection-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title InstallPackage Item diff --git a/doc/reference/items/javaclasscollection.qdoc b/doc/reference/items/convenience/javaclasscollection.qdoc index 9df02f0e4..f16f7a812 100644 --- a/doc/reference/items/javaclasscollection.qdoc +++ b/doc/reference/items/convenience/javaclasscollection.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page javaclasscollection-item.html \previouspage installpackage-item.html \nextpage javajarfile-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title JavaClassCollection Item diff --git a/doc/reference/items/javajarfile.qdoc b/doc/reference/items/convenience/javajarfile.qdoc index 50d5cfaa6..2f596ef16 100644 --- a/doc/reference/items/javajarfile.qdoc +++ b/doc/reference/items/convenience/javajarfile.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page javajarfile-item.html \previouspage javaclasscollection-item.html \nextpage loadablemodule-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title JavaJarFile Item diff --git a/doc/reference/items/loadablemodule.qdoc b/doc/reference/items/convenience/loadablemodule.qdoc index ba25943f8..191b74096 100644 --- a/doc/reference/items/loadablemodule.qdoc +++ b/doc/reference/items/convenience/loadablemodule.qdoc @@ -26,10 +26,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page loadablemodule-item.html \previouspage javajarfile-item.html - \nextpage module-item.html + \nextpage qtapplication-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title LoadableModule Item diff --git a/doc/reference/items/qtapplication.qdoc b/doc/reference/items/convenience/qtapplication.qdoc index d31350bf9..b5d8a408e 100644 --- a/doc/reference/items/qtapplication.qdoc +++ b/doc/reference/items/convenience/qtapplication.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page qtapplication-item.html - \previouspage propertyoptions-item.html + \previouspage loadablemodule-item.html \nextpage qtguiapplication-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title QtApplication Item diff --git a/doc/reference/items/qtguiapplication.qdoc b/doc/reference/items/convenience/qtguiapplication.qdoc index 5e10b101c..7a1131263 100644 --- a/doc/reference/items/qtguiapplication.qdoc +++ b/doc/reference/items/convenience/qtguiapplication.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page qtguiapplication-item.html - \previouspage propertyoptions-item.html - \nextpage rule-item.html + \previouspage qtapplication-item.html + \nextpage staticlibrary-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title QtGuiApplication Item diff --git a/doc/reference/items/staticlibrary.qdoc b/doc/reference/items/convenience/staticlibrary.qdoc index 190472105..20ddb82ee 100644 --- a/doc/reference/items/staticlibrary.qdoc +++ b/doc/reference/items/convenience/staticlibrary.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page staticlibrary-item.html - \previouspage rule-item.html - \nextpage subproject-item.html + \previouspage qtguiapplication-item.html + \nextpage xpcservice-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title StaticLibrary Item diff --git a/doc/reference/items/xpcservice.qdoc b/doc/reference/items/convenience/xpcservice.qdoc index 521940268..7ed89b8f0 100644 --- a/doc/reference/items/xpcservice.qdoc +++ b/doc/reference/items/convenience/xpcservice.qdoc @@ -26,9 +26,10 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-convenience-items.html \page xpcservice-item.html - \previouspage subproject-item.html + \previouspage staticlibrary-item.html + \ingroup list-of-convenience-items \ingroup list-of-items \title XPCService Item diff --git a/doc/reference/items/artifact.qdoc b/doc/reference/items/language/artifact.qdoc index 0294184d9..9bda03e59 100644 --- a/doc/reference/items/artifact.qdoc +++ b/doc/reference/items/language/artifact.qdoc @@ -25,10 +25,10 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html \page artifact-item.html - \previouspage applicationextension-item.html - \nextpage autotestrunner-item.html + \nextpage depends-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Artifact Item diff --git a/doc/reference/items/depends.qdoc b/doc/reference/items/language/depends.qdoc index fcac06e6b..5d944cba6 100644 --- a/doc/reference/items/depends.qdoc +++ b/doc/reference/items/language/depends.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html - \previouspage cppapplication-item.html + \contentspage list-of-language-items.html + \previouspage artifact-item.html \page depends-item.html - \nextpage dynamiclibrary-item.html + \nextpage export-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Depends Item diff --git a/doc/reference/items/export.qdoc b/doc/reference/items/language/export.qdoc index 4f1a9a61e..16d073df4 100644 --- a/doc/reference/items/export.qdoc +++ b/doc/reference/items/language/export.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html - \previouspage dynamiclibrary-item.html + \contentspage list-of-language-items.html + \previouspage depends-item.html \page export-item.html \nextpage filetagger-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Export Item diff --git a/doc/reference/items/filetagger.qdoc b/doc/reference/items/language/filetagger.qdoc index a5f66ea3e..578dad21c 100644 --- a/doc/reference/items/filetagger.qdoc +++ b/doc/reference/items/language/filetagger.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html \previouspage export-item.html \page filetagger-item.html \nextpage group-item.html + \ingroup list-of-language-items \ingroup list-of-items \title FileTagger Item diff --git a/doc/reference/items/group.qbs b/doc/reference/items/language/group.qbs index 4b478bfa5..4b478bfa5 100644 --- a/doc/reference/items/group.qbs +++ b/doc/reference/items/language/group.qbs diff --git a/doc/reference/items/group.qdoc b/doc/reference/items/language/group.qdoc index 139cc6f6d..16eeb3ea2 100644 --- a/doc/reference/items/group.qdoc +++ b/doc/reference/items/language/group.qdoc @@ -26,10 +26,11 @@ ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html \previouspage filetagger-item.html \page group-item.html - \nextpage installpackage-item.html + \nextpage module-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Group Item @@ -78,7 +79,7 @@ The pattern ** used in a pathname expansion context will match all files and zero or more directories and subdirectories. For example: - \snippet reference/items/group.qbs 0 + \snippet reference/items/language/group.qbs 0 A group can also be used to attach properties to build artifacts such as executables or libraries. In the following example, an application is installed to "<install root>/bin". diff --git a/doc/reference/items/module.qdoc b/doc/reference/items/language/module.qdoc index 8a39649fa..69d9d8896 100644 --- a/doc/reference/items/module.qdoc +++ b/doc/reference/items/language/module.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html - \previouspage loadablemodule-item.html + \contentspage list-of-language-items.html + \previouspage group-item.html \page module-item.html \nextpage probe-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Module Item diff --git a/doc/reference/items/probe.qdoc b/doc/reference/items/language/probe.qdoc index 3b39f6235..b7f61a912 100644 --- a/doc/reference/items/probe.qdoc +++ b/doc/reference/items/language/probe.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html \previouspage module-item.html \page probe-item.html \nextpage product-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Probe Item diff --git a/doc/reference/items/product.qdoc b/doc/reference/items/language/product.qdoc index a4322d377..4dd3089ae 100644 --- a/doc/reference/items/product.qdoc +++ b/doc/reference/items/language/product.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html \previouspage probe-item.html \page product-item.html \nextpage project-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Product Item diff --git a/doc/reference/items/project.qdoc b/doc/reference/items/language/project.qdoc index bd6a76f02..33d4eb50b 100644 --- a/doc/reference/items/project.qdoc +++ b/doc/reference/items/language/project.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html \previouspage product-item.html \page project-item.html \nextpage properties-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Project Item diff --git a/doc/reference/items/properties.qdoc b/doc/reference/items/language/properties.qdoc index a8de7740b..4e2cb345f 100644 --- a/doc/reference/items/properties.qdoc +++ b/doc/reference/items/language/properties.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html \previouspage project-item.html \page properties-item.html \nextpage propertyoptions-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Properties Item diff --git a/doc/reference/items/propertyoptions.qdoc b/doc/reference/items/language/propertyoptions.qdoc index b6b17f18d..701f5ab43 100644 --- a/doc/reference/items/propertyoptions.qdoc +++ b/doc/reference/items/language/propertyoptions.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html \previouspage properties-item.html \page propertyoptions-item.html - \nextpage qtapplication-item.html + \nextpage rule-item.html + \ingroup list-of-language-items \ingroup list-of-items \title PropertyOptions Item diff --git a/doc/reference/items/rule.qdoc b/doc/reference/items/language/rule.qdoc index 379a5ec83..8d53e3845 100644 --- a/doc/reference/items/rule.qdoc +++ b/doc/reference/items/language/rule.qdoc @@ -25,10 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html - \previouspage qtapplication-item.html + \contentspage list-of-language-items.html + \previouspage propertyoptions-item.html \page rule-item.html - \nextpage staticlibrary-item.html + \nextpage scanner-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Rule Item diff --git a/doc/reference/items/scanner.qdoc b/doc/reference/items/language/scanner.qdoc index a7bd65f17..44c93d168 100644 --- a/doc/reference/items/scanner.qdoc +++ b/doc/reference/items/language/scanner.qdoc @@ -25,8 +25,11 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html + \contentspage list-of-language-items.html + \previouspage rule-item.html \page scanner-item.html + \nextpage subproject-item.html + \ingroup list-of-language-items \ingroup list-of-items \title Scanner Item diff --git a/doc/reference/items/subproject.qdoc b/doc/reference/items/language/subproject.qdoc index 6256ad3d3..644b600aa 100644 --- a/doc/reference/items/subproject.qdoc +++ b/doc/reference/items/language/subproject.qdoc @@ -25,10 +25,10 @@ ** ****************************************************************************/ /*! - \contentspage list-of-items.html - \previouspage staticlibrary-item.html + \contentspage list-of-language-items.html + \previouspage scanner-item.html \page subproject-item.html - \nextpage xpcservice-item.html + \ingroup list-of-language-items \ingroup list-of-items \title SubProject Item diff --git a/doc/reference/reference.qdoc b/doc/reference/reference.qdoc index fd5b11099..d34f39e05 100644 --- a/doc/reference/reference.qdoc +++ b/doc/reference/reference.qdoc @@ -32,7 +32,11 @@ \title Reference \list - \li \l{List of Language Items} + \li \l{List of All Items} + \list + \li \l{List of Language Items} + \li \l{List of Convenience Items} + \endlist \li \l{List of Built-in Services} \li \l{List of Command-line Tools} \li \l{List of Modules} @@ -70,6 +74,25 @@ /*! \contentspage reference.html \group list-of-items + \title List of All Items + + \QBS provides the following \l{List of Language Items}{built-in} and + \l{List of Convenience Items}{convenience} items to define projects. +*/ + +/*! + \contentspage reference.html + \group list-of-language-items \title List of Language Items + \QBS provides the following built-in QML items to define projects. + These are the primitives upon which all other \QBS items are built. +*/ + +/*! + \contentspage reference.html + \group list-of-convenience-items + \title List of Convenience Items + + \QBS provides the following QML items for convenience. */ |