From 08dc249ecb302313e27d65b25948cc142f3a5e20 Mon Sep 17 00:00:00 2001
From: Rhys Weatherley <rhys.weatherley@gmail.com>
Date: Wed, 30 May 2012 13:39:46 +1000
Subject: [PATCH] Document the DMD demo

---
 doc/dmd-demo.dox | 42 ++++++++++++++++++++++++++++++++++++++++++
 doc/mainpage.dox |  1 +
 2 files changed, 43 insertions(+)
 create mode 100644 doc/dmd-demo.dox

diff --git a/doc/dmd-demo.dox b/doc/dmd-demo.dox
new file mode 100644
index 00000000..c5e8b315
--- /dev/null
+++ b/doc/dmd-demo.dox
@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2012 Southern Storm Software, Pty Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+\file dmd-demo.dox
+\page dmd_demo Dot Matrix Display Demo
+
+This demo shows off various features of drawing with the Bitmap class
+to a DMD display:
+
+\li Drawing circles, lines, and rectangles.
+\li Filling the screen with a bitmap-based brick pattern.
+\li Drawing bitmaps directly from program memory.
+\li Drawing text in various fonts.
+\li Scrolling text in a "marquee".
+
+\ref dmd_running_figure "RunningFigure" provides another example of
+drawing and animating bitmaps.
+
+The full source code for the demo follows:
+
+\include DMD/examples/Demo/Demo.pde
+*/
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 01d91ae5..645b6ff5 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -46,6 +46,7 @@ LCD shield.
 
 \li DMD class to manage the initialize of the display.
 \li Bitmap class to manage drawing to in-memory bitmaps and the DMD display.
+\li \ref dmd_demo "Demo" that shows off various bitmap drawing features.
 \li \ref dmd_running_figure "RunningFigure" example that demonstrates how
 to draw and animate bitmaps.