Diff: GraphicsDisplay.h

Revision:

122:79e431f98fa9

Parent:

115:c9862fd0c689

Child:

125:7a0b70f56550

--- a/GraphicsDisplay.h	Tue May 17 22:05:43 2016 +0000
+++ b/GraphicsDisplay.h	Tue May 17 22:33:06 2016 +0000
@@ -13,7 +13,6 @@
 
 #ifndef MBED_GRAPHICSDISPLAY_H
 #define MBED_GRAPHICSDISPLAY_H
-
 #include "Bitmap.h"
 #include "TextDisplay.h"
 #include "GraphicsDisplayJPEG.h"
@@ -433,14 +432,25 @@
     RetCode_t _RenderBitmap(loc_t x, loc_t y, uint32_t fileOffset, FILE * Image);
 
 private:
+
+    /// Analyze the jpeg data in preparation for decompression.
+    ///
     JRESULT jd_prepare(JDEC * jd, uint16_t(* infunc)(JDEC * jd, uint8_t * buffer, uint16_t bufsize), void * pool, uint16_t poolsize, void * filehandle);
     
+    /// Decompress the jpeg and render it.
+    ///
     JRESULT jd_decomp(JDEC * jd, uint16_t(* outfunct)(JDEC * jd, void * stream, JRECT * rect), uint8_t scale);
 
+    /// helper function to read data from the file system
+    ///
     uint16_t privInFunc(JDEC * jd, uint8_t * buff, uint16_t ndata);
 
+    /// helper function to read data from the file system
+    ///
     uint16_t getJpegData(JDEC * jd, uint8_t *buff, uint16_t ndata);
 
+    /// helper function to write data to the display
+    ///
     uint16_t privOutFunc(JDEC * jd, void * bitmap, JRECT * rect);
     
     JRESULT mcu_output (
@@ -471,6 +481,7 @@
         JDEC * jd        /* Pointer to the decompressor object */
     );
 
+
 protected:
     /// Pure virtual method to write a boolean stream to the display.
     ///