From 0e1640b9fc6d0ad322fe407ba6541c2c4d5325c4 Mon Sep 17 00:00:00 2001
From: jgromes <jan.gromes@gmail.com>
Date: Fri, 24 May 2019 21:25:22 +0200
Subject: [PATCH] [ESP8266] Added Doxygen comments

---
 src/modules/ESP8266.h | 39 +++++++++++++++++++++++++++++++++++----
 1 file changed, 35 insertions(+), 4 deletions(-)

diff --git a/src/modules/ESP8266.h b/src/modules/ESP8266.h
index ffd860c5..c03a0d58 100644
--- a/src/modules/ESP8266.h
+++ b/src/modules/ESP8266.h
@@ -5,16 +5,47 @@
 
 #include "../protocols/TransportLayer.h"
 
+/*!
+  \class ESP8266
+
+  \brief Control class for %ESP8266 module. Implements TransportLayer methods.
+*/
 class ESP8266: public TransportLayer {
   public:
-    // constructor
+    /*!
+      \brief Default constructor.
+
+      \param mod Instance of Module that will be used to communicate with the radio.
+    */
     ESP8266(Module* module);
-    
+
     // basic methods
+
+    /*!
+      \brief Initialization method.
+
+      \param speed Baud rate to use for UART interface.
+
+      \returns \ref status_codes
+    */
     int16_t begin(long speed);
+
+    /*!
+      \brief Resets module using AT command.
+
+      \returns \ref status_codes
+    */
     int16_t reset();
+
+    /*!
+      \brief Joins access point.
+
+      \param ssid Access point SSID.
+
+      \param password Access point password.
+    */
     int16_t join(const char* ssid, const char* password);
-    
+
     // transport layer methods (implementations of purely virtual methods in TransportMethod class)
     int16_t openTransportConnection(const char* host, const char* protocol, uint16_t port, uint16_t tcpKeepAlive = 0);
     int16_t closeTransportConnection();
@@ -22,7 +53,7 @@ class ESP8266: public TransportLayer {
     int16_t send(uint8_t* data, uint32_t len);
     size_t receive(uint8_t* data, size_t len, uint32_t timeout = 10000);
     size_t getNumBytes(uint32_t timeout = 10000, size_t minBytes = 10);
-    
+
   private:
     Module* _mod;
 };