Doc: add docs for the gui JavaScript object

Text was copied from packagemanagergui.cpp.

Change-Id: Idca8ce779bd5a3dbf5b3e7e4eca085c82973447e
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>

1 files changed, 36 insertions, 1 deletions

diff --git a/doc/scripting-api/gui.qdoc b/doc/scripting-api/gui.qdoc
index e81ebd68d..70d79ba89 100644
--- a/doc/scripting-api/gui.qdoc
+++ b/doc/scripting-api/gui.qdoc
@@ -33,22 +33,34 @@
 
 /*!
     \qmlsignal gui::interrupted()
+
+    This signal is emitted when the end user chooses to cancel the installation
+    and quit the installer.
 */
 
 /*!
     \qmlsignal gui::languageChanged()
+
+    This signal is emitted when the application language changes.
 */
 
 /*!
     \qmlsignal gui::finishButtonClicked()
+
+    This signal is emitted when the \uicontrol Finish button is clicked.
+
 */
 
 /*!
     \qmlsignal gui::gotRestarted()
+
+    This signal is emitted when the installer is restarted.
 */
 
 /*!
-    \qmlsignal gui::settingsButtonClicked();
+    \qmlsignal gui::settingsButtonClicked()
+
+    This signal is emitted when the \uicontrol Settings button is clicked.
 */
 
 /*!
@@ -73,10 +85,15 @@
 
 /*!
     \qmlmethod object gui::pageWidgetByObjectName(string name)
+
+    For dynamic pages, returns the widget specified by \a name read from the UI
+    file.
 */
 
 /*!
     \qmlmethod string gui::defaultButtonText(int wizardButton)
+
+    Returns the default text for the button specified by \a wizardButton.
 */
 
 /*!
@@ -88,14 +105,22 @@
 
 /*!
     \qmlmethod boolean gui::isButtonEnabled(int wizardButton)
+
+    Returns \c true if the button specified by \a wizardButton is enabled.
+    Returns \c false if a button of the specified type is not found.
+
 */
 
 /*!
     \qmlmethod void gui::showSettingsButton(boolean show)
+
+    Shows the \uicontrol Settings button if \a show is \c true.
 */
 
 /*!
     \qmlmethod void gui::setSettingsButtonEnabled(boolean enable)
+
+    Enables the \uicontrol Settings button by setting \a enable to \c true.
 */
 
 /*!
@@ -116,18 +141,28 @@
 
 /*!
     \qmlmethod void gui::cancelButtonClicked()
+
+    Asks end users whether they want to cancel the operation and quit the
+    installer, uninstaller, or package manager.
 */
 
 /*!
     \qmlmethod void gui::reject()
+
+    Quits the installer, uninstaller, or package manager.
 */
 
 /*!
     \qmlmethod void gui::rejectWithoutPrompt()
+
+    Quits the installer, uninstaller, or package manager without asking end
+    users for confirmation.
 */
 
 /*!
     \qmlmethod void gui::showFinishedPage()
+
+    Shows the next page.
 */
 
 /*!