Diff: RA8875.h

Revision:

76:c981284eb513

Parent:

75:ca78388cfd77

Child:

77:9206c13aa527

diff -r ca78388cfd77 -r c981284eb513 RA8875.h
--- a/RA8875.h	Fri Nov 28 22:37:53 2014 +0000
+++ b/RA8875.h	Fri Nov 28 22:53:35 2014 +0000
@@ -8,11 +8,11 @@
 
 // Define this to enable code that monitors the performance of various
 // graphics commands.
-#define PERF_METRICS
+//#define PERF_METRICS
 
 // What better place for some test code than in here and the companion
 // .cpp file. See also the bottom of this file.
-#define TESTENABLE
+//#define TESTENABLE
 
 /// DOS colors - slightly color enhanced
 #define Black       (color_t)(RGB(0,0,0))
@@ -398,13 +398,13 @@
     ///     the option for the keypad is configured on the hardware.
     ///
     /// All parameters are optional.
-    /// @param[in] scanEnable, when true, enables the key scan function (default: true).
-    /// @param[in] longDetect, when true, additionally enables the long key held detection (default: false).
+    /// @param[in] scanEnable when true, enables the key scan function (default: true).
+    /// @param[in] longDetect when true, additionally enables the long key held detection (default: false).
     /// @param[in] sampleTime setting (range: 0 - 3, default: 0).
     /// @param[in] scanFrequency setting (range: 0 - 7, default: 0).
     /// @param[in] longTimeAdjustment (range: 0 - 3, default: 0).
-    /// @param[in] interruptEnable, when true, enables interrupts from keypress (default: false).
-    /// @param[in] wakeupEnable, when true, activates the wakeup function (default: false).
+    /// @param[in] interruptEnable when true, enables interrupts from keypress (default: false).
+    /// @param[in] wakeupEnable when true, activates the wakeup function (default: false).
     ///
     /// @returns success/failure code. @see RetCode_t.
     ///
@@ -427,10 +427,10 @@
     /// //        Return Value by Row, Column   Example reassignment
     /// //    Column    0    1    2    3    4 
     /// //          +-------------------------+  +-------------------------+
-    /// // Row   0  |   1    2    3    4    5 |  | '7'  '8'  '9'  ' '  ' ' |
+    /// // Row   0  |   1    2    3    4    5 |  | '7'  '8'  '9'  ',' '<-' |
     /// //       1  |   6    7    8    9   10 |  | '4'  '5'  '6'  '/'  '-' |
     /// //       2  |  11   12   13   14   15 |  | '1'  '2'  '3'  '*'  '+' |
-    /// //       3  |  16   17   18   19   20 |  | '0'  '.'  ','  ' ' '\n' |
+    /// //       3  |  16   17   18   19   20 |  | '0'  '.'  '('  ')' '\n' |
     /// //          +-------------------------+  +-------------------------+
     /// //     Return value  0 = No Key pressed
     /// //     Return value 21 = Error
@@ -1307,7 +1307,10 @@
     /// @param[in] Hz is the frequency in Hz, tested range includes the
     ///     range from 1,000,000 (1MHz) to 10,000,000 (10 MHz). Values
     ///     outside this range will be accepted, but operation may
-    ///     be unreliable.
+    ///     be unreliable. This depends partially on your hardware design
+    ///     and the wires connecting the display module.
+    ///     The default value is 5,000,000, which should work for most
+    ///     applications as a starting point.
     /// @param[in] Hz2 is an optional parameter and will set the read
     ///     speed independently of the write speed.
     /// @returns success/failure code. @see RetCode_t.