From 12eafc2878bc9dda386fa3e4555e994709f6a7cf Mon Sep 17 00:00:00 2001
From: Gerhard Hoffmann <g.hoffmann@atb-online.eu>
Date: Tue, 16 Sep 2025 13:07:27 +0200
Subject: [PATCH] start to add doxygen-comments

---
 UpdatePTUDevCtrl/worker.h | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/UpdatePTUDevCtrl/worker.h b/UpdatePTUDevCtrl/worker.h
index 34a97aa..da18be8 100644
--- a/UpdatePTUDevCtrl/worker.h
+++ b/UpdatePTUDevCtrl/worker.h
@@ -143,7 +143,21 @@ class Command;
 class Update;
 class MainWindow;
 class hwinf;
-class Worker : public QThread{
+
+/*!
+    \class Worker
+    \brief The worker class ties together the parts the update tool consists of:
+         * ATBUpdateTool
+         * ATBUpdateCheck
+         * ATBUpdateGit
+         * ATBUpdateSync
+         * ATBUpdateOpkg
+         * ATBUpdateDC
+         * ATBUpdateJsonFiles
+         * ATBUpdateShow
+         *
+*/
+class Worker : public QObject {
     Q_OBJECT
 
     int const m_customerNr;
@@ -438,6 +452,29 @@ public:
     static const QString UPDATE_STEP_WRONG;
     static const QString UPDATE_STEP_SUCCESS;
 
+    /**
+     * Create a new Worker object to be used as the controlling instance of the
+     * update process.
+     *
+     * @brief Constructor
+     * @param customerNr
+     * @param machineNr
+     * @param zoneNr
+     * @param repositoryUrl
+     * @param branchName
+     * @param pluginDir
+     * @param pluginName
+     * @param workingDir
+     * @param noUpdatePsaHardware
+     * @param alwaysDownloadConfig
+     * @param alwaysDownloadDC
+     * @param dryRun
+     * @param parent
+     * @param serialInterface
+     * @param baudrate
+     *
+     * @todo einige parameter werden wohl ueberfluessig
+     */
     explicit Worker(int customerNr, // 281
                     int machineNr,
                     int zoneNr,