Mirrors/ITEADLIB_Arduino_Nextion
2
0
Fork 0
mirror of https://github.com/itead/ITEADLIB_Arduino_Nextion.git synced 2026-03-09 19:46:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update doc of file comments.

Browse Source 
Signed-off-by: shennongmin <wupangfee@gmail.com>
This commit is contained in:
shennongmin
2015-08-14 11:55:47 +08:00
parent 050b9abfda
commit 98850de2cf
28 changed files with 110 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
NexButton.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexButton.cpp
*
* API of NexButton.
* The implementation of class NexButton.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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

11
NexButton.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexButton.h
*
* API of NexButton.
* The definition of class NexButton.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXBUTTON_H__
#define __NEXBUTTON_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -32,5 +33,5 @@ public: /* methods */
bool setText(const char *buffer);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXBUTTON_H__ */

19
NexSerialConfig.h → NexConfig.h
View File

@@ -1,10 +1,10 @@
/**
* @file NexSerialConfig.h
* @file NexConfig.h
*
* Serial configure.
* Options for user can be found here.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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
@@ -12,9 +12,8 @@
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#ifndef __NexSerialConfig_H__
#define __NexSerialConfig_H__
#ifndef __NEXCONFIG_H__
#define __NEXCONFIG_H__
/* enable debug serial */
#define DEBUG_SERIAL_ENABLE
@@ -30,9 +29,9 @@
#define dbSerialPrintln(a) dbSerial.println(a)
#define dbSerialBegin(a) dbSerial.begin(a)
#else
#define dbSerialPrint(a)
#define dbSerialPrintln(a)
#define dbSerialBegin(a)
#define dbSerialPrint(a) do{}while(0)
#define dbSerialPrintln(a) do{}while(0)
#define dbSerialBegin(a) do{}while(0)
#endif
#endif
#endif /* #ifndef __NEXCONFIG_H__ */

4
NexCrop.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexCrop.cpp
*
* API of NexCrop.
* The implementation of class NexCrop.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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

11
NexCrop.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexCrop.h
*
* API of NexCrop.
* The definition of class NexCrop.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXCROP_H__
#define __NEXCROP_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -32,5 +33,5 @@ public: /* methods */
bool setPic(uint32_t number);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXCROP_H__ */

4
NexGauge.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexGauge.cpp
*
* API of NexGauge.
* The implementation of class NexGauge.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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

11
NexGauge.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexGauge.h
*
* API of NexGauge.
* The definition of class NexGauge.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXGAUGE_H__
#define __NEXGAUGE_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -32,5 +33,5 @@ public: /* methods */
bool setValue(uint32_t number);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXGAUGE_H__ */

2
NexHardware.cpp
View File

@@ -1,7 +1,7 @@
/**
* @file NexHardware.cpp
*
* Hardware Srial API.
* The implementation of base API for using Nextion.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/11

4
NexHardware.h
View File

@@ -1,7 +1,7 @@
/**
* @file NexHardware.h
*
* Hardware Srial API.
* The definition of base API for using Nextion.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/11
@@ -15,7 +15,7 @@
#ifndef __NEXHARDWARE_H__
#define __NEXHARDWARE_H__
#include <Arduino.h>
#include "NexSerialConfig.h"
#include "NexConfig.h"
#include "NexTouch.h"
bool recvRetNumber(uint32_t *number, uint32_t timeout = 100);

4
NexHotspot.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexHotspot.cpp
*
* API of NexHotspot.
* The implementation of class NexHotspot.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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

11
NexHotspot.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexHotspot.h
*
* API of NexHotspot.
* The definition of class NexHotspot.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXHOTSPOT_H__
#define __NEXHOTSPOT_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -29,5 +30,5 @@ public: /* methods */
NexHotspot(NexPid pid, NexCid cid, const char *name);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXHOTSPOT_H__ */

3
NexObject.cpp
View File

@@ -1,7 +1,7 @@
/**
* @file NexObject.cpp
*
* The root of all classes in Nextion library.
* The implementation of class NexObject.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
@@ -12,7 +12,6 @@
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#include "NexObject.h"
/**

12
NexObject.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexObject.h
*
* The root of all classes in Nextion library.
* The definition of class NexObject.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @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
@@ -12,12 +13,10 @@
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#ifndef __NEXOBJECT_H__
#define __NEXOBJECT_H__
#ifdef __cplusplus
#include <Arduino.h>
#include "NexSerialConfig.h"
#include "NexConfig.h"
typedef uint8_t NexPid;
typedef uint8_t NexCid;
@@ -41,5 +40,4 @@ private: /* data */
const char *name; /* An unique name */
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXOBJECT_H__ */

4
NexPage.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexPage.cpp
*
* API of NexPage.
* The implementation of class NexPage.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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

11
NexPage.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexPage.h
*
* API of NexPage.
* The definition of class NexPage.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXPAGE_H__
#define __NEXPAGE_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -30,5 +31,5 @@ public: /* methods */
bool show(void);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXPAGE_H__ */

4
NexPicture.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexPicture.cpp
*
* API of NexPicture.
* The implementation of class NexPicture.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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

11
NexPicture.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexPicture.h
*
* API of NexPicture.
* The definition of class NexPicture.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXPICTURE_H__
#define __NEXPICTURE_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -32,5 +33,5 @@ public: /* methods */
bool setPic(uint32_t number);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXPICTURE_H__ */

4
NexProgressBar.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexProgressBar.cpp
*
* API of NexProgressBar.
* The implementation of class NexProgressBar.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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

11
NexProgressBar.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexProgressBar.h
*
* API of NexProgressBar.
* The definition of class NexProgressBar.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXPROGRESSBAR_H__
#define __NEXPROGRESSBAR_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -32,5 +33,5 @@ public: /* methods */
bool setValue(uint32_t number);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXPROGRESSBAR_H__ */

5
NexSlider.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexSlider.cpp
*
* API of NexSlider.
* The implementation of class NexSlider.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/11
* @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
@@ -12,7 +12,6 @@
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#include "NexSlider.h"
/**

11
NexSlider.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexSlider.h
*
* API of NexSlider.
* The definition of class NexSlider.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXSLIDER_H__
#define __NEXSLIDER_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -32,5 +33,5 @@ public: /* methods */
bool setValue(uint32_t number);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXSLIDER_H__ */

5
NexText.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexText.cpp
*
* API of NexText.
* The implementation of class NexText.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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
@@ -12,7 +12,6 @@
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#include "NexText.h"
/**

11
NexText.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexText.h
*
* API of NexText.
* The definition of class NexText.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,7 +16,7 @@
#ifndef __NEXTEXT_H__
#define __NEXTEXT_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -32,5 +33,5 @@ public: /* methods */
bool setText(const char *buffer);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXTEXT_H__ */

5
NexTouch.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexTouch.cpp
*
* API of Nextion.
* The implementation of class NexTouch.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/7/10
* @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
@@ -12,7 +12,6 @@
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#include "NexTouch.h"

13
NexTouch.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexTouch.h
*
* API of Nextion.
* The definition of class NexTouch.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @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
@@ -15,9 +16,9 @@
#ifndef __NEXTOUCH_H__
#define __NEXTOUCH_H__
#ifdef __cplusplus
#include <Arduino.h>
#include "NexSerialConfig.h"
#include "NexConfig.h"
#include "NexObject.h"
typedef void (*NexTouchEventCb)(void *ptr);
@@ -56,5 +57,5 @@ private: /* data */
void *__cbpop_ptr;
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXTOUCH_H__ */

5
NexWaveform.cpp
View File

@@ -1,10 +1,10 @@
/**
* @file NexWaveform.cpp
*
* API of NexWaveform.
* The implementation of class NexWaveform.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/11
* @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
@@ -12,7 +12,6 @@
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#include "NexWaveform.h"
/**

11
NexWaveform.h
View File

@@ -1,10 +1,11 @@
/**
* @file NexWaveform.h
*
* API of NexWaveform.
* The definition of class NexWaveform.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/11
* @copyright
* Copyright (C) 2014-2015 ITEAD Intelligent Systems Co., Ltd. \n
* This program is free software; you can redistribute it and/or
@@ -14,7 +15,7 @@
*/
#ifndef __NEXWAVEFORM_H__
#define __NEXWAVEFORM_H__
#ifdef __cplusplus
#include "NexTouch.h"
#include "NexHardware.h"
@@ -29,5 +30,5 @@ public: /* methods */
bool addValue(uint8_t ch, uint8_t number);
};
#endif /* #ifdef __cplusplus */
#endif /* #ifndef __NEXWAVEFORM_H__ */

7
Nextion.h
View File

@@ -1,9 +1,9 @@
/**
* @file Nextion.h
*
* Header file of Nextion Library.
* The header file including all other header files provided by this library.
*
* All examples or sketches need to include this file.
* Every example sketch should include this file.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/12
@@ -14,12 +14,11 @@
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#ifndef __NEXTION_H__
#define __NEXTION_H__
#include "Arduino.h"
#include "NexSerialConfig.h"
#include "NexConfig.h"
#include "NexTouch.h"
#include "NexHardware.h"