Chris Womack / DMBasicGUI

Basic swim GUI for LPC4088

Fork of DMBasicGUI by Embedded Artists

Diff: SlideShow/Renderer.h

Revision:
14:647b1896ed84
Parent:
13:bff2288c2c61
Child:
15:a68bb30ab95e
--- a/SlideShow/Renderer.h	Mon Mar 09 10:40:55 2015 +0100
+++ b/SlideShow/Renderer.h	Mon Mar 09 10:50:17 2015 +0100
@@ -20,6 +20,15 @@
 #include "rtos.h"
 #include "Display.h"
 
+/**
+ * Renderer for the SlideShow engine.
+ *
+ * The renderer handles all (if more than one) running slideshows and
+ * the layer(s) they are drawn on.
+ *
+ * For information on how to use the SlideShow and some examples see
+ * https://developer.mbed.org/teams/Embedded-Artists/wiki/LPC4088DM-Using-the-SlideShow-Engine
+ */
 class Renderer {
 public: