completed quick doc

Author: Skycoder42

doc/Doxyfile

@@ -274,6 +274,7 @@ ALIASES                = "accessors{1}=<table><tr><th colspan= 2>Accessors</th><
 						 userAc{1}=<tr><td><b>USER</b></td><td>\1</td></tr> \
 						 "constantAc=<tr><td colspan= 2><b>CONSTANT</b></td></tr>" \
 						 "finalAc=<tr><td colspan= 2><b>FINAL</b></td></tr>" \
+						 "readonlyAc=<tr><td colspan= 2><b>READONLY</b></td></tr>" \
 						 "default{1}=<b>Default:</b> \1 <br>" \
 						 "readAcFn{1}=READ accessor for \1" \
 						 "writeAcFn{1}=WRITE accessor for \1" \
@@ -342,7 +343,7 @@ OPTIMIZE_OUTPUT_SLICE  = NO
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
 # the files are not read by doxygen.
 
-EXTENSION_MAPPING      =
+EXTENSION_MAPPING      = qml=C++
 
 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
 # according to the Markdown format, which allows for more readable
@@ -916,7 +917,8 @@ FILE_PATTERNS          = *.c \
 						 *.qsf \
 						 *.as \
 						 *.js \
-						 *.qdoc
+						 *.qdoc \
+						 *.qml
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -934,7 +936,13 @@ RECURSIVE              = YES
 EXCLUDE                = ../src/3rdparty \
 						 ../src/plugins \
 						 ../src/jar \
-						 ../src/translations
+						 ../src/translations \
+						 ../src/imports/autoupdaterquick/ProgressItem.qml \
+						 ../src/imports/autoupdaterquick/UpdateInfoPage.qml \
+						 ../src/imports/autoupdaterquick/SelectComponentView.qml \
+						 ../src/imports/autoupdaterquick/InstallView.qml \
+						 ../src/imports/autoupdaterquick/SuccessView.qml \
+						 ../src/imports/autoupdaterquick/UpdateInstallerPage.qml
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -979,7 +987,10 @@ EXCLUDE_SYMBOLS        = QtAutoUpdaterCoreDeclarativeModule \
 						 QNode \
 						 QNodeCreatedChangeBase \
 						 QPaintEngineEx \
-						 QTechniqueFilter
+						 QTechniqueFilter \
+						 DelayButton \
+						 Dialog \
+						 QtObject
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
 # that contain example code fragments that are included (see the \include
@@ -1024,7 +1035,7 @@ IMAGE_PATH             = ./images
 # or removed, the anchors will not be placed correctly.
 #
 # Note that for custom extensions or not directly supported extensions you also
-# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# need to set  for the extension otherwise the files are not
 # properly processed by doxygen.
 
 INPUT_FILTER           =
@@ -1040,7 +1051,7 @@ INPUT_FILTER           =
 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
 # properly processed by doxygen.
 
-FILTER_PATTERNS        =
+FILTER_PATTERNS        = *.qml=doxyqml
 
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 # INPUT_FILTER) will also be used to filter the input files that are used for

doc/qtautoupdater.dox

@@ -39,6 +39,25 @@ a gui and the Core-Library.
 	- @ref QtAutoUpdater::Updater "Updater" (uncreatable)
 */
 
+/*!
+@namespace de::skycoder42::QtAutoUpdater::Quick
+
+@brief The QML import for the QtAutoUpdater quick QML module
+
+<b>Current Version</b><br/>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;3.0
+
+<b>Available Types</b>
+- Since Version 3.0
+	- UpdateInfoModel
+	- ProgressDialog
+	- AskUpdateDialog
+	- UpdateResultDialog
+	- UpdateInfoComponent
+	- UpdateInstallerComponent
+	- UpdateButton
+*/
+
 /*!
 @page qtautoupdater_image_page Image Page
 

src/imports/autoupdatercore/plugins.qmltypes

@@ -9,7 +9,7 @@ import QtQuick.tooling 1.2
 Module {
     dependencies: ["QtQml 2.13", "QtQml.Models 2.13"]
     Component {
-        name: "QmlAutoUpdaterSingleton"
+        name: "QtAutoUpdater::QmlAutoUpdaterSingleton"
         prototype: "QObject"
         exports: ["de.skycoder42.QtAutoUpdater.Core/QtAutoUpdater 3.0"]
         isCreatable: false
@@ -61,14 +61,14 @@ Module {
             name: "createUpdater"
             type: "QtAutoUpdater::Updater*"
             Parameter { name: "key"; type: "string" }
-            Parameter { name: "arguments"; type: "QVariantMap" }
+            Parameter { name: "configuration"; type: "QVariantMap" }
             Parameter { name: "parent"; type: "QObject"; isPointer: true }
         }
         Method {
             name: "createUpdater"
             type: "QtAutoUpdater::Updater*"
             Parameter { name: "key"; type: "string" }
-            Parameter { name: "arguments"; type: "QVariantMap" }
+            Parameter { name: "configuration"; type: "QVariantMap" }
         }
         Method {
             name: "createUpdater"

src/imports/autoupdatercore/qtautoupdatercore_plugin.cpp

@@ -7,6 +7,7 @@
 #include <QtAutoUpdaterCore/Updater>
 
 #include "qmlautoupdatersingleton.h"
+using namespace QtAutoUpdater;
 
 namespace {
 
@@ -26,10 +27,10 @@ void QtAutoUpdaterCoreDeclarativeModule::registerTypes(const char *uri)
 {
 	Q_ASSERT(qstrcmp(uri, "de.skycoder42.QtAutoUpdater.Core") == 0);
 
-	qmlRegisterUncreatableType<QtAutoUpdater::UpdateInfo>(uri, 3, 0, "UpdateInfo", QStringLiteral("Must be created by using the QtAutoUpdater singleton"));
-	qmlRegisterUncreatableType<QtAutoUpdater::UpdaterBackend>(uri, 3, 0, "UpdaterBackend", QStringLiteral("Cannot be created, only obtained via Updater"));
-	qmlRegisterUncreatableType<QtAutoUpdater::UpdateInstaller>(uri, 3, 0, "UpdateInstaller", QStringLiteral("Cannot be created, only obtained via Updater"));
-	qmlRegisterUncreatableType<QtAutoUpdater::Updater>(uri, 3, 0, "Updater", QStringLiteral("Must be created by using the QtAutoUpdater singleton"));
+	qmlRegisterUncreatableType<UpdateInfo>(uri, 3, 0, "UpdateInfo", QStringLiteral("Must be created by using the QtAutoUpdater singleton"));
+	qmlRegisterUncreatableType<UpdaterBackend>(uri, 3, 0, "UpdaterBackend", QStringLiteral("Cannot be created, only obtained via Updater"));
+	qmlRegisterUncreatableType<UpdateInstaller>(uri, 3, 0, "UpdateInstaller", QStringLiteral("Cannot be created, only obtained via Updater"));
+	qmlRegisterUncreatableType<Updater>(uri, 3, 0, "Updater", QStringLiteral("Must be created by using the QtAutoUpdater singleton"));
 
 	qmlRegisterSingletonType<QmlAutoUpdaterSingleton>(uri, 3, 0, "QtAutoUpdater", create_qtautoupdater);
 

src/imports/autoupdatercore/qtautoupdatercore_plugin.h

@@ -3,6 +3,8 @@
 
 #include <QtQml/QQmlExtensionPlugin>
 
+namespace QtAutoUpdater {
+
 class QtAutoUpdaterCoreDeclarativeModule : public QQmlExtensionPlugin
 {
 	Q_OBJECT
@@ -13,4 +15,6 @@ class QtAutoUpdaterCoreDeclarativeModule : public QQmlExtensionPlugin
 	void registerTypes(const char *uri) override;
 };
 
+}
+
 #endif // QTAUTOUPDATERCORE_PLUGIN_H

src/imports/autoupdaterquick/AskUpdateDialog.qml

@@ -3,6 +3,14 @@ import QtQuick.Layouts 1.13
 import QtQuick.Controls 2.13
 import de.skycoder42.QtAutoUpdater.Core 3.0
 
+/*! @brief A dialog to ask the user whether he wants to check for updates
+ *
+ * You can add this dialog to your UI and connect it to an updater. When you want to check for
+ * updates, show this dialog via open(). If the user accepts the question, the updater will
+ * automatically start the update check
+ *
+ * @sa QtAutoUpdater::Updater::checkForUpdates, @ref qtautoupdater_image_page "Image Page"
+ */
 DialogBase {
 	id: askDialog
 	visible: false

src/imports/autoupdaterquick/DialogBase.qml

@@ -2,9 +2,26 @@ import QtQuick 2.13
 import QtQuick.Controls 2.13
 import de.skycoder42.QtAutoUpdater.Core 3.0
 
+/*! @brief [INTERNAL] Base class for dialogs
+ *
+ * @extends QtQuick.Controls.Dialog
+ *
+ * @warning This class is internal and cannot be instanciated. It only exists as common base for
+ * the other dialogs
+ */
 Dialog {
 	id: dialogBase
 
+	/*! @brief The updater to be used by the dialog
+	 *
+	 * @default{`null`}
+	 *
+	 * @accessors{
+	 *	@memberAc{updater}
+	 * }
+	 *
+	 * @sa QtAutoUpdater::Updater
+	 */
 	property Updater updater: null
 
 	modal: true

src/imports/autoupdaterquick/ProgressDialog.qml

@@ -3,6 +3,14 @@ import QtQuick.Layouts 1.13
 import QtQuick.Controls 2.13
 import de.skycoder42.QtAutoUpdater.Core 3.0
 
+/*! @brief A dialog to show the progress of an update check
+ *
+ * You can add this dialog to your UI and connect it to an updater. As soon as the updater is
+ * checking for updates, this dialog will pop up automatically to show the progress and hide again,
+ * once finished.
+ *
+ * @sa QtAutoUpdater::Updater, @ref qtautoupdater_image_page "Image Page"
+ */
 DialogBase {
 	id: progressDialog
 

src/imports/autoupdaterquick/UpdateButton.qml

@@ -3,22 +3,107 @@ import QtQuick.Layouts 1.13
 import QtQuick.Controls 2.13
 import de.skycoder42.QtAutoUpdater.Core 3.0
 
+/*! @brief A simple button for update checks
+ *
+ * @extends QtQuick.Controls.DelayButton
+ *
+ * The UpdateButton is a ready-made "button" to check for updates. It is connected to an updater and
+ * thus will automatically start checking for updates. It will also display a progress and
+ * optionally allow canceling and installation of updates.
+ *
+ * The button will represent the updaters state and automatically enable/disable itself to
+ * avoid start beeing called twice. In addition to that, the whole button item will be disabled
+ * if the updater gets deleted while the button is still existant.
+ *
+ * @sa QtAutoUpdater::Updater, QtAutoUpdater::Updater::checkForUpdates,
+ * @ref qtautoupdater_image_page "Image Page"
+ */
 DelayButton {
 	id: updateButton
 
+	//! The different modes of what text to show on the button while checking for updates
 	enum TextMode {
-		Dynamic,
-		Static,
-		Cancel
+		Dynamic,  //!< If available the check status is shown as text. Otherwise same as Static
+		Static,  //!< A static "checking for updates" text is shown
+		Cancel  //!< The text shows "Cancel", and when clicked, the button will cancel the update check
 	}
 
+	/*! @brief The updater to be used by the button
+	 *
+	 * @default{`null`}
+	 *
+	 * @accessors{
+	 *	@memberAc{updater}
+	 * }
+	 * @sa QtAutoUpdater::Updater
+	 */
 	property Updater updater: null
+	/*! @brief The text mode while checking for updates
+	 *
+	 * @default{`UpdateButton::Cancel`}
+	 *
+	 * This mode defines what the button shows and does while checking for updates. Refer to the
+	 * documentation of the enum for more details.
+	 *
+	 * @accessors{
+	 *	@memberAc{textMode}
+	 * }
+	 *
+	 * @sa UpdateButton::TextMode
+	 */
 	property int textMode: UpdateButton.Cancel
+	/*! @brief Specifies if the button makes it possible for the user to install updates
+	 *
+	 * @default{`true`}
+	 *
+	 * If set to true and after an update check, there are new updates, the button will show
+	 * "Install" as text and when clicked start the update installation, according to the
+	 * installMode and installScope properties via QtAutoUpdater::Updater::runUpdater().
+	 *
+	 * If set to false, the button will instead show the information, that updates are available.
+	 * If clicked again, the button simply starts another updater check
+	 *
+	 * @accessors{
+	 *	@memberAc{allowInstall}
+	 * }
+	 *
+	 * @sa UpdateButton::installMode, UpdateButton::installScope, QtAutoUpdater::Updater::runUpdater
+	 */
 	property bool allowInstall: true
+	/*! @brief The installation mode to be used to install updates
+	 *
+	 * @default{`Updater::InstallModeFlag::Parallel`}
+	 *
+	 * The install mode to be passed to Updater::runUpdater, if the allowInstall flag is set and the
+	 * user launches an installation via the button.
+	 *
+	 * @accessors{
+	 *	@memberAc{installMode}
+	 * }
+	 *
+	 * @sa QtAutoUpdater::Updater::runUpdater, QtAutoUpdater::Updater::InstallModeFlag,
+	 * UpdateButton::installScope
+	 */
 	property int installMode: Updater.Parallel
+	/*! @brief The installation scope to be used to install updates
+	 *
+	 * @default{`Updater::InstallScope::PreferInternal`}
+	 *
+	 * The install scope to be passed to Updater::runUpdater, if allowInstall is set and the user
+	 * launches an installation via the button.
+	 *
+	 * @accessors{
+	 *	@memberAc{installScope}
+	 * }
+	 *
+	 * @sa QtAutoUpdater::Updater::runUpdater, QtAutoUpdater::Updater::InstallModeFlag,
+	 * UpdateButton::installMode
+	 */
 	property int installScope: Updater.PreferInternal
 
+	//! [PRIVATE PROPERTY]
 	property real _currentProgress: -1.0
+	//! [PRIVATE PROPERTY]
 	property string _currentStatus
 
 	states: [

src/imports/autoupdaterquick/UpdateInfoComponent.qml

@@ -1,12 +1,45 @@
 import QtQuick 2.13
 import de.skycoder42.QtAutoUpdater.Core 3.0
 
+/*! @brief A component that creates information views with detailed infos about updates
+ *
+ * This class should be placed in your GUI as a view factory. It will emit the showItem() or
+ * showComponent() signals (depending on useAsComponent) and you have to catch this signal to
+ * actually show the created UI. The UI is a custom QQuickItem and must be shown as full screen view.
+ *
+ * It is internally connected to the QtAutoUpdater::Updater::checkDone() signal of the used updater
+ * and will automatically emit the signal as soon as new updates are available.
+ *
+ * The following example shows how to realize this with a StackView as view container:
+ *
+ * @code{.qml}
+ * StackView {
+ *     id: stackView
+ *     anchors.fill: parent  // parent should be the root window
+ *     ...
+ * }
+ *
+ * UpdateInfoComponent {
+ *     id: component
+ *     updater: QtAutoUpdater.createUpdater(...)
+ *     useAsComponent: true
+ *
+ *     goBackCallback: stackView.pop
+ *     onShowItem: stackView.push(item)
+ * }
+ * @endcode
+ *
+ * @sa UpdaterComponent, UpdateResultDialog, UpdaterComponent::showItem,
+ * UpdaterComponent::showComponent, UpdaterComponent::useAsComponent, QtQuick.Controls.StackView,
+ * QtAutoUpdater::Updater::checkDone, @ref qtautoupdater_image_page "Image Page"
+ */
 UpdaterComponent {
 	id: updateInfoComponent
 
 	viewComponent: UpdateInfoPage {
 	}
 
+	//! [PRIVATE PROPERTY]
 	readonly property Connections _connections: Connections {
 		target: updater