Update doc.

Signed-off-by: shennongmin <[email protected]>

Author: shennongmin

NexButton.h

@@ -27,6 +27,10 @@
 class NexButton: public NexTouch
 {
 public: /* methods */
+
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexButton(uint8_t pid, uint8_t cid, const char *name);
 
     uint16_t getText(char *buffer, uint16_t len);    

NexConfig.h

@@ -15,15 +15,23 @@
 #ifndef __NEXCONFIG_H__
 #define __NEXCONFIG_H__
 
-/* enable debug serial */
+/** 
+ * Define DEBUG_SERIAL_ENABLE to enable debug serial. 
+ * Comment it to disable debug serial. 
+ */
 #define DEBUG_SERIAL_ENABLE
 
-/* define serial for debug */
+/**
+ * Define dbSerial for the output of debug messages. 
+ */
 #define dbSerial Serial
 
-/* define serial for communicate with Nextion screen */
+/**
+ * Define nexSerial for communicate with Nextion touch panel. 
+ */
 #define nexSerial Serial2
 
+
 #ifdef DEBUG_SERIAL_ENABLE
 #define dbSerialPrint(a)    dbSerial.print(a)
 #define dbSerialPrintln(a)  dbSerial.println(a)

NexCrop.h

@@ -27,6 +27,10 @@
 class NexCrop: public NexTouch
 {
 public: /* methods */
+
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexCrop(uint8_t pid, uint8_t cid, const char *name);
 
     bool getPic(uint32_t *number);

NexGauge.h

@@ -27,6 +27,9 @@
 class NexGauge: public NexObject
 {
 public: /* methods */
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexGauge(uint8_t pid, uint8_t cid, const char *name);
 
     bool getValue(uint32_t *number);

NexHardware.cpp

@@ -217,16 +217,24 @@ bool recvRetCommandFinished(uint32_t timeout)
 }
 
 
+bool nexInit(void)
+{
+    bool ret1 = false;
+    bool ret2 = false;
+    
+    dbSerialBegin(9600);
+    nexSerial.begin(9600);
+    sendCommand("");
+    sendCommand("bkcmd=1");
+    ret1 = recvRetCommandFinished();
+    sendCommand("page 0");
+    ret2 = recvRetCommandFinished();
+    return ret1 && ret2;
+}
 
-/**
- * Watting for Nextion's touch event.
- * 
- * @param list - index to Nextion Components list. 
- * 
- */
-static void mainEventLoop(NexTouch **list)
+void nexLoop(NexTouch **nex_listen_list)
 {
-    static uint8_t __buffer[16];
+    static uint8_t __buffer[10];
 
     uint16_t i;
     uint8_t c;  
@@ -249,53 +257,11 @@ static void mainEventLoop(NexTouch **list)
 
                 if (0xFF == __buffer[4] && 0xFF == __buffer[5] && 0xFF == __buffer[6])
                 {
-                    NexTouch::iterate(list, __buffer[1], __buffer[2], (int32_t)__buffer[3]);
+                    NexTouch::iterate(nex_listen_list, __buffer[1], __buffer[2], (int32_t)__buffer[3]);
                 }
 
             }
         }
     }
 }
 
-/**
- * @addtogroup Nextion 
- * @{ 
- */
-
-
-/**
- * Init Nextion's baudrate,page id.    
- * 
- * @retval true - success. 
- * @retval false - failed. 
- */
-bool nexInit(void)
-{
-    bool ret1 = false;
-    bool ret2 = false;
-    
-    dbSerialBegin(9600);
-    nexSerial.begin(9600);
-    sendCommand("");
-    sendCommand("bkcmd=1");
-    ret1 = recvRetCommandFinished();
-    sendCommand("page 0");
-    ret2 = recvRetCommandFinished();
-    return ret1 && ret2;
-}
-
-/**
- * Call mainEventLoop,watting for Nextion's touch event.  
- *  
- * @param nex_listen_list - index to Nextion Components list. 
- * 
- */
-void nexLoop(NexTouch **nex_listen_list)
-{
-    mainEventLoop(nex_listen_list);
-}
-
-/**
- * @}
- */
-

NexHardware.h

@@ -18,12 +18,38 @@
 #include "NexConfig.h"
 #include "NexTouch.h"
 
