Update docs.

Signed-off-by: shennongmin <[email protected]>
scropion86 · Aug 14, 2015 · 7e1fbe1 · 7e1fbe1
1 parent 4ca5031
commit 7e1fbe1
Show file tree

Hide file tree

Showing 162 changed files with 1,909 additions and 1,153 deletions.
diff --git a/NexButton.h b/NexButton.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexButton component. 
@@ -54,6 +58,9 @@ class NexButton: public NexTouch
      */
     bool setText(const char *buffer);    
 };
+/**
+ * @}
+ */
 
 
 #endif /* #ifndef __NEXBUTTON_H__ */
diff --git a/NexConfig.h b/NexConfig.h
@@ -15,6 +15,11 @@
 #ifndef __NEXCONFIG_H__
 #define __NEXCONFIG_H__
 
+/**
+ * @addtogroup Configuration 
+ * @{ 
+ */
+
 /** 
  * Define DEBUG_SERIAL_ENABLE to enable debug serial. 
  * Comment it to disable debug serial. 
@@ -42,4 +47,8 @@
 #define dbSerialBegin(a)    do{}while(0)
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* #ifndef __NEXCONFIG_H__ */
diff --git a/NexCrop.h b/NexCrop.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexCrop component. 
@@ -53,5 +57,8 @@ class NexCrop: public NexTouch
     bool setPic(uint32_t number);
 };
 
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXCROP_H__ */
diff --git a/NexGauge.h b/NexGauge.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexGauge component.
@@ -52,5 +56,8 @@ class NexGauge: public NexObject
     bool setValue(uint32_t number);
 };
 
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXGAUGE_H__ */
diff --git a/NexHardware.h b/NexHardware.h
@@ -19,7 +19,7 @@
 #include "NexTouch.h"
 
 /**
- * @addtogroup Nextion 
+ * @addtogroup CoreAPI 
  * @{ 
  */
 

diff --git a/NexHotspot.h b/NexHotspot.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexHotspot component. 
@@ -31,6 +35,9 @@ class NexHotspot: public NexTouch
      */
     NexHotspot(uint8_t pid, uint8_t cid, const char *name);
 };
+/**
+ * @}
+ */
 
 
 #endif /* #ifndef __NEXHOTSPOT_H__ */
diff --git a/NexObject.h b/NexObject.h
@@ -17,6 +17,10 @@
 #define __NEXOBJECT_H__
 #include <Arduino.h>
 #include "NexConfig.h"
+/**
+ * @addtogroup CoreAPI 
+ * @{ 
+ */
 
 /**
  * Root class of all Nextion components. 
@@ -73,5 +77,8 @@ class NexObject
     uint8_t __cid; /* Component ID */
     const char *__name; /* An unique name */
 };
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXOBJECT_H__ */
diff --git a/NexPage.h b/NexPage.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * A special component , which can contain other components such as NexButton, 
@@ -39,5 +43,8 @@ class NexPage: public NexTouch
      */
     bool show(void);
 };
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXPAGE_H__ */
diff --git a/NexPicture.h b/NexPicture.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexPicture component. 
@@ -52,5 +56,8 @@ class NexPicture: public NexTouch
     bool setPic(uint32_t number);
 };
 
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXPICTURE_H__ */
diff --git a/NexProgressBar.h b/NexProgressBar.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexProgressBar component. 
@@ -52,5 +56,8 @@ class NexProgressBar: public NexObject
     bool setValue(uint32_t number);
 };
 
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXPROGRESSBAR_H__ */
diff --git a/NexSlider.h b/NexSlider.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexSlider component. 
@@ -51,6 +55,9 @@ class NexSlider: public NexTouch
      */
     bool setValue(uint32_t number);
 };
+/**
+ * @}
+ */
 
 
 #endif /* #ifndef __NEXSLIDER_H__ */
diff --git a/NexText.h b/NexText.h
@@ -19,6 +19,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexText component.
@@ -49,5 +53,8 @@ class NexText: public NexTouch
     bool setText(const char *buffer);    
 };
 
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXTEXT_H__ */
diff --git a/NexTouch.h b/NexTouch.h
@@ -21,6 +21,11 @@
 #include "NexConfig.h"
 #include "NexObject.h"
 
+/**
+ * @addtogroup TouchEvent 
+ * @{ 
+ */
+
 /**
  * Push touch event occuring when your finger or pen coming to Nextion touch pannel. 
  */
@@ -104,5 +109,8 @@ class NexTouch: public NexObject
     void *__cbpop_ptr;
 };
 
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXTOUCH_H__ */
diff --git a/NexWaveform.h b/NexWaveform.h
@@ -18,6 +18,10 @@
 
 #include "NexTouch.h"
 #include "NexHardware.h"
+/**
+ * @addtogroup Component 
+ * @{ 
+ */
 
 /**
  * NexWaveform component.
@@ -42,5 +46,8 @@ class NexWaveform: public NexObject
     bool addValue(uint8_t ch, uint8_t number);
 };
 
+/**
+ * @}
+ */
 
 #endif /* #ifndef __NEXWAVEFORM_H__ */
diff --git a/doc/UserManual/_comp_button_8ino-example.html b/doc/UserManual/_comp_button_8ino-example.html
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,7 +19,7 @@ @@
     #include "NexTouch.h"
     /**
-     * @addtogroup Nextion
+     * @addtogroup CoreAPI
      * @{
      */
@@ Expand Down @@