Revision 2:66a3fe0dc83a, committed 2014-05-26

Comitter:

lelect

Date:

Mon May 26 09:14:33 2014 +0000

Parent:

1:c2715acb7466

Child:

3:3ffdf181555c

Commit message:

update doxygen

Changed in this revision

--- a/Adafruit_GFX.h	Sun May 25 13:40:59 2014 +0000
+++ b/Adafruit_GFX.h	Mon May 26 09:14:33 2014 +0000
@@ -8,28 +8,29 @@
 
 #define swap(a, b) { int16_t t = a; a = b; b = t; }
 /** Adafruit_GFX class
-*   @bref   This is the Adafruit_GFX class.\\
-*           drawPixel(int16_t x,int16_t y,uint16_t color) needing implementation in derived implementation class
+*   This is the Adafruit_GFX class.\n
+*   drawPixel(int16_t x,int16_t y,uint16_t color) needing implementation in derived implementation class
 */
 class Adafruit_GFX : public Stream
 {
 
 public:
     Adafruit_GFX(int16_t w, int16_t h)
-        : _rawWidth(w)
-        ,_rawHeight(h)
-        ,_width(w)
-        ,_height(h)
-        ,cursor_x(0)
-        ,cursor_y(0)
-        ,textcolor(WHITE)
-        ,textbgcolor(BLACK)
+        : _rawWidth(w),_rawHeight(h)
+        ,_width(w),_height(h)
+        ,cursor_x(0),cursor_y(0)
+        ,textcolor(WHITE),textbgcolor(BLACK)
         ,textsize(1)
         ,rotation(0)
         ,wrap(true)
-    {}; 
+    {};
 
-    // This MUST be defined by the subclass:
+    /** @fn void RGBmatrixPanel::drawPixel(int16_t x, int16_t y, uint16_t color) = 0
+    *   @bref This MUST be defined by the subclass!
+    *   @param x x
+    *   @param y y
+    *   @param color 16bit color
+    */
     virtual void drawPixel(int16_t x, int16_t y, uint16_t color) = 0;
 
     virtual int _putc(int value) {
@@ -38,11 +39,14 @@
     virtual int _getc() {
         return -1;
     };
-
+    /** @fn void RGBmatrixPanel::invertDisplay(bool i)
+    *   @bref Do nothing, must be subclassed if supported
+    *   @param i invert
+    */
     virtual void invertDisplay(bool i);
 
-    // These MAY be overridden by the subclass to provide device-specific
-    // optimized code.  Otherwise 'generic' versions are used.
+// These MAY be overridden by the subclass to provide device-specific
+// optimized code.  Otherwise 'generic' versions are used.
     virtual void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
     virtual void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
     virtual void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
@@ -50,27 +54,83 @@
     virtual void fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
     virtual void fillScreen(uint16_t color);
 
-    // These exist only with Adafruit_GFX (no subclass overrides)
+//These exist only with Adafruit_GFX (no subclass overrides)
+    /** @fn void RGBmatrixPanel::drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color)
+    *   @bref draw a circle outline from the coordinates of the center.
+    *   @param x0 x position
+    *   @param y0 y position
+    *   @param r Radius of the circle
+    *   @param color 16bit color
+    */
     void drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
     void drawCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername, uint16_t color);
+    /** @fn void RGBmatrixPanel::fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color)
+    *   @bref draw a circle from the coordinates of the center.
+    *   @param x0 x position
+    *   @param y0 y position
+    *   @param r Radius of the circle
+    *   @param color 16bit color
+    */
     void fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
     void fillCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername, int16_t delta, uint16_t color);
 
+    /** @fn void RGBmatrixPanel::drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color)
+    *   @bref draw a triangle outline from the vertex with color.
+    *   @param x0 first vertex x
+    *   @param y0 first vertex y
+    *   @param x1 second vertex x
+    *   @param y1 second vertex y
+    *   @param x2 third vertex x
+    *   @param y2 third vertex y
+    *   @param color 16bit color
+    */
     void drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
+    /** @fn void RGBmatrixPanel::fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color)
+    *   @bref draw a triangle from the vertex with color.
+    *   @param x0 first vertex x
+    *   @param y0 first vertex y
+    *   @param x1 second vertex x
+    *   @param y1 second vertex y
+    *   @param x2 third vertex x
+    *   @param y2 third vertex y
+    *   @param color 16bit color
+    */
     void fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
+
+    /** @fn void RGBmatrixPanel::drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color)
+    *   @bref draw a round rectangle outline with color.
+    *   @param x0 first vertex x
+    *   @param y0 first vertex y
+    *   @param w width
+    *   @param h height
+    *   @param radius radius
+    *   @param color 16bit color
+    */
     void drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
+    /** @fn void RGBmatrixPanel::drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color)
+    *   @bref draw a round rectangle with color.
+    *   @param x0 first vertex x
+    *   @param y0 first vertex y
+    *   @param w width
+    *   @param h height
+    *   @param radius radius
+    *   @param color 16bit color
+    */
     void fillRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
 
     void drawBitmap(int16_t x, int16_t y, const uint8_t *bitmap, int16_t w, int16_t h, uint16_t color);
+
     void drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size);
 
     void setCursor(int16_t x, int16_t y) {
         cursor_x = x;
         cursor_y = y;
     };
+
     void setTextSize(uint8_t s) {
         textsize = (s > 0) ? s : 1;
     };
+
     void setTextColor(uint16_t c) {
         textcolor = c;
         textbgcolor = c;
@@ -88,11 +148,12 @@
     int16_t height(void) {
         return _height;
     };
+
     int16_t width(void) {
         return _width;
     };
+    void setRotation(uint8_t r);
 
-    void setRotation(uint8_t r);
     uint8_t getRotation(void) {
         rotation%=4;
         return rotation;