+/**
+ * @addtogroup Nextion 
+ * @{ 
+ */
+
+/**
+ * Init Nextion.  
+ * 
+ * @return true if success, false for failure. 
+ */
+bool nexInit(void);
+
+/**
+ * Listen touch event and calling callbacks attached before.
+ * 
+ * Supports push and pop at present. 
+ *
+ * @param nex_listen_list - index to Nextion Components list. 
+ * @return none. 
+ *
+ * @warning This function must be called repeatedly to response touch events
+ *  from Nextion touch panel. Actually, you should place it in your loop function. 
+ */
+void nexLoop(NexTouch **nex_listen_list);
+
+/**
+ * @}
+ */
+
 bool recvRetNumber(uint32_t *number, uint32_t timeout = 100);
 uint16_t recvRetString(char *buffer, uint16_t len, uint32_t timeout = 100);
 void sendCommand(const char* cmd);
 bool recvRetCommandFinished(uint32_t timeout = 100);
 
-bool nexInit(void);
-void nexLoop(NexTouch **nex_listen_list);
-
 #endif /* #ifndef __NEXHARDWARE_H__ */

NexHotspot.h

@@ -27,6 +27,9 @@
 class NexHotspot: public NexTouch
 {
 public: /* methods */
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexHotspot(uint8_t pid, uint8_t cid, const char *name);
 };
 

NexPage.h

@@ -29,6 +29,9 @@
 class NexPage: public NexTouch
 {
 public: /* methods */
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexPage(uint8_t pid, uint8_t cid, const char *name);
     bool show(void);
 };

NexPicture.h

@@ -27,6 +27,9 @@
 class NexPicture: public NexTouch
 {
 public: /* methods */
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexPicture(uint8_t pid, uint8_t cid, const char *name);
 
     bool getPic(uint32_t *number);

NexProgressBar.h

@@ -27,6 +27,9 @@
 class NexProgressBar: public NexObject
 {
 public: /* methods */
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexProgressBar(uint8_t pid, uint8_t cid, const char *name);
 
     bool getValue(uint32_t *number);

NexSlider.h

@@ -27,6 +27,9 @@
 class NexSlider: public NexTouch
 {
 public: /* methods */
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexSlider(uint8_t pid, uint8_t cid, const char *name);
 
     bool getValue(uint32_t *number);

NexText.h

@@ -27,6 +27,9 @@
 class NexText: public NexTouch
 {
 public: /* methods */
+    /**
+     * @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
+     */
     NexText(uint8_t pid, uint8_t cid, const char *name);
 
     uint16_t getText(char *buffer, uint16_t len);    

NexTouch.cpp

@@ -15,60 +15,52 @@
 #include "NexTouch.h"
 
 
-/**
- * Constructor of Nextouch. 
- * 
- * @param pid - pid
- * @param cid - cid
- * @param name - name
- *   
- */
 NexTouch::NexTouch(uint8_t pid, uint8_t cid, const char *name)
     :NexObject(pid, cid, name)
 {
-    this->cbPush = NULL;
-    this->cbPop = NULL;
+    this->__cb_push = NULL;
+    this->__cb_pop = NULL;
     this->__cbpop_ptr = NULL;
     this->__cbpush_ptr = NULL;
 }
 
 void NexTouch::attachPush(NexTouchEventCb push, void *ptr)
 {
-    this->cbPush = push;
+    this->__cb_push = push;
     this->__cbpush_ptr = ptr;
 }
 
 void NexTouch::detachPush(void)
 {
-    this->cbPush = NULL;
+    this->__cb_push = NULL;
     this->__cbpush_ptr = NULL;
 }
 
 void NexTouch::attachPop(NexTouchEventCb pop, void *ptr)
 {
-    this->cbPop = pop;
+    this->__cb_pop = pop;
     this->__cbpop_ptr = ptr;
 }
 
 void NexTouch::detachPop(void)
 {
-    this->cbPop = NULL;    
+    this->__cb_pop = NULL;    
     this->__cbpop_ptr = NULL;
 }
 
 void NexTouch::push(void)
 {
-    if (cbPush)
+    if (__cb_push)
     {
-        cbPush(__cbpush_ptr);
+        __cb_push(__cbpush_ptr);
     }
 }
 
 void NexTouch::pop(void)
 {
-    if (cbPop)
+    if (__cb_pop)
     {
-        cbPop(__cbpop_ptr);
+        __cb_pop(__cbpop_ptr);
     }
 }