added core qml doc

Author: Skycoder42

doc/Doxyfile

@@ -2202,7 +2202,7 @@ INCLUDE_FILE_PATTERNS  = *.h \
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             =
+PREDEFINED             = DOXYGEN_RUN
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

doc/autoupdater.dox doc/qtautoupdater.doxdoc/autoupdater.dox renamed to doc/qtautoupdater.dox

@@ -22,6 +22,23 @@ a gui and the Core-Library.
 - UpdateButton
 */
 
+/*!
+@namespace de::skycoder42::QtAutoUpdater::Core
+
+@brief The QML import for the QtAutoUpdater core 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
+	- @ref de::skycoder42::QtAutoUpdater::Core::QtAutoUpdater "QtAutoUpdater" (singleton)
+	- @ref QtAutoUpdater::UpdateInfo "UpdateInfo" (uncreatable)
+	- @ref QtAutoUpdater::UpdaterBackend "UpdaterBackend" (uncreatable)
+	- @ref QtAutoUpdater::UpdateInstaller "UpdateInstaller" (uncreatable)
+	- @ref QtAutoUpdater::Updater "Updater" (uncreatable)
+*/
+
 /*!
 @page qtautoupdater_image_page Image Page
 

src/imports/autoupdatercore/qmlautoupdatersingleton.cpp

@@ -37,9 +37,9 @@ Updater *QmlAutoUpdaterSingleton::createUpdater(QSettings *config, QObject *pare
 	return Updater::create(config, parent);
 }
 
-Updater *QmlAutoUpdaterSingleton::createUpdater(QString key, QVariantMap arguments, QObject *parent) const
+Updater *QmlAutoUpdaterSingleton::createUpdater(QString key, QVariantMap configuration, QObject *parent) const
 {
-	return Updater::create(std::move(key), std::move(arguments), parent);
+	return Updater::create(std::move(key), std::move(configuration), parent);
 }
 
 Updater *QmlAutoUpdaterSingleton::createUpdater(QObject *qmlConfigOrParent) const

src/imports/autoupdatercore/qmlautoupdatersingleton.h

@@ -9,25 +9,85 @@
 #include <QtAutoUpdaterCore/Updater>
 #include <QtAutoUpdaterCore/UpdaterBackend>
 
+
+#ifdef DOXYGEN_RUN
+namespace de::skycoder42::QtAutoUpdater::Core {
+
+/*! @brief A singleton class to create instances of different QtAutoUpdater types
+ *
+ * @extends QtQml.QtObject
+ * @since 3.0
+ */
+class QtAutoUpdater
+#else
+namespace QtAutoUpdater {
+
 class QmlAutoUpdaterSingleton : public QObject
+#endif
 {
 	Q_OBJECT
 
 public:
+	//! @private
 	explicit QmlAutoUpdaterSingleton(QObject *parent = nullptr);
 
+	//! Creates a QtAutoUpdater::UpdateInfo from the given parameters
 	Q_INVOKABLE QVariant createInfo(QVariant identifier, QString name, const QVariant &version, QVariantMap data = {}) const;
+	//! Converts a list of QtAutoUpdater::UpdateInfos to a QVariantList, which can be consumed in QML
 	Q_INVOKABLE QVariantList infosAsList(const QList<QtAutoUpdater::UpdateInfo> &infos) const;
 
 
+	//! @copydoc QtAutoUpdater::Updater::create(const QString &, QObject*)
 	Q_INVOKABLE QtAutoUpdater::Updater *createUpdater(const QString &configPath,
 													  QObject *parent = nullptr) const;
+	//! @copydoc QtAutoUpdater::Updater::create(QSettings *, QObject*)
 	Q_INVOKABLE QtAutoUpdater::Updater *createUpdater(QSettings *config,
 													  QObject *parent = nullptr) const;
+	//! @copydoc QtAutoUpdater::Updater::create(QString, QVariantMap, QObject*)
 	Q_INVOKABLE QtAutoUpdater::Updater *createUpdater(QString key,
-													  QVariantMap arguments,
+													  QVariantMap configuration,
 													  QObject *parent = nullptr) const;
+	/*! @brief Creates an updater instance using the given object as either QML configuration or as parent
+	 *
+	 * @param qmlConfigOrParent The object to be consumed
+	 * @returns A newly created updater instance or `nullptr`, if unable to create one.
+	 *
+	 * The qmlConfigOrParent can be interpreted in different ways. If it is a Qt.labs.settings.Settings instance,
+	 * it is used as the configuration, but not as the parent. Otherwise it is used as the parent.
+	 *
+	 * The backend is loaded based on the given configuration. It must contain the "backend" entry, set to
+	 * the updater backend to be used. If the backend is missing or invalid, nullptr is returned. Otherwise
+	 * the created instance, initialized using the given configuration.
+	 *
+	 * @attention For some update installations, an updater needs to be launched on exit of the running
+	 * application. This only works if the updater lives long enough to catch the
+	 * QCoreApplication::aboutToQuit signal! This means when creating an updater for a backend that may need
+	 * to be run on exit, you should use either `qApp` or `nullptr` as parent for the updater.
+	 *
+	 * @sa Updater::supportedUpdaterBackends, @ref backends_TODO "Updater Backend Plugins", Qt.labs.settings.Settings
+	 */
 	Q_INVOKABLE QtAutoUpdater::Updater *createUpdater(QObject *qmlConfigOrParent = nullptr) const;
+	/*! @brief Creates an updater instance using the given QML configuration and parent
+	 *
+	 * @param qmlConfig The configuration object
+	 * @param parent The object to be set as the parent for the created updater
+	 * @returns A newly created updater instance or `nullptr`, if unable to create one.
+	 *
+	 * The qmlConfig must be an instance of Qt.labs.settings.Settings or QSettings. If it is neither, no updater
+	 * can be created an nullptr gets returned
+	 *
+	 * The backend is loaded based on the given configuration. It must contain the "backend" entry, set to
+	 * the updater backend to be used. If the backend is missing or invalid, nullptr is returned. Otherwise
+	 * the created instance, initialized using the given configuration.
+	 *
+	 * @attention For some update installations, an updater needs to be launched on exit of the running
+	 * application. This only works if the updater lives long enough to catch the
+	 * QCoreApplication::aboutToQuit signal! This means when creating an updater for a backend that may need
+	 * to be run on exit, you should use either `qApp` or `nullptr` as parent for the updater.
+	 *
+	 * @sa Updater::supportedUpdaterBackends, @ref backends_TODO "Updater Backend Plugins", Qt.labs.settings.Settings,
+	 * QSettings
+	 */
 	Q_INVOKABLE QtAutoUpdater::Updater *createUpdater(QObject *qmlConfig,
 													  QObject *parent) const;
 
@@ -46,4 +106,6 @@ class QmlAutoUpdaterSingleton : public QObject
 	};
 };
 
+}
+
 #endif // QMLAUTOUPDATERSINGLETON_H