From e77ddbb1ab09c25af17e657e2f300abf6db1e8f6 Mon Sep 17 00:00:00 2001
From: "evgenii.tagiltsev" <tagiltsev.evgenii@gmail.com>
Date: Thu, 12 Dec 2019 18:26:38 +0100
Subject: [PATCH] [*] added comments for code

---
 CellFrameDashboardGUI/DapCommandController.h  | 18 +++++++++++++----
 CellFrameDashboardGUI/DapServiceController.h  |  1 +
 CellFrameDashboardGUI/DapTransaction.cpp      |  1 +
 CellFrameDashboardGUI/DapTransaction.h        | 10 ++++++++++
 .../DapChainDashboardService.h                | 20 +++++++++++++++----
 .../DapChainTransaction.h                     |  2 ++
 6 files changed, 44 insertions(+), 8 deletions(-)

diff --git a/CellFrameDashboardGUI/DapCommandController.h b/CellFrameDashboardGUI/DapCommandController.h
index 2859362..e9bb6d3 100644
--- a/CellFrameDashboardGUI/DapCommandController.h
+++ b/CellFrameDashboardGUI/DapCommandController.h
@@ -116,8 +116,9 @@ private slots:
     void processGetCmdHistory();
 
  // ---------------------------------------------
+    /// Handling service response for get wallet data
     void processGetWalletData();
-
+    /// Handling service response for get result of putting transaction to mempool
     void processGetResultTransaction();
 
 public slots:
@@ -176,12 +177,21 @@ public slots:
 
 
 // ---------------------------------------------
+    /// Response wallet data
+    /// @param data
     void setNewWalletData(const QVariant& aData);
-
+    /// Request wallet data
     void requestWalletData();
-
+    /// Request for creation new transaction
+    /// @param name of wallet
+    /// @param address of a receiver
+    /// @param name of token
+    /// @param name of network
+    /// @param sum for transaction
+    /// @return result of trying to do transaction
     void sendMempool(const QString& aFromWallet, const QString& aToAddress, const QString& aToken, const QString& aNetwork, const quint64 aValue);
-
+    /// Taking everything from mempool
+    /// @param network
     void takeFromMempool(const QString& aNetwork);
 };
 
diff --git a/CellFrameDashboardGUI/DapServiceController.h b/CellFrameDashboardGUI/DapServiceController.h
index 27d0805..d2fe094 100644
--- a/CellFrameDashboardGUI/DapServiceController.h
+++ b/CellFrameDashboardGUI/DapServiceController.h
@@ -176,6 +176,7 @@ public slots:
     static QObject *singletonProvider(QQmlEngine *engine, QJSEngine *scriptEngine);
 
 public slots:
+    /// Request wallet data
     void requestWalletData();
 };
 
diff --git a/CellFrameDashboardGUI/DapTransaction.cpp b/CellFrameDashboardGUI/DapTransaction.cpp
index 372c381..01f91e1 100644
--- a/CellFrameDashboardGUI/DapTransaction.cpp
+++ b/CellFrameDashboardGUI/DapTransaction.cpp
@@ -23,5 +23,6 @@ void DapTransaction::sendToken(const QString& aNetwork)
 
 void DapTransaction::receiveResult(const bool aSuccessful)
 {
+    if(aSuccessful) emit sendToken("private");
     emit sendResult(aSuccessful);
 }
diff --git a/CellFrameDashboardGUI/DapTransaction.h b/CellFrameDashboardGUI/DapTransaction.h
index 23fa41f..90e8d69 100644
--- a/CellFrameDashboardGUI/DapTransaction.h
+++ b/CellFrameDashboardGUI/DapTransaction.h
@@ -12,8 +12,18 @@ public:
     static DapTransaction& instance();
 
 public slots:
+    /// Request for creation new transaction
+    /// @param name of wallet
+    /// @param address of a receiver
+    /// @param name of token
+    /// @param name of network
+    /// @param sum for transaction
     void createRequestTransaction(const QString& aFromWallet, const QString& aToAddress, const QString& aToken, const QString& aNetwork, const quint64 aValue);
+    /// Taking everything from mempool
+    /// @param network
     void sendToken(const QString& aNetwork);
+    /// Recevie result of putting to mempool
+    /// @param successful or not
     void receiveResult(const bool aSuccessful);
 
 signals:
diff --git a/CellFrameDashboardService/DapChainDashboardService.h b/CellFrameDashboardService/DapChainDashboardService.h
index e6e039b..808cfbc 100755
--- a/CellFrameDashboardService/DapChainDashboardService.h
+++ b/CellFrameDashboardService/DapChainDashboardService.h
@@ -137,12 +137,23 @@ public slots:
     /// @return history of last 50 commands
     QString getCmdHistory() const;
 
+    /// Add new wallet
+    /// @param wallet name
+    /// @return sucessful or not
     bool appendWallet(const QString& aWalletName) const;
-
+    /// Wallets data
+    /// @return data
     QByteArray walletData() const;
-
+    /// Putting new transaction in mempool
+    /// @param name of wallet
+    /// @param address of a receiver
+    /// @param name of token
+    /// @param name of network
+    /// @param sum for transaction
+    /// @return sucessful or not
     bool createTransaction(const QString& aFromWallet, const QString& aToAddress, const QString& aTokenName, const QString& aNetwork, const quint64 aValue);
-
+    /// Taking everything from mempool
+    /// @param network
     void takeFromMempool(const QString& aNetwork);
 
 private slots:
@@ -151,7 +162,8 @@ private slots:
     /// Send new history transaction to client
     /// @param New history transaction
     void doSendNewHistory(const QVariant& aData);
-
+    /// Taking everything from mempool
+    /// @param network
     void doSendNewWalletData(const QByteArray& aData);
 };
 
diff --git a/CellFrameDashboardService/DapChainTransaction.h b/CellFrameDashboardService/DapChainTransaction.h
index 7b13307..e7a3a3a 100644
--- a/CellFrameDashboardService/DapChainTransaction.h
+++ b/CellFrameDashboardService/DapChainTransaction.h
@@ -21,6 +21,8 @@ public:
     /// @return result of trying to do transaction
     bool createTransaction(const QString& aFromWallet, const QString& aToAddress, const QString& aTokenName, const QString& aNetwork, const quint64 aValue) const;
 
+    /// Taking everything from mempool
+    /// @param network
     void takeFromMempool(const QString& aNetwork);
 };
 
-- 
GitLab