aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/items
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2017-12-22 13:45:15 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2017-12-22 14:34:47 +0000
commit45b494cffe805acaf8cc0941782a3104e48b9bc8 (patch)
tree086e7667d75df9c216f119d2ee712c13bc8bfb6d /doc/reference/items
parent4e7b3735bf995b12f3c98d3ee47b5954472401b9 (diff)
Doc: Add some more links to Item docs
Mostly replacing the \c command with the \l command. Change-Id: Ifbda6488cff7a249c554c5213054b627bfc687d5 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc/reference/items')
-rw-r--r--doc/reference/items/convenience/appleapplicationdiskimage.qdoc5
-rw-r--r--doc/reference/items/convenience/dynamiclibrary.qdoc2
-rw-r--r--doc/reference/items/convenience/qtguiapplication.qdoc2
-rw-r--r--doc/reference/items/language/depends.qdoc23
-rw-r--r--doc/reference/items/language/parameters.qdoc4
-rw-r--r--doc/reference/items/language/rule.qdoc4
-rw-r--r--doc/reference/items/language/subproject.qdoc6
7 files changed, 26 insertions, 20 deletions
diff --git a/doc/reference/items/convenience/appleapplicationdiskimage.qdoc b/doc/reference/items/convenience/appleapplicationdiskimage.qdoc
index 1d64382b5..d8011d66a 100644
--- a/doc/reference/items/convenience/appleapplicationdiskimage.qdoc
+++ b/doc/reference/items/convenience/appleapplicationdiskimage.qdoc
@@ -47,7 +47,7 @@
be copied into the disk image, provided their file paths are relative to the
path specified by the \l{sourceBase} property (that is, are located in that
directory). Any artifacts tagged \c{"installable"} that are not relative to
- \c{sourceBase} will be ignored.
+ \l{sourceBase} will be ignored.
Here is what the project file could look like for a simple DMG installer:
\code
@@ -80,7 +80,8 @@
\qmlproperty string AppleApplicationDiskImage::sourceBase
The base directory from which artifacts installed into the disk image will be copied.
- This directory is always considered to be relative to \c{qbs.installRoot}.
+ This directory is always considered to be relative to \l{qbs::installRoot}
+ {qbs.installRoot}.
For example, if the application Example.app exists at
\c{qbs.installRoot/Applications/Example.app}, and the value of this property
is \c{"/Applications"}, the application will be located at\c{/Example.app}
diff --git a/doc/reference/items/convenience/dynamiclibrary.qdoc b/doc/reference/items/convenience/dynamiclibrary.qdoc
index 49338d88b..27aa978d1 100644
--- a/doc/reference/items/convenience/dynamiclibrary.qdoc
+++ b/doc/reference/items/convenience/dynamiclibrary.qdoc
@@ -42,7 +42,7 @@
For Android targets, the following applies:
\list
- \li The \l{Product::type}{product.type} property value contains
+ \li The \l{Product::type}{Product.type} property value contains
\c "android.nativelibrary" in addition to \c "dynamiclibrary".
\li There is a dependency on the \l{cpp} and \l{Android.ndk} modules.
\endlist
diff --git a/doc/reference/items/convenience/qtguiapplication.qdoc b/doc/reference/items/convenience/qtguiapplication.qdoc
index 2845029e4..09b8514f5 100644
--- a/doc/reference/items/convenience/qtguiapplication.qdoc
+++ b/doc/reference/items/convenience/qtguiapplication.qdoc
@@ -47,5 +47,5 @@
Whether or not to add a depencency to the default QPA plugin. The default is
to do that in the case of a static build, where it is normally required.
- \defaultvalue \c Qt.core.staticBuild
+ \defaultvalue \l{Qt.core::staticBuild}{Qt.core.staticBuild}
*/
diff --git a/doc/reference/items/language/depends.qdoc b/doc/reference/items/language/depends.qdoc
index 45f2c84d9..eeadf25f9 100644
--- a/doc/reference/items/language/depends.qdoc
+++ b/doc/reference/items/language/depends.qdoc
@@ -37,8 +37,10 @@
A Depends item can appear inside a \l{Product} or \l{Module} item.
- For example, the following product will load the \c cpp module. In addition, it will try
- to load modules that may or may not exist, and in the latter case use a fallback.
+ For example, the following product will load the \l{cpp} module. In
+ addition, it will try to load modules that may or may not exist, and in the
+ latter case use a fallback.
+
\code
Product {
Depends { name: "cpp" }
@@ -65,11 +67,12 @@
\section1 Dependency Parameters
Sometimes it is desirable to have certain dependencies handled differently
- than others. For example, one might want to depend on a dynamic library
+ than others. For example, one might want to depend on a dynamic library
without linking it.
- This can be done by setting the parameter \c{cpp.link} to \c{true} in the
- dynamic library dependency:
+ This can be done by setting the \l{dependency-parameters-cpp}{cpp.link}
+ dependency parameter to \c{true} in the dynamic library dependency:
+
\code
Product {
Depends { name: "cpp" }
@@ -83,8 +86,8 @@
within Depends and \l [QML] {Parameters} items. Dependency parameters are
declared in the modules they belong to.
- In the example above, the \c{cpp} module declares the parameter \c{link}.
- The \c{Depends} item for \e{some_dynamic_lib} sets \c{cpp.link} to
+ In the example above, the \l{cpp} module declares the parameter \c{link}.
+ The Depends item for \c{some_dynamic_lib} sets \c{cpp.link} to
\c{false}, which tells the linker rule to ignore this particular dependency.
*/
@@ -138,8 +141,8 @@
Setting this property to \c false creates a \e{soft dependency}, meaning
that it is not considered an error if the given module cannot be found.
In such a case, an instance of the respective module will be created, but
- only the \c present property will be available for querying, and it will be
- set to \c false.
+ only the \l{Module::present}{Module.present} property will be available for
+ querying, and it will be set to \c false.
\defaultvalue \c true
*/
@@ -161,7 +164,7 @@
more than one profile, you can specify here which instance of the product
the dependency is on.
- See the \c profiles property of the \l{qbs} module for more information.
+ See the \l{qbs::profiles}{qbs.profiles} property for more information.
An empty list means a dependency on all instances of the product with the given name,
regardless of their profile.
diff --git a/doc/reference/items/language/parameters.qdoc b/doc/reference/items/language/parameters.qdoc
index 6a2e779de..bbccb222c 100644
--- a/doc/reference/items/language/parameters.qdoc
+++ b/doc/reference/items/language/parameters.qdoc
@@ -52,8 +52,8 @@
}
\endcode
- Every dependency on \e{foo} has the parameter \c{cpp.link} set to
- \c{false} by default.
+ Every dependency on \e{foo} has the parameter \l{dependency-parameters-cpp}
+ {cpp.link} set to \c{false} by default.
This can be overridden explicitly:
\code
diff --git a/doc/reference/items/language/rule.qdoc b/doc/reference/items/language/rule.qdoc
index ff8626e95..e048ee6c0 100644
--- a/doc/reference/items/language/rule.qdoc
+++ b/doc/reference/items/language/rule.qdoc
@@ -170,8 +170,8 @@
Here's how this product is built:
\list 1
\li \QBS looks for a rule that can produce artifacts with the file tag
- \c{"application"}. Such a rule is found in the \c cpp module (namely, the rule that
- invokes the linker).
+ \c{"application"}. Such a rule is found in the \l{cpp} module
+ (namely, the rule that invokes the linker).
\li Since the rule found in the previous step takes inputs of type \c{"obj"}, \QBS now
looks for a rule that produces artifacts of that type. Again, such a rule is found in
the \c cpp module (the rule that runs the compiler).
diff --git a/doc/reference/items/language/subproject.qdoc b/doc/reference/items/language/subproject.qdoc
index 955b092f1..703b581bc 100644
--- a/doc/reference/items/language/subproject.qdoc
+++ b/doc/reference/items/language/subproject.qdoc
@@ -45,8 +45,10 @@
}
\endcode
- If you don't need to set any properties on the sub-project, you can also use the \c references
- property, the same way you would do for a product:
+ If you do not need to set any properties on the sub-project, you can also
+ use the \l{Project::references}{Project.references} property, the same way
+ you would for a product:
+
\code
references: "subdir/project.qbs"
\endcode