Document member variables in Adafruit_GFX_Button

adafruit · Jan 14, 2024 · 9053899 · 9053899
1 parent 63c4efe
commit 9053899
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/Adafruit_GFX.h b/Adafruit_GFX.h
@@ -296,12 +296,14 @@ class Adafruit_GFX_Button {
 
 protected:
   Adafruit_GFX *_gfx;
-  int16_t _x1, _y1; // Coordinates of top-left corner
-  uint16_t _w, _h;
-  uint8_t _textsize_x;
-  uint8_t _textsize_y;
-  uint16_t _outlinecolor, _fillcolor, _textcolor;
-  char _label[10];
+  int16_t _x1, _y1;       ///< Coordinates of top-left corner
+  uint16_t _w, _h;        ///< width and heaight of button
+  uint8_t _textsize_x;    ///< width of text character in pixels
+  uint8_t _textsize_y;    ///< height of text character in pixels
+  uint16_t _outlinecolor; ///< button outline color
+  _fillcolor;             ///< button fill color
+  _textcolor;             ///< text color
+  char _label[10];        ///< text label on button
 
   bool currstate, laststate;
 };