From 4660fb7b3f4a9e30ac05d83b8a5e33e7550fe347 Mon Sep 17 00:00:00 2001
From: Lennard Karger <lennard.karger@stud.hs-hannover.de>
Date: Sun, 18 Sep 2022 20:20:53 +0200
Subject: [PATCH] =?UTF-8?q?Update=20Kommentare=20f=C3=BCr=20Anwenderfunkti?=
 =?UTF-8?q?onen?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 libraries/BlePoll/BlePoll.cpp |  6 +++---
 libraries/BlePoll/BlePoll.h   | 23 ++++++++++++++++++++++-
 2 files changed, 25 insertions(+), 4 deletions(-)

diff --git a/libraries/BlePoll/BlePoll.cpp b/libraries/BlePoll/BlePoll.cpp
index 878c420..00a564c 100644
--- a/libraries/BlePoll/BlePoll.cpp
+++ b/libraries/BlePoll/BlePoll.cpp
@@ -1370,7 +1370,7 @@ void BlePoll::smWaitComES()
 //
 
 // neue Steuerungsdaten für einen Slave
-//
+
 void BlePoll::updControl(int adr, byte *ctrlList, int nr)
 {
   if(adr <= 0) return;
@@ -1387,7 +1387,7 @@ void BlePoll::updControl(int adr, byte *ctrlList, int nr)
 }
 
 // Feststellenn, ob Übertragung der Steuerungsdaten erfolgt ist
-//
+
 bool BlePoll::ackTrans(int adr)
 {
   if(adr <= 0) return(false);
@@ -1398,7 +1398,7 @@ bool BlePoll::ackTrans(int adr)
 }
 
 // Feststellen, ob Steuerungsdaten beim Slave verarbeitet sind
-//
+
 bool BlePoll::ackControl(int adr)
 {
   if(adr <= 0) return(false);
diff --git a/libraries/BlePoll/BlePoll.h b/libraries/BlePoll/BlePoll.h
index daa22da..59757af 100644
--- a/libraries/BlePoll/BlePoll.h
+++ b/libraries/BlePoll/BlePoll.h
@@ -427,9 +427,30 @@ public:
   // --------------------------------------------------------------------------
   //
   void run();       // Ablaufsteuerung (CPU-Übergabe) dieses Moduls
-
+/**
+ * @brief Sendet neue Steuerungsdaten an einen Slave
+ * 
+ * @param adr Addresse d. zu Steuernden Slaves
+ * @param ctrlList Liste mit Bytes zum Austausch der Steuerbytes
+ * @param nr Anzahl d. Steuerbytes
+ */
   void updControl(int adr, byte *ctrlList, int nr);   // neue Steuerungsdaten
+  //
+/**
+ * @brief Prüft ob Steuerungsdaten übertragen wurden
+ * 
+ * @param adr Adresse d. Slaves
+ * @return true Erfolgreiche übertragung
+ * @return false Fehler in Übertragung / Falsche Adresse
+ */
   bool ackTrans(int adr);         // Bestätigung Steuerungsdaten übertragen
+  /**
+ * @brief Überprüft ob Steuerungsdaten korrekt übertragen wurden
+ * 
+ * @param adr Adresse d. Slavrs
+ * @return true Daten erfolgreich verarbeitet
+ * @return false Fehler in Übertragung
+ */
   bool ackControl(int adr);       // Bestätigung Steuerung ausgeführt
 
 
-- 
GitLab