From b2ecd1b628550a6cbe37dcc24cc4aa5258df451f Mon Sep 17 00:00:00 2001
From: Gerhard Hoffmann <g.hoffmann@atb-online.eu>
Date: Thu, 18 Sep 2025 13:53:12 +0200
Subject: [PATCH] Minor: define structure for doxygen-documentation

---
 UpdatePTUDevCtrl/main.cpp | 45 ++++++++++++++++++++++-----------------
 1 file changed, 26 insertions(+), 19 deletions(-)

diff --git a/UpdatePTUDevCtrl/main.cpp b/UpdatePTUDevCtrl/main.cpp
index 3ddc9b5..0a1e012 100644
--- a/UpdatePTUDevCtrl/main.cpp
+++ b/UpdatePTUDevCtrl/main.cpp
@@ -50,25 +50,32 @@
 #endif
 
 /**
- * @mainpage ATBUpdateTool Documentation
- * @section intro_sec Introduction
- * TODO.
- * @section atbupdate_tool ATBUpdateTool
- * TODO.
- * @section atbupdate_check ATBUpdateCheck
- * TODO
- * @section atbupdate_git ATBUpdateGit
- * TODO
- * @section atbupdate_sync ATBUpdateSync
- * TODO
- * @section atbupdate_opkg ATBUpdateOpkg
- * TODO
- * @section atbupdate_dc ATBUpdateDC
- * TODO
- * @section atbupdate_json_files ATBUpdateJsonFiles
- * TODO
- * @section atbupdate_show ATBUpdateShow
- * TODO
+ * @mainpage ATB-Update-Tool Documentation
+ * \section intro_sec Introduction
+ *  The ATB update tool consistes of several binaries, which are executed in
+ *  order:
+ *  * \ref ATBUpdateTool
+ *  * \ref ATBUpdateCheck
+ *  * \ref ATBUpdateGit
+ *  * \ref ATBUpdateSync
+ *  * \ref ATBUpdateOpkg
+ *  * \ref ATBUpdateDC
+ *  * \ref ATBUpdateJsonFiles
+ *  * \ref ATBUpdateShow
+ *
+ *  The binaries are started synchonously as child processes of \ref ATBUpdateTool:
+ *  each binary will finish before the next one is started.
+ *  The output for the child process is captured in \ref ATBUpdateTool, and
+ *  optionally shown in the GUI presemted to the user.
+ *
+ * - \page ATBUpdateTool
+ * - \page ATBUpdateCheck
+ * - \page ATBUpdateGit
+ * - \page ATBUpdateSync
+ * - \page ATBUpdateOpkg
+ * - \page ATBUpdateDC
+ * - \page ATBUpdateJsonFiles
+ * - \page ATBUpdateShow
  */
 
 // argv[1]: file to send to dc