From: RichardBarry <RichardBarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Date: Tue, 3 Feb 2009 15:21:51 +0000 (+0000)
Subject: Add a little more commenting.
X-Git-Tag: V5.1.2~28
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=52236b7e2e31800ef4bc9c2cd4d654e794210469;p=freertos

Add a little more commenting.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@668 1d2547de-c912-0410-9cb9-b8ca96c0e9e2
---

diff --git a/Demo/MB96350_Softune_Dice_Kit/main.c b/Demo/MB96350_Softune_Dice_Kit/main.c
index adbffc37d..99aff2311 100644
--- a/Demo/MB96350_Softune_Dice_Kit/main.c
+++ b/Demo/MB96350_Softune_Dice_Kit/main.c
@@ -96,6 +96,18 @@
  *
  * The co-routines all execute within a single low priority task.
  *
+ *
+ *
+ * When this demo is executing as expected:
+ *
+ * + Every segment of both displays will toggle at a fixed frequency - with each
+ *   segment using a different frequency.
+ * + When a button is pushed the segment toggling will temporarily stop and the
+ *   dice 'throw' will start whereby the display will show a fast changing random
+ *   number for a few seconds before the dice value is chosen and displayed.
+ * + If the button is not pushed again within five seconds of the dice value being
+ *   displayed the segment toggling will commence again.
+ *
  *****/
 
 /* Kernel includes. */