diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2014-07-10 16:00:51 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2014-07-15 13:06:41 +0200 |
commit | bf83f72c0f1fbecd8007cad39df9b6cfdc3bd85e (patch) | |
tree | d96b87e8291804c1013a1388955cea5f3bebc794 /doc/includes | |
parent | a0c051656cc5538a4dd11ba3bf5028b3c4f91e5e (diff) |
Doc: add docs for Change UI Example
Describe the example files.
Add example file extensions to the qdocconf file to
have all files listed on the doc page.
Fix capitalization in the configuration file.
Use more descriptive values for the component in the
package information file. Rearrange sections to be able
to use an include file for documenting all package
information files.
Add more detailed information about creating the installer.
Add image.
Change-Id: I64ffff29d08f1dff4cd92c3b796f1a0e6c2fb280
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
Diffstat (limited to 'doc/includes')
-rw-r--r-- | doc/includes/installerfw-examples-configuring.qdocinc | 8 | ||||
-rw-r--r-- | doc/includes/installerfw-examples-generating.qdocinc | 18 | ||||
-rw-r--r-- | doc/includes/installerfw-examples-packaging.qdocinc | 4 |
3 files changed, 21 insertions, 9 deletions
diff --git a/doc/includes/installerfw-examples-configuring.qdocinc b/doc/includes/installerfw-examples-configuring.qdocinc index 681e3b9d7..b75abab8d 100644 --- a/doc/includes/installerfw-examples-configuring.qdocinc +++ b/doc/includes/installerfw-examples-configuring.qdocinc @@ -15,8 +15,8 @@ \li The \c <StartMenuDir> section specifies the name of the default program group for the product in the Windows \gui Start menu. \li The \c <TargetDir> section specifies that the default target - directory displayed to users is \c InstallationDirectory in the home - directory of the current user (because the predefined variable - \c @HomeDir@ is used as a part of the value). For more information, - see \l{Predefined Variables}. + directory displayed to users is \c IfwExample in the home directory + of the current user (because the predefined variable\c @HomeDir@ is + used as a part of the value). For more information, see + \l{Predefined Variables}. \endlist diff --git a/doc/includes/installerfw-examples-generating.qdocinc b/doc/includes/installerfw-examples-generating.qdocinc index e019bd788..45ea2fc22 100644 --- a/doc/includes/installerfw-examples-generating.qdocinc +++ b/doc/includes/installerfw-examples-generating.qdocinc @@ -1,5 +1,17 @@ \section1 Generating the Example Installer - \code - binarycreator --offline-only -c config/config.xml -p packages installer - \endcode + To create the example installer, switch to the example source directory on + the command line and enter the following command: + + \list + \li On Windows: + \code + ..\..\bin\binarycreator.exe -c config\config.xml -p packages installer.exe + \endcode + \li On Linux or OS X: + \code + ../../bin/binarycreator -c config/config.xml -p packages installer + \endcode + \endlist + + The installer is created in the current directory. diff --git a/doc/includes/installerfw-examples-packaging.qdocinc b/doc/includes/installerfw-examples-packaging.qdocinc index ec7e82b29..d3a873f2c 100644 --- a/doc/includes/installerfw-examples-packaging.qdocinc +++ b/doc/includes/installerfw-examples-packaging.qdocinc @@ -8,8 +8,8 @@ the component. \li The \c <Description> section specifies the human-readable description of the component. + \li The \c <Version> section specifies the version number of the + component. \li The \c <ReleaseDate> section specifies the date when this component version was released. - \li The \c <Script> section specifies the file name of the JavaScript - file that is loaded. \endlist |