Diff: GraphicsDisplay.h

Revision:

167:8aa3fb2a5a31

Parent:

153:8a85efb3eb71

--- a/GraphicsDisplay.h	Sun Feb 24 19:28:26 2019 +0000
+++ b/GraphicsDisplay.h	Tue Feb 26 19:52:57 2019 +0000
@@ -1,16 +1,17 @@
-/* mbed GraphicsDisplay Display Library Base Class
- * Copyright (c) 2007-2009 sford
- * Released under the MIT License: http://mbed.org/license/mit
- *
- * A library for providing a common base class for Graphics displays
- * To port a new display, derive from this class and implement
- * the constructor (setup the display), pixel (put a pixel
- * at a location), width and height functions. Everything else
- * (locate, printf, putc, cls, window, putp, fill, blit, blitbit) 
- * will come for free. You can also provide a specialised implementation
- * of window and putp to speed up the results
- */
-
+/// @page GraphicDisplay_Copyright GraphicDisplay Library Base Class
+///
+/// mbed GraphicsDisplay Display Library Base Class
+/// @copyright © 2007-2009 sford
+/// Released under the MIT License: http://mbed.org/license/mit
+///
+/// A library for providing a common base class for Graphics displays
+/// To port a new display, derive from this class and implement
+/// the constructor (setup the display), pixel (put a pixel
+/// at a location), width and height functions. Everything else
+/// (locate, printf, putc, cls, window, putp, fill, blit, blitbit) 
+/// will come for free. You can also provide a specialised implementation
+/// of window and putp to speed up the results
+///
 #ifndef MBED_GRAPHICSDISPLAY_H
 #define MBED_GRAPHICSDISPLAY_H
 #include "Bitmap.h"
@@ -111,7 +112,7 @@
     /// the memory cursor.
     ///
     /// @param[in] p is the point representing the cursor position to set
-    /// @returns success/failure code. See @ref RetCode_t.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t SetGraphicsCursor(point_t p) = 0;
     
@@ -174,7 +175,7 @@
     /// @param[out] prevLayer is an optiona pointer to where the previous layer
     ///     will be written, making it a little easer to restore layers.
     ///     Writes 0 or 1 when the pointer is not NULL.
-    /// @returns success/failure code. See @ref RetCode_t.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t SelectDrawingLayer(uint16_t layer, uint16_t * prevLayer = NULL) = 0;
  
@@ -511,7 +512,7 @@
     ///     format.
     ///
     /// @param[in] font is a pointer to a specially formed font resource.
-    /// @returns error code.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t SelectUserFont(const uint8_t * font = NULL);
 
@@ -527,7 +528,7 @@
     ///
     /// @note this method must be supported in the derived class.
     ///
-    /// @returns error code.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t _StartGraphicsStream(void) = 0;
     
@@ -540,7 +541,7 @@
     ///
     /// @note this method must be supported in the derived class.
     ///
-    /// @returns error code.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t _EndGraphicsStream(void) = 0;
 
@@ -550,10 +551,10 @@
     /// @param[in] x is the horizontal pixel coordinate
     /// @param[in] y is the vertical pixel coordinate
     /// @param[in] fileOffset is the offset into the file where the image data starts
-    /// @param[in] Image is the filename stream already opened for the data.
+    /// @param[in] fh is the file handle to the stream already opened for the data.
     /// @returns success or error code.
     ///
-    RetCode_t _RenderBitmap(loc_t x, loc_t y, uint32_t fileOffset, FILE * Image);
+    RetCode_t _RenderBitmap(loc_t x, loc_t y, uint32_t fileOffset, FILE * fh);
 
 
     /// Protected method to render a GIF given a file handle and 
@@ -561,7 +562,7 @@
     ///
     /// @param[in] x is the horizontal pixel coordinate
     /// @param[in] y is the vertical pixel coordinate
-    /// @param[in] Image is the filename stream already opened for the data.
+    /// @param[in] fh is the file handle to the stream already opened for the data.
     /// @returns success or error code.
     ///
     RetCode_t _RenderGIF(loc_t x, loc_t y, FILE * fh);
@@ -654,7 +655,7 @@
     /// @param[in] h is the height of the rectangular region to fill.
     /// @param[in] boolStream is the inline memory image from which to extract
     ///         the bitstream.
-    /// @returns success/failure code. See @ref RetCode_t.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t booleanStream(loc_t x, loc_t y, dim_t w, dim_t h, const uint8_t * boolStream) = 0;