start to add doxygen-comments
This commit is contained in:
		@@ -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,
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user