diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/config/installerfw-project.qdocconf | 15 | ||||
-rw-r--r-- | doc/examples/config.xml | 1 | ||||
-rw-r--r-- | doc/installerfw-getting-started.qdoc | 2 | ||||
-rw-r--r-- | doc/installerfw.qdoc | 34 | ||||
-rw-r--r-- | doc/operations.qdoc | 4 | ||||
-rw-r--r-- | doc/scripting.qdoc | 31 |
6 files changed, 55 insertions, 32 deletions
diff --git a/doc/config/installerfw-project.qdocconf b/doc/config/installerfw-project.qdocconf index 3b96a00af..fc0074d8c 100644 --- a/doc/config/installerfw-project.qdocconf +++ b/doc/config/installerfw-project.qdocconf @@ -3,6 +3,12 @@ description = "Qt Installer Framework Manual" headerdirs = sourcedirs = $SRCDIR + +# Contains documentation for JS API +sources = $SRCDIR/../src/libs/installer/packagemanagercore.cpp \ + $SRCDIR/../src/libs/installer/component.cpp \ + $SRCDIR/../src/libs/installer/messageboxhandler.cpp + imagedirs = $SRCDIR/images $SRCDIR/templates/images outputdir = $OUTDIR exampledirs = $SRCDIR $SRCDIR/examples @@ -13,7 +19,7 @@ include(macros.qdocconf) include(qt-cpp-ignore.qdocconf) include(qt-defines.qdocconf) -sources.fileextensions = "*.qdoc" +sources.fileextensions = "*.qdoc *.cpp" qhp.projects = InstallerFramework qhp.InstallerFramework.file = ifw.qhp @@ -34,3 +40,10 @@ qhp.InstallerFramework.subprojects.manual.type = manual macro.see = "\\sa" macro.function = "\\fn" + + +# We 'misuse' QML doc commands to generate JS documentation +# (only works with qdoc from Qt 5) + +outputprefixes = QML +outputprefixes.QML = diff --git a/doc/examples/config.xml b/doc/examples/config.xml index c234bab25..daf212711 100644 --- a/doc/examples/config.xml +++ b/doc/examples/config.xml @@ -8,6 +8,7 @@ <Logo>logo.png</Logo> <Watermark>watermark.png</Watermark> <RunProgram></RunProgram> + <RunProgramArguments></RunProgramArguments> <RunProgramDescription></RunProgramDescription> <StartMenuDir>Some Application Entry Dir</StartMenuDir> <UninstallerName>SDKMaintenanceTool</UninstallerName> diff --git a/doc/installerfw-getting-started.qdoc b/doc/installerfw-getting-started.qdoc index 84a3c5b5e..1b21ac664 100644 --- a/doc/installerfw-getting-started.qdoc +++ b/doc/installerfw-getting-started.qdoc @@ -41,7 +41,7 @@ You can use the Qt Installer Framework to create installers for all platforms supported by - \l{http://doc.qt.nokia.com/5.0-snapshot/supported-platforms.html} + \l{http://qt-project.org/doc/qt-5.0/qtdoc/platform-details.html} {desktop Qt}. The installers have been tested on the following platforms: diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index fbcab3cd4..b5b08dc6e 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -182,7 +182,15 @@ \row \o Icon \o Filename for a custom installer icon. The actual file is looked up by attaching - a '.icns' (Mac OS X), '.ico' (Windows) or '.png' (Unix) suffix. + a '.icns' (Mac OS X), '.ico' (Windows) or '.png' (Unix) suffix. Deprecated, + use InstallerApplicationIcon and / or InstallerWindowIcon instead. + \row + \o InstallerApplicationIcon + \o Filename for a custom installer icon. The actual file is looked up by attaching + a '.icns' (Mac OS X), '.ico' (Windows). No functionality on Unix. + \row + \o InstallerWindowIcon + \o Filename for a custom window icon in PNG format for the Installer application. \row \o Logo \o Filename for a logo used as \a QWizard::LogoPixmap. @@ -190,6 +198,9 @@ \o Watermark \o Filename for a watermark used as \a QWizard::WatermarkPixmap. \row + \o Banner + \o Filename for a banner used as \a QWizard::BannerPixmap. + \row \o Background \o Filename for an image used as \a QWizard::BackgroundPixmap. \row @@ -197,6 +208,9 @@ \o Command executed after the installer is done if the user accepts the action. \row + \o RunProgramArguments + \o Arguments passed to the program specified in RunProgram. + \row \o RunProgramDescription \o Text shown next to the check box for running the program after the installation. Defaults to \gui {Run <Name>}. @@ -246,10 +260,6 @@ \row \o TargetConfigurationFile \o Filename for the configuration file on the target. Default is components.xml. - \row - \o Pages - \o Custom strings for labels in the installer pages. Deprecated, - see \l{Translating Pages} instead. \endtable */ @@ -772,12 +782,12 @@ repogen.exe -p <package_directory> -c <config_directory>\<config_file> repository <repository_directory> - For example, to create a repository that contains only com.nokia.sdk.qt and - com.nokia.sdk.qtcreator, enter the following + For example, to create a repository that contains only org.qt-project.sdk.qt and + org.qt-project.sdk.qtcreator, enter the following command: \code - repogen.exe -p packages -c installer-config\config.xml -i com.nokia.sdk.qt,com.nokia.sdk.qtcreator repository + repogen.exe -p packages -c installer-config\config.xml -i org.qt-project.sdk.qt,org.qt-project.sdk.qtcreator repository \endcode When the repository has been created, upload it to a web server. You must @@ -834,12 +844,12 @@ \endcode For example, enter the following command to create an installer binary - called SDKInstaller.exe that will not contain data for com.nokia.sdk.qt and - com.nokia.qtcreator, because those packages are downloaded from a remote + called SDKInstaller.exe that will not contain data for org.qt-project.sdk.qt and + org.qt-project.qtcreator, because those packages are downloaded from a remote repository: \code - binarycreator.exe -p installer-packages -c installer-config\config.xml -e com.nokia.sdk.qt,com.nokia.qtcreator SDKInstaller.exe + binarycreator.exe -p installer-packages -c installer-config\config.xml -e org.qt-project.sdk.qt,org.qt-project.qtcreator SDKInstaller.exe \endcode \section1 Reducing Installer Size @@ -886,7 +896,7 @@ Some options have default values, and therefore, you can omit them. For example, enter the following command to create an installer binary called SDKInstaller.exe that contains the packages identified by - com.nokia.sdk and their dependencies: + org.qt-project.sdk and their dependencies: \code binarycreator.exe --offline-only -c installer-config -p installer-packes SDKInstaller.exe diff --git a/doc/operations.qdoc b/doc/operations.qdoc index b187a20cf..2a29a519d 100644 --- a/doc/operations.qdoc +++ b/doc/operations.qdoc @@ -132,13 +132,15 @@ The file is set to use UTF-8 encoding. \row \o InstallIcons - \o "InstallIcons" \a directory + \o "InstallIcons" \a directory \a [Vendorprefix] \o Installs the contents of \a directory into a location, as specified by freedesktop.org. That is, into \c {$XDG_DATA_DIRS/icons}, \c {/usr/share/icons}, or \c {$HOME/.icons}. The files are removed from their initial location. Make sure to add this operation after the operation that extracts the files from the archive. + If you provide a \a Vendorprefix it replaces all characters up to the + first dash (-) in the filename of the icon with this prefix. \row \o Extract \o "Extract" \a archive \a targetdirectory diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc index 410e1645a..d0094575c 100644 --- a/doc/scripting.qdoc +++ b/doc/scripting.qdoc @@ -57,8 +57,8 @@ } \endcode - For more information, see the documentation for \a addWizardPage and - \a userInterface. + For more information, see the documentation for \l QInstaller::addWizardPage and + \l Component::userInterface. \section1 Installer Hooks @@ -73,13 +73,13 @@ \o Called when the language of the installer changes. \row \o \a{Component.prototype.createOperations} - \o See \a QInstaller::Component::createOperations. + \o See \l Component::createOperations. \row \o \a{Component.prototype.createOperationsForArchive} - \o See \a QInstaller::Component::createOperationsForArchive. + \o See \l Component::createOperationsForArchive. \row \o \a{Component.prototype.createOperationsForPath} - \o See \a QInstaller::Component::createOperationsForPath. + \o See \l Component::createOperationsForPath. \endtable \section1 Global Variables @@ -92,25 +92,22 @@ \o Description \row \o installer - \o Reference to the \a installer of the component + \o Reference to the \l QInstaller of the component \row \o component - \o Reference to the \a Component of the component + \o Reference to the \l Component of the component \endtable - All methods marked with \a Q_INVOKABLE as well as all signals, slots, and - properties can be used by the script. - \section1 Message Boxes - You can show a \a QMessageBox from within the script by using: + You can show a \l QMessageBox from within the script by using: - \code - QMessageBox.critical - QMessageBox.information - QMessageBox.question - QMessageBox.warning - \endcode + \list + \li \l QMessageBox::critical + \li \l QMessageBox::information + \li \l QMessageBox::question + \li \l QMessageBox::warning + \endlist For your convenience, the values for \a QMessageBox::StandardButton are made available by using \a QMessageBox.Ok, \a QMessageBox.Open, and so on. |