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 <jaroslaw.kobus@theqtcompany.com>
This commit is contained in:
Leena Miettinen 2015-01-14 15:19:53 +01:00
parent 735b67dd8b
commit 38f4c5bf9a
10 changed files with 16 additions and 10 deletions

View File

@ -33,4 +33,7 @@
\title Qt Installer Framework Examples \title Qt Installer Framework Examples
\brief Illustrate how to customize installers. \brief Illustrate how to customize installers.
These examples illustrate how to use component scripts for customizing
installers.
*/ */

View File

@ -30,7 +30,7 @@
\ingroup qtifwexamples \ingroup qtifwexamples
\title Change Installer UI Example \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 \image qtifw-examples-changeuserinterface.png

View File

@ -30,7 +30,8 @@
\ingroup qtifwexamples \ingroup qtifwexamples
\title Component Error Example \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 \image qtifw-examples-componenterror.png

View File

@ -30,7 +30,7 @@
\ingroup qtifwexamples \ingroup qtifwexamples
\title Dynamic Page Installer Example \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 \image qtifw-examples-dynamicpages.png

View File

@ -30,7 +30,8 @@
\ingroup qtifwexamples \ingroup qtifwexamples
\title Modify Extract Installer Example \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 \image qtifw-examples-modifyextract.png

View File

@ -30,8 +30,8 @@
\ingroup qtifwexamples \ingroup qtifwexamples
\title Open ReadMe Example \title Open ReadMe Example
\brief Adding a check box for opening the readme file to the final \brief Using a component script to add a check box for opening the readme
installer page. file to the final installer page.
\image qtifw-examples-openreadme.png \image qtifw-examples-openreadme.png

View File

@ -32,7 +32,7 @@
\image qtifw-examples-quit_installer.png \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 \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 display a message box to end users for quitting the installation if some

View File

@ -30,7 +30,7 @@
\ingroup qtifwexamples \ingroup qtifwexamples
\title Register File Extension Example \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 \image qtifw-examples-registerfileextension.png

View File

@ -30,7 +30,7 @@
\ingroup qtifwexamples \ingroup qtifwexamples
\title Start Menu Shortcut Example \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 \image qtifw-examples-startmenu.png

View File

@ -30,7 +30,8 @@
\ingroup qtifwexamples \ingroup qtifwexamples
\title System Information Example \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 The \e{System Information Example} demonstrates how to use the \l{systemInfo} API to detect
details about the target operating system. details about the target operating system.