Merge pull request #7 from aliphys/commentProperties

Clarify `paragraph` value and add header comments to `Touch_IRQ.ino` and `Touch_Polling.ino`

examples/Touch_IRQ/Touch_IRQ.ino

@@ -1,9 +1,21 @@
-/*
-  Touch_IRQ
-
-  created 03 May 2023
-  by Leonardo Cavagnis
-*/
+/* 
+ * Touch_IRQ.ino
+ * 
+ * This example shows how to get the number of points and the coordinates of the first touch points detected by the touch controller using interrupts.
+ * 
+ * The setup() function initializes the serial communication and the touch controller. Whenever a touch event is detcted, the gigaTouchHandler function is called that prints the number of points and first touch co-ordinates to the Serial Monitor. The loop() function is empty because the touch controller is configured to work with interrupts. 
+ * 
+ * For the polling version of this example, see Touch_Polling.ino
+ * 
+ * Instructions:
+ * 1. Connect your GIGA Display Shield (ASX00039) to a GIGA R1 WiFi (ABX00063) board .
+ * 2. Upload this sketch to your board.
+ * 3. Open the Serial Monitor.
+ * 4. Touch the screen with your finger(s) and view the coordinates printed on the Serial Monitor.
+ * 
+ * Initial author: Leonardo Cavagnis @leonardocavagnis
+ * Created: 03 May 2023
+ */
 
 #include "Arduino_GigaDisplayTouch.h"
 

examples/Touch_Polling/Touch_Polling.ino

@@ -1,9 +1,21 @@
-/*
-  Touch_Polling
-
-  created 03 May 2023
-  by Leonardo Cavagnis
-*/
+/* 
+ * Touch_Polling.ino
+ * 
+ * This example shows how to get the number of points and the coordinates of the first touch points detected by the touch controller using polling.
+ * 
+ * The setup() function initializes the serial communication and the touch controller. The loop() function continuously checks to see if a touch event is detected. Whenever a touch event is detcted, that prints the number of points and first touch co-ordinates to the Serial Monitor.
+ * 
+ * For the interrupt version of this example, see Touch_IRQ.ino
+ * 
+ * Instructions:
+ * 1. Connect your GIGA Display Shield (ASX00039) to a GIGA R1 WiFi (ABX00063) board .
+ * 2. Upload this sketch to your board.
+ * 3. Open the Serial Monitor.
+ * 4. Touch the screen with your finger(s) and view the coordinates printed on the Serial Monitor.
+ * 
+ * Initial author: Leonardo Cavagnis @leonardocavagnis
+ * Created: 03 May 2023
+ */
 
 #include "Arduino_GigaDisplayTouch.h"
 

library.properties

@@ -2,8 +2,8 @@ name=Arduino_GigaDisplayTouch
 version=1.0.1
 author=Arduino
 maintainer=Arduino <[email protected]>
-sentence=Touch library for Arduino Giga Display Shield
-paragraph=The Arduino Giga Display Touch library is a C++ library designed to manage the touch controller of the Giga Display Shield. It is currently compatible with Goodix GT911 5-point Capacitive touch controller. This library captures up to 5 concurrent touch points using two approaches: by interrupt or on-request.
+sentence=Touch library for Arduino GIGA Display Shield
+paragraph=Easily use the touch features of the Arduino GIGA Display Shield (ASX00039), provided via the Goodix GT911 5-point Capacitive touch controller. Capture up to 5 concurrent touch points using two approaches: by interrupt (IRQ) or on-request (polling).
 category=Sensors
 url=https://github.com/arduino-libraries/Arduino_GigaDisplayTouch
 architectures=mbed,mbed_portenta,mbed_giga