Skip to content

Commit 0b16eaa

Browse files
add comments for struct
1 parent da29eb0 commit 0b16eaa

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/Arduino_GigaDisplayTouch.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ typedef struct GDTpoint_s GDTpoint_t;
4747
/* Exported enumeration ------------------------------------------------------*/
4848

4949
/* Exported struct -----------------------------------------------------------*/
50+
51+
/**
52+
* @brief Struct representing a touch point.
53+
*/
5054
struct GDTpoint_s {
5155
// 0x814F-0x8156, ... 0x8176 (5 points)
5256
uint8_t trackId;
@@ -94,7 +98,7 @@ class Arduino_GigaDisplayTouch {
9498
/**
9599
* @brief Initialize the touch controller.
96100
*
97-
* @return true If the controller is correctly configured
101+
* @return true If the touch controller is successfully initialized
98102
* @return false Otherwise
99103
*/
100104
bool begin();

0 commit comments

Comments
 (0)