Revision 1:c2715acb7466, committed 2014-05-25

Comitter:

lelect

Date:

Sun May 25 13:40:59 2014 +0000

Parent:

0:3e9c32359703

Child:

2:66a3fe0dc83a

Commit message:

add doxygen

Changed in this revision

--- a/Adafruit_GFX.cpp	Fri May 23 15:05:48 2014 +0000
+++ b/Adafruit_GFX.cpp	Sun May 25 13:40:59 2014 +0000
@@ -1,41 +1,25 @@
 /*
-This is the core graphics library for all our displays, providing a common
-set of graphics primitives (points, lines, circles, etc.).  It needs to be
-paired with a hardware-specific library for each display device we carry
-(to handle the lower-level functions).
-
-Adafruit invests time and resources providing this open source code, please
-support Adafruit & open-source hardware by purchasing products from Adafruit!
-
-Copyright (c) 2013 Adafruit Industries.  All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+This is the core graphics library for all our displays,
+providing a common set of graphics primitives (points, lines, circles, etc.).
+It needs to be paired with a hardware-specific library for each display device we carry (to handle the lower-level functions).
 
-- Redistributions of source code must retain the above copyright notice,
-  this list of conditions and the following disclaimer.
-- Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
+Adafruit invests time and resources providing this open source code,
+please support Adafruit and open-source hardware by purchasing products from Adafruit!
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
+Written by Limor Fried/Ladyada for Adafruit Industries.
+BSD license, check license.txt for more information.
+All text above must be included in any redistribution.
+
 */
 
-#include "mbed.h"
+/*
+ *  Modified by Tatsuki Fukuda 25/5/2014 for use in mbed
+ */
+ 
+ #include "mbed.h"
 #include "Adafruit_GFX.h"
 #include "glcdfont.h"
 
-
 // Draw a circle outline
 void Adafruit_GFX::drawCircle(int16_t x0, int16_t y0, int16_t r,
                               uint16_t color)

--- a/Adafruit_GFX.h	Fri May 23 15:05:48 2014 +0000
+++ b/Adafruit_GFX.h	Sun May 25 13:40:59 2014 +0000
@@ -7,24 +7,27 @@
 #endif
 
 #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
+*/
 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)
-        , textsize(1)
-        , rotation(0)
-        , wrap(true)
-    {}; // Constructor
+        ,_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:
     virtual void drawPixel(int16_t x, int16_t y, uint16_t color) = 0;