Diff: RA8875.h

Revision:

132:a5d7a8541683

Parent:

131:5bd6ba2ee4a1

Child:

133:e36dcfc2d756

--- a/RA8875.h	Fri Aug 12 11:30:33 2016 +0000
+++ b/RA8875.h	Sun Sep 04 16:54:34 2016 +0000
@@ -495,10 +495,12 @@
     
     /// Initialize the driver.
     ///
-    /// The RA8875 can scale to 800x600, and it supports 8 or 16-bit color. It also supports
-    /// layers, but it cannot support layers at the maximum color and screen size. When configured
-    /// under 800x600, it will support both 16-bit and 2 layers. But at 800x600, it can 
-    /// support either 16-bit color, or 2 layers, but not both.
+    /// The RA8875 can control typical displays from the 480x272 to 800x480, and it supports 8 or 16-bit color. 
+    /// It also supports 2 graphics layers, but it cannot support 2 layers at the maximum color depth and 
+    /// screen size. When configured under 480x400, it will support both 16-bit color depth and 2 drawing layers. 
+    /// Above 480x400 it support either 16-bit color, or 2 layers, but not both.
+    ///
+    /// Typical of the displays that are readily purchased, you will find 480x272 and 800x480 resolutions.
     ///
     /// @param[in] width in pixels to configure the display for. This parameter is optional
     ///             and the default is 480.
@@ -508,12 +510,12 @@
     ///             with the width and height parameters. This parameter is optional
     ///             and the default is 16.
     /// @param[in] poweron defines if the display should be initialized into the power-on or off state.
-    ///            If power is non-zero(on), the backlight is set to this vale. This parameter is optional
+    ///            If power is non-zero(on), the backlight is set to this value. This parameter is optional
     ///             and the default is 255 (on and full brightness). See @ref Power.
     /// @param[in] keypadon defines if the keypad support should be enabled. This parameter is optional
     ///             and the default is true (enabled). See @ref KeypadInit.
     /// @param[in] touchscreeenon defines if the touchscreen support should be enabled. 
-    ///             This parameter is optional and the default is true (enabled). See @ref TouchPanelInit.\\
+    ///             This parameter is optional and the default is true (enabled). See @ref TouchPanelInit.
     ///             - If the constructor was called with support for the capacitive driver, this 
     ///             parameter causes the driver to initialize.
     ///             - If the constructor was called without support for the capacitive driver, this
@@ -753,16 +755,19 @@
     /// Get the reported touch gesture, if any.
     /// 
     /// If it could detect a gesture, it will return a value based on
-    /// the interpreted gesture.\\
+    /// the interpreted gesture.
     ///
     /// Valid gesture values are:
     /// @li 0x00 No gesture
+    /// @li 0x48 Zoom in
+    /// @li 0x49 Zoom out
+    ///
+    /// The following gestures are defined in the FT5206 specification, but
+    /// do not appear to work.
     /// @li 0x10 Move up
     /// @li 0x14 Move left
     /// @li 0x18 Move down
     /// @li 0x1C Move right
-    /// @li 0x48 Zoom in
-    /// @li 0x49 Zoom out
     ///
     /// @returns gesture information.
     ///
@@ -791,7 +796,7 @@
     /// decrements, and the remaining touch is communicated on
     /// touch channel zero, even as the Touch ID remains as originally
     /// reported (1 in this example). In this way, it is easy to track 
-    /// a specific touch.\\
+    /// a specific touch.
     ///
     /// It is possible to query the data for a channel that is not
     /// presently reported as touched.
@@ -820,7 +825,7 @@
     /// Get the coordinates for a touch channel.
     ///
     /// This returns the (X,Y) coordinates for a touch channel.
-    ///\\
+    ///
     ///
     /// It is possible to query the data for a channel that is not
     /// presently reported as touched.