mirror of
https://github.com/QuasarApp/installer-framework.git
synced 2025-04-29 06:54:31 +00:00
Doc: replace \a with \c in .qdoc files
The \a command should only be used in code documentation (in .cpp files), where QDoc uses it to check that all formal parameters are documented and emits warnings if they are not or if they are misspelled. Change-Id: I37710afcd860f9baa3042337aca98fac6701b997 Reviewed-by: Niels Weber <niels.weber@digia.com>
This commit is contained in:
Leena Miettinen
parent
7d0aff2380
commit
990d17f1fe
@ -194,16 +194,16 @@
|
||||
\li Filename for a custom window icon in PNG format for the Installer application.
|
||||
\row
|
||||
\li Logo
|
||||
\li Filename for a logo used as \a QWizard::LogoPixmap.
|
||||
\li Filename for a logo used as \c QWizard::LogoPixmap.
|
||||
\row
|
||||
\li Watermark
|
||||
\li Filename for a watermark used as \a QWizard::WatermarkPixmap.
|
||||
\li Filename for a watermark used as \c QWizard::WatermarkPixmap.
|
||||
\row
|
||||
\li Banner
|
||||
\li Filename for a banner used as \a QWizard::BannerPixmap (only used by ModernStyle).
|
||||
\li Filename for a banner used as \c QWizard::BannerPixmap (only used by ModernStyle).
|
||||
\row
|
||||
\li Background
|
||||
\li Filename for an image used as \a QWizard::BackgroundPixmap (only used by MacStyle).
|
||||
\li Filename for an image used as \c QWizard::BackgroundPixmap (only used by MacStyle).
|
||||
\row
|
||||
\li WizardStyle
|
||||
\li Set the wizard style to be used ("Modern", "Mac", "Aero" or "Classic").
|
||||
@ -307,7 +307,7 @@
|
||||
A component can contain one or more user interface files, which are placed
|
||||
into the installer by a script. The installer automatically loads all user
|
||||
interface files listed in package.xml. You can access the loaded widgets
|
||||
by calling \a QInstaller::Component::userInterface with the class name of
|
||||
by calling \c QInstaller::Component::userInterface with the class name of
|
||||
the widget, as illustrated by the following code snippet:
|
||||
|
||||
\code
|
||||
@ -315,9 +315,9 @@
|
||||
\endcode
|
||||
|
||||
To add a new page to the installer, use
|
||||
the \a QInstaller::Installer::addWizardPage method and specify the location
|
||||
the \c QInstaller::Installer::addWizardPage method and specify the location
|
||||
of the new page. For example, the following code adds an instance of
|
||||
\a MyPage before the ready for installation page:
|
||||
\c MyPage before the ready for installation page:
|
||||
|
||||
\code
|
||||
installer.addWizardPage( component, "MyPage", QInstaller.ReadyForInstallation );
|
||||
@ -329,8 +329,8 @@
|
||||
single widgets (such as a check box).
|
||||
|
||||
To insert a single widget, use the
|
||||
\a QInstaller::Installer::addWizardPageItem method.
|
||||
For example, the following code snippet adds an instance of \a MyWidget to
|
||||
\c QInstaller::Installer::addWizardPageItem method.
|
||||
For example, the following code snippet adds an instance of \c MyWidget to
|
||||
the component selection page from within a script:
|
||||
|
||||
\code
|
||||
@ -347,13 +347,13 @@
|
||||
matches the current system locale. For example, if the system locale is
|
||||
German, the de_de.qm file is loaded.
|
||||
|
||||
Use the \a {qsTr()} function for literal text within scripts. Additionally,
|
||||
you can add the \a Component.prototype.retranslateUi method to the script.
|
||||
Use the \c {qsTr()} function for literal text within scripts. Additionally,
|
||||
you can add the \c Component.prototype.retranslateUi method to the script.
|
||||
It is called when the language of the installer changes and the translation
|
||||
file is loaded.
|
||||
|
||||
The context being used for translation is the basename of the script file
|
||||
when using \a qsTr or the class name of the UI file when translating a user
|
||||
when using \c qsTr or the class name of the UI file when translating a user
|
||||
interface.
|
||||
|
||||
\note The translation system can also be used to customize the UI. Use e.g.
|
||||
@ -602,7 +602,7 @@
|
||||
###TODO insert link here.
|
||||
|
||||
For information about how to implement data integration into the
|
||||
installer binary, see \a QInstaller::BinaryContent ###TODO insert link here.
|
||||
installer binary, see \c QInstaller::BinaryContent ###TODO insert link here.
|
||||
|
||||
\note If you change this configuration, you must recompile the
|
||||
\c installerbase tool.
|
||||
@ -880,7 +880,7 @@
|
||||
are not available.
|
||||
|
||||
Alternatively, you can create online installers that do not contain any data
|
||||
and that fetch all the data from the web server. Use the \a{-n} parameter
|
||||
and that fetch all the data from the web server. Use the \c{-n} parameter
|
||||
of the \c binarycreator tool and only add the root component to the
|
||||
installer. Usually the root component is empty and hence only adds the XML
|
||||
description of the root.
|
||||
@ -905,7 +905,7 @@
|
||||
does not allow end users to connect to web servers. The network
|
||||
administrator can set up a local update service within the network.
|
||||
|
||||
To create offline installers, use the \a{--offline-only} option of the
|
||||
To create offline installers, use the \c{--offline-only} option of the
|
||||
\c binarycreator tool.
|
||||
|
||||
To create an offline installer in Windows, enter the following command:
|
||||
@ -942,7 +942,7 @@
|
||||
|
||||
\li Copy the updated content to the package directory.
|
||||
|
||||
\li Increase the value of the \a{Version} setting for the updated
|
||||
\li Increase the value of the \c{Version} setting for the updated
|
||||
components in the package.xml file.
|
||||
|
||||
\li Use the \c repogen tool to recreate the online repository with the
|
||||
@ -962,7 +962,7 @@
|
||||
the online version number in the file is greater than the local one, the
|
||||
installer displays it in the list of available updates.
|
||||
|
||||
Increase the value of the \a{Version} setting for the component in the
|
||||
Increase the value of the \c{Version} setting for the component in the
|
||||
package.xml file.
|
||||
|
||||
\section1 Recreating Repositories
|
||||
@ -985,10 +985,10 @@
|
||||
to verify the download of the archive and hence the SHA needs to match the
|
||||
7zip. As the SHAs are stored in the Updates.xml file you will be
|
||||
forced to upload the full repository. This can be circumvented by using the
|
||||
\a{--update} option of repogen.
|
||||
\c{--update} option of repogen.
|
||||
|
||||
\section2 Creating Partial Updates
|
||||
When recreating the online repository, use the \a{--update} parameter. It
|
||||
When recreating the online repository, use the \c{--update} parameter. It
|
||||
takes an existing repository as input and only changes the components that
|
||||
are specified as additional parameters. Only those SHA sums are
|
||||
changed in the global configuration as well.
|
||||
@ -997,8 +997,8 @@
|
||||
Upload the following items to the web server:
|
||||
\list
|
||||
\li The component directory (usually something like
|
||||
\a{com.vendor.product.updatedpart}).
|
||||
\li The global \a{Updates.xml} stored in the root directory of the online
|
||||
\c{com.vendor.product.updatedpart}).
|
||||
\li The global \c{Updates.xml} stored in the root directory of the online
|
||||
repository.
|
||||
\endlist
|
||||
|
||||
|
||||
@ -39,7 +39,7 @@
|
||||
|
||||
\section1 Introduction Page
|
||||
|
||||
Call the \a IntroductionPageCallback function to construct the introduction
|
||||
Call the \c IntroductionPageCallback function to construct the introduction
|
||||
page.
|
||||
|
||||
Wizard buttons:
|
||||
@ -50,7 +50,7 @@
|
||||
|
||||
\section1 License Check Page
|
||||
|
||||
Call the \a LicenseAgreementPageCallback function to construct the license
|
||||
Call the \c LicenseAgreementPageCallback function to construct the license
|
||||
check page.
|
||||
|
||||
Wizard buttons:
|
||||
@ -62,17 +62,17 @@
|
||||
|
||||
Radio buttons:
|
||||
\list
|
||||
\li \a acceptLicenseRB
|
||||
\li \c acceptLicenseRB
|
||||
|
||||
Accepts the license agreement. Not selected by default.
|
||||
\li \a rejectLicenseRB
|
||||
\li \c rejectLicenseRB
|
||||
|
||||
Rejects the license agreement. Selected by default.
|
||||
\endlist
|
||||
|
||||
\section1 Target Directory Selection Page
|
||||
|
||||
Call the \a TargetDirectoryPageCallback function to implement the target
|
||||
Call the \c TargetDirectoryPageCallback function to implement the target
|
||||
directory selection page.
|
||||
|
||||
Wizard buttons:
|
||||
@ -83,11 +83,11 @@
|
||||
\endlist
|
||||
|
||||
To specify a default value for the target directory for installation, use
|
||||
the \a targetDirectoryLE line edit widget.
|
||||
the \c targetDirectoryLE line edit widget.
|
||||
|
||||
\section1 Component Selection Page
|
||||
|
||||
Call the \a ComponentSelectionPageCallback function to implement the
|
||||
Call the \c ComponentSelectionPageCallback function to implement the
|
||||
component selection page.
|
||||
|
||||
Wizard buttons:
|
||||
@ -99,29 +99,29 @@
|
||||
|
||||
Methods:
|
||||
\list
|
||||
\li \a {selectComponent( id )}
|
||||
\li \c {selectComponent( id )}
|
||||
|
||||
Selects the component with \c id (string).
|
||||
\li \a {deselectComponent( id )}
|
||||
\li \c {deselectComponent( id )}
|
||||
|
||||
Deselects the component with \c id (string).
|
||||
\endlist
|
||||
|
||||
In uninstallation mode, additional radio buttons are available:
|
||||
\list
|
||||
\li \a uninstallAllComponentsRB
|
||||
\li \c uninstallAllComponentsRB
|
||||
|
||||
Uninstalls all components. Default.
|
||||
\li \a keepSelectedComponentsRB
|
||||
\li \c keepSelectedComponentsRB
|
||||
|
||||
Uninstalls only unselected components. Mark components selected
|
||||
(\a selectComponent) or not selected (\a deselectComponent) to add
|
||||
(\c selectComponent) or not selected (\c deselectComponent) to add
|
||||
and remove components.
|
||||
\endlist
|
||||
|
||||
\section1 Ready for Installation Page
|
||||
|
||||
Call the \a ReadyForInstallationPageCallback function to implement the ready
|
||||
Call the \c ReadyForInstallationPageCallback function to implement the ready
|
||||
for installation page.
|
||||
|
||||
Wizard buttons:
|
||||
@ -133,10 +133,10 @@
|
||||
|
||||
\section1 Perform Installation Page
|
||||
|
||||
Call the \a IntroductionPageCallback function to implement the perform
|
||||
Call the \c IntroductionPageCallback function to implement the perform
|
||||
installation page.
|
||||
|
||||
To show or hide installation details, implement the \a details.button push
|
||||
To show or hide installation details, implement the \c details.button push
|
||||
button widget.
|
||||
|
||||
Wizard buttons:
|
||||
@ -146,7 +146,7 @@
|
||||
|
||||
\section1 Installation Finished Page
|
||||
|
||||
Call the \a FinishedPageCallback function to implement the installation
|
||||
Call the \c FinishedPageCallback function to implement the installation
|
||||
finished page.
|
||||
|
||||
Wizard buttons:
|
||||
@ -156,9 +156,9 @@
|
||||
|
||||
\section1 Custom Pages
|
||||
|
||||
Custom pages are registered as \a{Dynamic${ObjectName}}, where \a{${ObjectName}}
|
||||
Custom pages are registered as \c{Dynamic${ObjectName}}, where \c{${ObjectName}}
|
||||
is the object name set in the UI file.
|
||||
Thus, the \a{Dynamic${ObjectName}Callback()} function is called. Widgets can
|
||||
Thus, the \c{Dynamic${ObjectName}Callback()} function is called. Widgets can
|
||||
be addressed using their object names (from the UI file):
|
||||
\code
|
||||
var page = gui.pageWidgetByObjectName( "DynamicSomePage" )
|
||||
@ -174,27 +174,27 @@
|
||||
\li Possible Answers
|
||||
\li Description
|
||||
\row
|
||||
\li \a cancelInstallation
|
||||
\li \c cancelInstallation
|
||||
\li Yes, No
|
||||
\li Confirmation for canceling the installation when end
|
||||
users select \gui Cancel on the installer pages.
|
||||
\row
|
||||
\li \a overwriteTargetDirectory
|
||||
\li \c overwriteTargetDirectory
|
||||
\li Yes, No
|
||||
\li Confirmation for using an already existing directory as
|
||||
the target directory for installation.
|
||||
\row
|
||||
\li \a installationError
|
||||
\li \c installationError
|
||||
\li OK
|
||||
\li A fatal error occurred while performing the
|
||||
installation.
|
||||
\row
|
||||
\li \a installationErrorWithRetry
|
||||
\li \c installationErrorWithRetry
|
||||
\li Retry, Ignore, Cancel
|
||||
\li An error occurred while performing the installation.
|
||||
End users can select \gui Retry to try again.
|
||||
\row
|
||||
\li \a metaInfoJobError
|
||||
\li \c metaInfoJobError
|
||||
\li OK
|
||||
\li An error occurred while retrieving meta information
|
||||
when using an online installer.
|
||||
|
||||
@ -52,47 +52,47 @@
|
||||
\li Use
|
||||
\row
|
||||
\li Copy
|
||||
\li "Copy" \a source \a target
|
||||
\li Copies a file from \a source to \a target.
|
||||
\li "Copy" \c source \c target
|
||||
\li Copies a file from \c source to \c target.
|
||||
\row
|
||||
\li Move
|
||||
\li "Move" \a source \a target
|
||||
\li Moves a file from \a source to \a target.
|
||||
\li "Move" \c source \c target
|
||||
\li Moves a file from \c source to \c target.
|
||||
\row
|
||||
\li Delete
|
||||
\li "Delete" \a filename
|
||||
\li Deletes the file specified by \a filename.
|
||||
\li "Delete" \c filename
|
||||
\li Deletes the file specified by \c filename.
|
||||
\row
|
||||
\li Mkdir
|
||||
\li "Mkdir" \a path
|
||||
\li Creates the directory path \a path.
|
||||
\li "Mkdir" \c path
|
||||
\li Creates the directory path \c path.
|
||||
\row
|
||||
\li Rmdir
|
||||
\li "Rmdir" \a path
|
||||
\li Removes the directory path \a path.
|
||||
\li "Rmdir" \c path
|
||||
\li Removes the directory path \c path.
|
||||
\row
|
||||
\li AppendFile
|
||||
\li "AppendFile" \a filename \a text
|
||||
\li Appends \a text to the file specified by \a filename. \a text is
|
||||
\li "AppendFile" \c filename \c text
|
||||
\li Appends \c text to the file specified by \c filename. \c text is
|
||||
treated as ASCII text.
|
||||
\row
|
||||
\li PrependFile
|
||||
\li "PrependFile" \a filename \a text
|
||||
\li Prepends \a text to the file specified by \a filename. \a text
|
||||
\li "PrependFile" \c filename \c text
|
||||
\li Prepends \c text to the file specified by \c filename. \c text
|
||||
is treated as ASCII text.
|
||||
\row
|
||||
\li Replace
|
||||
\li "Replace" \a file \a search \ replace
|
||||
\li Opens \a file to find \a search string and replaces that with the \a replace string.
|
||||
\li "Replace" \c file \c search \ replace
|
||||
\li Opens \c file to find \c search string and replaces that with the \c replace string.
|
||||
\row
|
||||
\li LineReplace
|
||||
\li "LineReplace" \a file \a search \ replace
|
||||
\li Opens \a file to find lines that start with \a search string and
|
||||
replaces that with the \a replace string.
|
||||
\li "LineReplace" \c file \c search \ replace
|
||||
\li Opens \c file to find lines that start with \c search string and
|
||||
replaces that with the \c replace string.
|
||||
\row
|
||||
\li Execute
|
||||
\li "Execute" [{\a exitcodes}] \a command [\a parameter1 [\a parameter... [\a parameter10]]]
|
||||
\li Executes the command specified by \a command. Up to 10
|
||||
\li "Execute" [{\c exitcodes}] \c command [\c parameter1 [\c parameter... [\c parameter10]]]
|
||||
\li Executes the command specified by \c command. Up to 10
|
||||
parameters can be passed. If that is not enough, you can use a JavaScript string array.
|
||||
|
||||
Optionally, you can pass a comma-separated list of exit codes
|
||||
@ -111,18 +111,18 @@
|
||||
\endcode
|
||||
\row
|
||||
\li CreateShortcut
|
||||
\li "CreateShortcut" \a filename \a linkname [\a arguments]
|
||||
\li Creates a shortcut from the file specified by \a filename to
|
||||
\a linkname.
|
||||
\li "CreateShortcut" \c filename \c linkname [\c arguments]
|
||||
\li Creates a shortcut from the file specified by \c filename to
|
||||
\c linkname.
|
||||
On Windows, this creates a .lnk file which can have
|
||||
\a arguments. On Unix, this creates a symbolic link.
|
||||
\c arguments. On Unix, this creates a symbolic link.
|
||||
\row
|
||||
\li CreateDesktopEntry
|
||||
\li "CreateDesktopEntry" \a filename \a "key=value[\nkey2=value2[\nkey3=value3]]]"
|
||||
\li "CreateDesktopEntry" \c filename \c "key=value[\nkey2=value2[\nkey3=value3]]]"
|
||||
\li Creates a .desktop initialization file, as specified by
|
||||
freedesktop.org.
|
||||
|
||||
If \a filename is absolute, the desktop entry is stored there.
|
||||
If \c filename is absolute, the desktop entry is stored there.
|
||||
Otherwise, it is stored in the location specified in
|
||||
\c{$XDG_DATA_DIRS/applications} or
|
||||
\c{$XDG_DATA_HOME/applications}, including the default paths for
|
||||
@ -133,45 +133,45 @@
|
||||
The file is set to use UTF-8 encoding.
|
||||
\row
|
||||
\li InstallIcons
|
||||
\li "InstallIcons" \a directory \a [Vendorprefix]
|
||||
\li Installs the contents of \a directory into a location, as
|
||||
\li "InstallIcons" \c directory \c [Vendorprefix]
|
||||
\li Installs the contents of \c 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
|
||||
If you provide a \c Vendorprefix it replaces all characters up to the
|
||||
first dash (-) in the filename of the icon with this prefix.
|
||||
\row
|
||||
\li Extract
|
||||
\li "Extract" \a archive \a targetdirectory
|
||||
\li Extracts \a archive to \a targetdirectory.
|
||||
\li "Extract" \c archive \c targetdirectory
|
||||
\li Extracts \c archive to \c targetdirectory.
|
||||
|
||||
\row
|
||||
\li GlobalConfig
|
||||
\li "GlobalConfig" \a company \a application \a key \a value
|
||||
\li "GlobalConfig" \c company \c application \c key \c value
|
||||
|
||||
or
|
||||
|
||||
"GlobalConfig" \a filename \a key \a value
|
||||
\li Stores \a value for \a key in a configuration file. The
|
||||
configuration file is specified either by \a filename
|
||||
(using \a QSettings::NativeFormat, which might be the Windows
|
||||
registry) or by \a application and \a company name.
|
||||
"GlobalConfig" \c filename \c key \c value
|
||||
\li Stores \c value for \c key in a configuration file. The
|
||||
configuration file is specified either by \c filename
|
||||
(using \c QSettings::NativeFormat, which might be the Windows
|
||||
registry) or by \c application and \c company name.
|
||||
\row
|
||||
\li EnvironmentVariable
|
||||
\li "EnvironmentVariable" \a key \a value [[\a persistent] \a system]
|
||||
\li Sets the environment variable \a key to \a value. If
|
||||
\a persistent is set to \c true, the variable is set
|
||||
\li "EnvironmentVariable" \c key \c value [[\c persistent] \c system]
|
||||
\li Sets the environment variable \c key to \c value. If
|
||||
\c persistent is set to \c true, the variable is set
|
||||
persistently. This is currently only supported on Windows.
|
||||
If \a system is set to \c true, the persistent variable is set
|
||||
If \c system is set to \c true, the persistent variable is set
|
||||
system-wide, not only for the current user.
|
||||
\row
|
||||
\li RegisterFileType
|
||||
\li "RegisterFileType" \a extension \a command [\a description [\a contentType [\a icon]]].
|
||||
\li Registers the file type with \a extension to be opened via
|
||||
\a command. Optionally, you can specify \a description,
|
||||
\a contentType, and \a icon. This is currently only supported on
|
||||
\li "RegisterFileType" \c extension \c command [\c description [\c contentType [\c icon]]].
|
||||
\li Registers the file type with \c extension to be opened via
|
||||
\c command. Optionally, you can specify \c description,
|
||||
\c contentType, and \c icon. This is currently only supported on
|
||||
Windows.
|
||||
\endtable
|
||||
|
||||
|
||||
@ -41,10 +41,10 @@
|
||||
|
||||
The script has to contain a \c Component object that the installer creates
|
||||
when it loads the script. Therefore, the script must contain at
|
||||
least the \a Component() function, which performs initialization, such as
|
||||
least the \c Component() function, which performs initialization, such as
|
||||
putting pages in the correct places or connecting signals and slots.
|
||||
|
||||
The following code snippet places the \a ErrorPage (which is the class
|
||||
The following code snippet places the \c ErrorPage (which is the class
|
||||
name of the user interface file loaded from errorpage.ui) in front of the
|
||||
ready for installation page and sets its completeness to \c false.
|
||||
|
||||
@ -69,16 +69,16 @@
|
||||
\li Method
|
||||
\li Description
|
||||
\row
|
||||
\li \a{Component.prototype.retranslateUi}
|
||||
\li \c{Component.prototype.retranslateUi}
|
||||
\li Called when the language of the installer changes.
|
||||
\row
|
||||
\li \a{Component.prototype.createOperations}
|
||||
\li \c{Component.prototype.createOperations}
|
||||
\li See \l Component::createOperations.
|
||||
\row
|
||||
\li \a{Component.prototype.createOperationsForArchive}
|
||||
\li \c{Component.prototype.createOperationsForArchive}
|
||||
\li See \l Component::createOperationsForArchive.
|
||||
\row
|
||||
\li \a{Component.prototype.createOperationsForPath}
|
||||
\li \c{Component.prototype.createOperationsForPath}
|
||||
\li See \l Component::createOperationsForPath.
|
||||
\endtable
|
||||
|
||||
@ -111,20 +111,20 @@
|
||||
\endlist
|
||||
|
||||
For your convenience, the values for QMessageBox::StandardButton are made
|
||||
available by using \a QMessageBox.Ok, \a QMessageBox.Open, and so on.
|
||||
available by using \c QMessageBox.Ok, \c QMessageBox.Open, and so on.
|
||||
|
||||
\section1 Adding Operations to Components
|
||||
|
||||
You might want to add custom operations after extracting the content, when
|
||||
copying files or patching file content, for example. You can create and add
|
||||
update operations to the installation from within
|
||||
a script using \a QInstaller::Component::addOperation.
|
||||
a script using \c QInstaller::Component::addOperation.
|
||||
If you need to run an operation that requires administrative rights, use
|
||||
\a QInstaller::Component::addElevatedOperation instead.
|
||||
\c QInstaller::Component::addElevatedOperation instead.
|
||||
|
||||
Each operation has a unique key used for identification and can take up to
|
||||
five parameters. In the parameter values, you can use variables as set in
|
||||
\a QInstaller::Installer::setValue. For more information, see
|
||||
\c QInstaller::Installer::setValue. For more information, see
|
||||
\l{Predefined Variables}.
|
||||
|
||||
For a summary of all available operations, see \l{Operations}.
|
||||
@ -132,7 +132,7 @@
|
||||
\section1 Registering Custom Operations
|
||||
|
||||
You can register custom installation operations in the installer by deriving
|
||||
\a KDUpdater::UpdateOperation. The following code displays the methods that
|
||||
\c KDUpdater::UpdateOperation. The following code displays the methods that
|
||||
you must implement:
|
||||
|
||||
\code
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user