From 38f4c5bf9a3beaab8d6ddb75c4847418c4254d46 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 14 Jan 2015 15:19:53 +0100 Subject: Doc: make example briefs more consistent Make clear that all current examples illustrate how to use component scripts. Change-Id: Id1015912723ed2f8f982d8316c8923e47e4897bc Reviewed-by: Jarek Kobus --- examples/doc/changeuserinterface.qdoc | 2 +- examples/doc/componenterror.qdoc | 3 ++- examples/doc/dynamicpage.qdoc | 2 +- examples/doc/modifyextract.qdoc | 3 ++- examples/doc/openreadme.qdoc | 4 ++-- examples/doc/quit_installer.qdoc | 2 +- examples/doc/registerfileextension.qdoc | 2 +- examples/doc/startmenu.qdoc | 2 +- examples/doc/systeminfo.qdoc | 3 ++- 9 files changed, 13 insertions(+), 10 deletions(-) (limited to 'examples') diff --git a/examples/doc/changeuserinterface.qdoc b/examples/doc/changeuserinterface.qdoc index 25d7d3257..15212756c 100644 --- a/examples/doc/changeuserinterface.qdoc +++ b/examples/doc/changeuserinterface.qdoc @@ -30,7 +30,7 @@ \ingroup qtifwexamples \title Change Installer UI Example - \brief Changing the installer UI by using a component script. + \brief Using a component script to modify the installer UI. \image qtifw-examples-changeuserinterface.png diff --git a/examples/doc/componenterror.qdoc b/examples/doc/componenterror.qdoc index d4e6ef17a..39a0dcb84 100644 --- a/examples/doc/componenterror.qdoc +++ b/examples/doc/componenterror.qdoc @@ -30,7 +30,8 @@ \ingroup qtifwexamples \title Component Error Example - \brief Stopping the installation if the components cannot be installed. + \brief Using a component script to stop the installation if the components + cannot be installed. \image qtifw-examples-componenterror.png diff --git a/examples/doc/dynamicpage.qdoc b/examples/doc/dynamicpage.qdoc index 959e13fa5..6c68fe336 100644 --- a/examples/doc/dynamicpage.qdoc +++ b/examples/doc/dynamicpage.qdoc @@ -30,7 +30,7 @@ \ingroup qtifwexamples \title Dynamic Page Installer Example - \brief Building an installer by using a script and dynamic pages. + \brief Using a component script and dynamic pages to build an installer. \image qtifw-examples-dynamicpages.png diff --git a/examples/doc/modifyextract.qdoc b/examples/doc/modifyextract.qdoc index 88cc45d37..7dbd455c2 100644 --- a/examples/doc/modifyextract.qdoc +++ b/examples/doc/modifyextract.qdoc @@ -30,7 +30,8 @@ \ingroup qtifwexamples \title Modify Extract Installer Example - \brief Using the extract archive hook to modify the target path. + \brief Using the extract archive hook in a component script to modify the + target path. \image qtifw-examples-modifyextract.png diff --git a/examples/doc/openreadme.qdoc b/examples/doc/openreadme.qdoc index b81812fb0..be24df084 100644 --- a/examples/doc/openreadme.qdoc +++ b/examples/doc/openreadme.qdoc @@ -30,8 +30,8 @@ \ingroup qtifwexamples \title Open ReadMe Example - \brief Adding a check box for opening the readme file to the final - installer page. + \brief Using a component script to add a check box for opening the readme + file to the final installer page. \image qtifw-examples-openreadme.png diff --git a/examples/doc/quit_installer.qdoc b/examples/doc/quit_installer.qdoc index 55b9f3ba3..fad964b4c 100644 --- a/examples/doc/quit_installer.qdoc +++ b/examples/doc/quit_installer.qdoc @@ -32,7 +32,7 @@ \image qtifw-examples-quit_installer.png - \brief Quitting an installer by using a script. + \brief Using a component script to quit an installer. \e{Quit Installer} illustrates how to use the \c Component() function to display a message box to end users for quitting the installation if some diff --git a/examples/doc/registerfileextension.qdoc b/examples/doc/registerfileextension.qdoc index 17bed5f45..2113f3e6e 100644 --- a/examples/doc/registerfileextension.qdoc +++ b/examples/doc/registerfileextension.qdoc @@ -30,7 +30,7 @@ \ingroup qtifwexamples \title Register File Extension Example - \brief Registering a filename extension on Windows. + \brief Using a component script to register a filename extension on Windows. \image qtifw-examples-registerfileextension.png diff --git a/examples/doc/startmenu.qdoc b/examples/doc/startmenu.qdoc index 8c8aa46b7..29973237c 100644 --- a/examples/doc/startmenu.qdoc +++ b/examples/doc/startmenu.qdoc @@ -30,7 +30,7 @@ \ingroup qtifwexamples \title Start Menu Shortcut Example - \brief Adding an entry to the Windows Start menu. + \brief Using a component script to add an entry to the Windows Start menu. \image qtifw-examples-startmenu.png diff --git a/examples/doc/systeminfo.qdoc b/examples/doc/systeminfo.qdoc index bd5ed2779..da3b99c10 100644 --- a/examples/doc/systeminfo.qdoc +++ b/examples/doc/systeminfo.qdoc @@ -30,7 +30,8 @@ \ingroup qtifwexamples \title System Information Example - \brief Checking operating system version and bitness in a script. + \brief Using the systemInfo API in a component script to check operating + system version and bitness. The \e{System Information Example} demonstrates how to use the \l{systemInfo} API to detect details about the target operating system. -- cgit v1.2.3