GerhardHoffmann/ATBUpdateTool
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor: define structure for doxygen-documentation

Browse Source
This commit is contained in:
Gerhard Hoffmann
2025-09-18 13:53:12 +02:00
parent fb4da1f208
commit b2ecd1b628
1 changed files with 26 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
UpdatePTUDevCtrl/main.cpp
View File

@@ -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