diff --git a/NexGpio.h b/NexGpio.h index 6162d9d8..d67b2c89 100755 --- a/NexGpio.h +++ b/NexGpio.h @@ -1,13 +1,36 @@ +/** + * @file NexGpio.h + * + * The definition of class NexGpio. + * + * @author Wu Pengfei (email:) + * @date 2015/8/13 + * + * @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. + */ + #ifndef _NEXGPIO_H #define _NEXGPIO_H #include "NexTouch.h" #include "NexHardware.h" +/** + * @addtogroup Component + * @{ + */ +/** + * NexGpio component. + */ class NexGpio { - public: +public: /** * Set gpio mode * @@ -24,17 +47,17 @@ class NexGpio bool pin_mode(uint32_t port,uint32_t mode,uint32_t control_id); /** - * write a high or a LOW value to a digital pin + * write a HIGH or a LOW value to a digital pin * * @param port - the gpio port number - * @param mode - the gpio port number + * @param value - HIGH or LOW * @return true if success, false for failure */ bool digital_write(uint32_t port,uint32_t value); /** - * read a high or a LOW value to a digital pin + * read a HIGH or a LOW value to a digital pin * * @param port - the gpio port number * @return the value from a specified digital pin, either high or low @@ -69,14 +92,11 @@ class NexGpio */ uint32_t get_pwmfreq(uint32_t *number); - - /** - * write rtc times - * - * @param time - Time to write to the array - * @return true if success, false for failure - */ }; -#endif \ No newline at end of file +/** + * @} + */ + +#endif /* #ifndef __NEXGPIO_H__ */ \ No newline at end of file diff --git a/NexRtc.h b/NexRtc.h index e27545bc..815ed6de 100755 --- a/NexRtc.h +++ b/NexRtc.h @@ -1,9 +1,32 @@ +/** + * @file NexRtc.h + * + * The definition of class NexRtc. + * + * @author Wu Pengfei (email:) + * @date 2015/8/13 + * + * @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. + */ + #ifndef _NEXRTC_H #define _NEXRTC_H #include "NexTouch.h" #include "NexHardware.h" +/** + * @addtogroup Component + * @{ + */ +/** + * NexRtc component. + */ class NexRtc { @@ -35,7 +58,7 @@ class NexRtc * read rtc time * * @param time - Access data array - * @param time - len of array + * @param len - len of array * @return true if success, false for failure */ @@ -55,7 +78,7 @@ class NexRtc * read rtc time * * @param time - Access data array - * @param time - len of array + * @param len - len of array * @return true if success, false for failure */ @@ -63,4 +86,8 @@ class NexRtc }; -#endif \ No newline at end of file +/** + * @} + */ + +#endif /* #ifndef __NEXRTC_H__ */ \ No newline at end of file diff --git a/doc/Documentation/_comp_button_8ino-example.html b/doc/Documentation/_comp_button_8ino-example.html index 9be747d4..d4843653 100755 --- a/doc/Documentation/_comp_button_8ino-example.html +++ b/doc/Documentation/_comp_button_8ino-example.html @@ -152,7 +152,7 @@
-Generated on Mon Oct 10 2016 09:22:39 for My Project by   +Generated on Thu Dec 1 2016 09:26:03 for My Project by   doxygen 1.8.7
diff --git a/html/class_nex_picture.html b/html/class_nex_picture.html index 59f1ec4c..11b7f4ae 100755 --- a/html/class_nex_picture.html +++ b/html/class_nex_picture.html @@ -323,7 +323,7 @@

Member Function Documentation

-Generated on Mon Oct 10 2016 09:22:39 for My Project by   +Generated on Thu Dec 1 2016 09:26:03 for My Project by   doxygen 1.8.7
diff --git a/html/class_nex_progress_bar-members.html b/html/class_nex_progress_bar-members.html index 74b02002..607dab9c 100755 --- a/html/class_nex_progress_bar-members.html +++ b/html/class_nex_progress_bar-members.html @@ -90,8 +90,8 @@

This is the complete list of members for NexProgressBar, including all inherited members.

