Display Comment

ESPMegaPRO-firmware/lib/ESPMegaPRO/InternalDisplay.hpp

@@ -65,6 +65,19 @@
 #define TOUCH_TYPE_PRESS 0x01
 #define TOUCH_TYPE_RELEASE 0x0
 
+/**
+ * @brief The internal display of the ESPMegaPRO
+ * 
+ * This is the display that is installed on some ESPMegaPRO Chassis. It is a 3.5" TFT LCD with a resistive touch screen.
+ * 
+ * You can use this display to monitor the status of the ESPMegaPRO and also to control the various components of the
+ * ESPMegaPRO. 
+ * 
+ * If you are using a custom display, you need to create a class that inherits from ESPMegaDisplay and implement the
+ * methods in that class, you may refer to this class for reference.
+ * 
+ * @note This class is automatically instantiated by the ESPMegaPRO and can be accessed via the `display` variable.
+ */
 class InternalDisplay : public ESPMegaDisplay {
     public:
         InternalDisplay(HardwareSerial *displayAdapter);