add note to all files

2026-03-03 08:44:00 +01:00 · 2015-07-16 10:11:58 +08:00
parent 8405fec682
commit eaad704b5d
27 changed files with 2049 additions and 1405 deletions
--- a/NexText.cpp
+++ b/NexText.cpp
@@ -1,39 +1,83 @@
-#include "NexText.h"
-
-
-NexText::NexText(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop, void *pop_ptr)
-    :NexTouch(pid, cid, name, pop, pop_ptr)
-{
-}
-
-uint16_t NexText::getText(char *buffer, uint16_t len)
-{
-    String cmd;
-    cmd += "get ";
-    cmd += getObjName();
-    cmd += ".txt";
-    sendCommand(cmd.c_str());
-    return recvRetString(buffer,len);
-}
-
-bool NexText::setText(const char *buffer)
-{
-    String cmd;
-    cmd += getObjName();
-    cmd += ".txt=\"";
-    cmd += buffer;
-    cmd += "\"";
-    sendCommand(cmd.c_str());
-    return recvRetCommandFinished();    
-}
-
-void NexText::attachPop(NexTouchEventCb pop, void *ptr)
-{
-    NexTouch::attachPop(pop, ptr);
-}
-
-void NexText::detachPop(void)
-{
-    NexTouch::detachPop();   
-}
- 
+/**
+ * @file NexText.cpp
+ *
+ * API of NexText. 
+ *
+ * @author  Wu Pengfei (email:<pengfei.wu@itead.cc>)
+ * @date    2015/7/10
+ * @copyright 
+ * Copyright (C) 2014-2015 ITEAD Intelligent Systems Co., Ltd. \n
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ */
+
+#include "NexText.h"
+
+/**
+ * Constructor,inherited NexTouch's constructor function.
+ *
+ */
+NexText::NexText(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop, void *pop_ptr)
+    :NexTouch(pid, cid, name, pop, pop_ptr)
+{
+}
+
+/**
+ * Get the value of text.
+ *
+ * @param buffer - text value buffer. 
+ * @param len - the length of text value buffer.
+ *
+ * @return the the length of text value buffer.
+ */
+uint16_t NexText::getText(char *buffer, uint16_t len)
+{
+    String cmd;
+    cmd += "get ";
+    cmd += getObjName();
+    cmd += ".txt";
+    sendCommand(cmd.c_str());
+    return recvRetString(buffer,len);
+}
+
+/**
+ * Set the value of text.
+ *
+ * @param buffer - text value buffer. 
+ *
+ * @retval true - success.
+ * @retval false - failed. 
+ */
+bool NexText::setText(const char *buffer)
+{
+    String cmd;
+    cmd += getObjName();
+    cmd += ".txt=\"";
+    cmd += buffer;
+    cmd += "\"";
+    sendCommand(cmd.c_str());
+    return recvRetCommandFinished();    
+}
+
+/**
+ * Register text pop callback function. 
+ *
+ * @param pop - the pointer to text pop callback function.
+ * @param ptr - the parameter to be transmitted to text pop callback function. 
+ */
+void NexText::attachPop(NexTouchEventCb pop, void *ptr)
+{
+    NexTouch::attachPop(pop, ptr);
+}
+
+/**
+ * Unload text pop callback function.
+ *
+ */
+void NexText::detachPop(void)
+{
+    NexTouch::detachPop();   
+}
+