- - + + @@ -99,13 +99,13 @@ - - + +
Get_background_color_bco(uint32_t *number) (defined in NexProgressBar)NexProgressBar
Get_font_color_pco(uint32_t *number) (defined in NexProgressBar)NexProgressBar
Get_background_color_bco(uint32_t *number)NexProgressBar
Get_font_color_pco(uint32_t *number)NexProgressBar
getObjCid(void) (defined in NexObject)NexObjectprotected
getObjName(void) (defined in NexObject)NexObjectprotected
getObjPid(void) (defined in NexObject)NexObjectprotected
NexObject(uint8_t pid, uint8_t cid, const char *name)NexObject
NexProgressBar(uint8_t pid, uint8_t cid, const char *name)NexProgressBar
printObjInfo(void)NexObject
Set_background_color_bco(uint32_t number) (defined in NexProgressBar)NexProgressBar
Set_font_color_pco(uint32_t number) (defined in NexProgressBar)NexProgressBar
Set_background_color_bco(uint32_t number)NexProgressBar
Set_font_color_pco(uint32_t number)NexProgressBar
setValue(uint32_t number)NexProgressBar
-Generated on Mon Oct 10 2016 09:22:39 for My Project by   +Generated on Thu Dec 1 2016 09:26:03 for My Project by   doxygen 1.8.7
diff --git a/html/class_nex_progress_bar.html b/html/class_nex_progress_bar.html index 95c7605a..b68b1e77 100755 --- a/html/class_nex_progress_bar.html +++ b/html/class_nex_progress_bar.html @@ -110,17 +110,13 @@   bool setValue (uint32_t number)   - -uint32_t Get_background_color_bco (uint32_t *number) +uint32_t Get_background_color_bco (uint32_t *number)   - -bool Set_background_color_bco (uint32_t number) +bool Set_background_color_bco (uint32_t number)   - -uint32_t Get_font_color_pco (uint32_t *number) +uint32_t Get_font_color_pco (uint32_t *number)   - -bool Set_font_color_pco (uint32_t number) +bool Set_font_color_pco (uint32_t number)   - Public Member Functions inherited from NexObject  NexObject (uint8_t pid, uint8_t cid, const char *name) @@ -188,6 +184,54 @@

Member Function Documentation

+ +
+
+ + + + + + + + +
uint32_t NexProgressBar::Get_background_color_bco (uint32_t * number)
+
+

Get bco attribute of component

+
Parameters
+ + +
number- buffer storing data retur
+
+
+
Returns
the length of the data
+ +
+
+ +
+
+ + + + + + + + +
uint32_t NexProgressBar::Get_font_color_pco (uint32_t * number)
+
+

Get pco attribute of component

+
Parameters
+ + +
number- buffer storing data retur
+
+
+
Returns
the length of the data
+ +
+
@@ -216,6 +260,54 @@

Member Function Documentation

+
+
+ +
+
+ + + + + + + + +
bool NexProgressBar::Set_background_color_bco (uint32_t number)
+
+

Set bco attribute of component

+
Parameters
+ + +
number- To set up the data
+
+
+
Returns
true if success, false for failure
+ +
+
+ +
+
+ + + + + + + + +
bool NexProgressBar::Set_font_color_pco (uint32_t number)
+
+

Set pco attribute of component

+
Parameters
+ + +
number- To set up the data
+
+
+
Returns
true if success, false for failure
+
@@ -255,7 +347,7 @@

Member Function Documentation

-Generated on Mon Oct 10 2016 09:22:39 for My Project by   +Generated on Thu Dec 1 2016 09:26:03 for My Project by   doxygen 1.8.7
diff --git a/html/class_nex_radio-members.html b/html/class_nex_radio-members.html index 48ed3b02..5ecbdd26 100755 --- a/html/class_nex_radio-members.html +++ b/html/class_nex_radio-members.html @@ -94,24 +94,24 @@ attachPush(NexTouchEventCb push, void *ptr=NULL)NexTouch detachPop(void)NexTouch detachPush(void)NexTouch - Get_background_color_bco(uint32_t *number) (defined in NexRadio)NexRadio - Get_font_color_pco(uint32_t *number) (defined in NexRadio)NexRadio + Get_background_color_bco(uint32_t *number)NexRadio + Get_font_color_pco(uint32_t *number)NexRadio getObjCid(void) (defined in NexObject)NexObjectprotected getObjName(void) (defined in NexObject)NexObjectprotected getObjPid(void) (defined in NexObject)NexObjectprotected - getValue(uint32_t *number) (defined in NexRadio)NexRadio + getValue(uint32_t *number)NexRadio iterate(NexTouch **list, uint8_t pid, uint8_t cid, int32_t event) (defined in NexTouch)NexTouchstatic NexObject(uint8_t pid, uint8_t cid, const char *name)NexObject NexRadio(uint8_t pid, uint8_t cid, const char *name)NexRadio NexTouch(uint8_t pid, uint8_t cid, const char *name)NexTouch printObjInfo(void)NexObject - Set_background_color_bco(uint32_t number) (defined in NexRadio)NexRadio - Set_font_color_pco(uint32_t number) (defined in NexRadio)NexRadio - setValue(uint32_t number) (defined in NexRadio)NexRadio + Set_background_color_bco(uint32_t number)NexRadio + Set_font_color_pco(uint32_t number)NexRadio + setValue(uint32_t number)NexRadio
-Generated on Mon Oct 10 2016 09:22:39 for My Project by   +Generated on Thu Dec 1 2016 09:26:03 for My Project by   doxygen 1.8.7
diff --git a/html/class_nex_radio.html b/html/class_nex_radio.html index 00286004..f53e1fae 100755 --- a/html/class_nex_radio.html +++ b/html/class_nex_radio.html @@ -107,23 +107,17 @@ Public Member Functions  NexRadio (uint8_t pid, uint8_t cid, const char *name)   - -uint32_t getValue (uint32_t *number) +uint32_t getValue (uint32_t *number)   - -bool setValue (uint32_t number) +bool setValue (uint32_t number)   - -uint32_t Get_background_color_bco (uint32_t *number) +uint32_t Get_background_color_bco (uint32_t *number)   - -bool Set_background_color_bco (uint32_t number) +bool Set_background_color_bco (uint32_t number)   - -uint32_t Get_font_color_pco (uint32_t *number) +uint32_t Get_font_color_pco (uint32_t *number)   - -bool Set_font_color_pco (uint32_t number) +bool Set_font_color_pco (uint32_t number)   - Public Member Functions inherited from NexTouch  NexTouch (uint8_t pid, uint8_t cid, const char *name) @@ -205,6 +199,151 @@ + + +

Member Function Documentation

+ +
+
+ + + + + + + + +
uint32_t NexRadio::Get_background_color_bco (uint32_t * number)
+
+

Get bco attribute of component

+
Parameters
+ + +
number- buffer storing data retur
+
+
+
Returns
the length of the data
+ +
+
+ +
+
+ + + + + + + + +
uint32_t NexRadio::Get_font_color_pco (uint32_t * number)
+
+

Get pco attribute of component

+
Parameters
+ + +
number- buffer storing data retur
+
+
+
Returns
the length of the data
+ +
+
+ +
+
+ + + + + + + + +
uint32_t NexRadio::getValue (uint32_t * number)
+
+

Get val attribute of component

+
Parameters
+ + +
number- buffer storing data retur
+
+
+
Returns
the length of the data
+ +
+
+ +
+
+ + + + + + + + +
bool NexRadio::Set_background_color_bco (uint32_t number)
+
+

Set bco attribute of component

+
Parameters
+ + +
number- To set up the data
+
+
+
Returns
true if success, false for failure
+ +
+
+ +
+
+ + + + + + + + +
bool NexRadio::Set_font_color_pco (uint32_t number)
+
+

Set pco attribute of component

+
Parameters
+ + +
number- To set up the data
+
+
+
Returns
true if success, false for failure
+ +
+
+ +
+
+ + + + + + + + +
bool NexRadio::setValue (uint32_t number)
+
+

Set val attribute of component

+
Parameters
+ + +
number- To set up the data
+
+
+
Returns
true if success, false for failure
+
The documentation for this class was generated from the following files: