summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@theqtcompany.com>2015-08-19 16:27:27 +0200
committerKai Koehne <kai.koehne@theqtcompany.com>2015-08-20 08:59:29 +0000
commit3bad334b26bd1c604a0480fc3e2f46f0f8d8d86c (patch)
tree4c38daca6af902de1149b43a5783c1ce99809234 /doc
parentc417d953f743b8a273ea36ff7d7b1dc8b761d518 (diff)
Document installer.components() restrictions
It's not obvious for the innocent user that components() are only available once the metadata has been fetched (i.e. not in a control script / component constructor). Change-Id: I033a78442d7e676a8aa662898a897af9e4d0ab65 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/scripting-api/packagemanagercore.qdoc6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc
index c65ddce58..aeb116329 100644
--- a/doc/scripting-api/packagemanagercore.qdoc
+++ b/doc/scripting-api/packagemanagercore.qdoc
@@ -35,9 +35,11 @@
/*!
\qmlmethod array installer::components()
- Returns an array of all available components.
+ Returns an array of all components currently available.
+ If the repository metadata have not been fetched yet,
+ the array will be empty.
- \sa component
+ \sa component, installer::finishAllComponentsReset(), installer::finishUpdaterComponentsReset()
*/
/*!