diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config/installerfw-project.qdocconf | 15 | ||||
| -rw-r--r-- | doc/scripting.qdoc | 31 |
2 files changed, 28 insertions, 18 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/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. |