Diff: DisplayDefs.h

Revision:

125:7a0b70f56550

Parent:

123:2f45e80fec5f

Child:

167:8aa3fb2a5a31

--- a/DisplayDefs.h	Sun Jul 31 20:59:01 2016 +0000
+++ b/DisplayDefs.h	Mon Aug 01 22:31:42 2016 +0000
@@ -4,7 +4,7 @@
 #define RGB(r,g,b) ( ((r<<8)&0xF800) | ((g<<3)&0x07E0) | (b>>3) )
 
 
-/// return values from functions. Use this number, or use the 
+/// Return values from functions. Use this number, or use the 
 /// lookup function to get a text string. @see GetErrorMessage.
 ///
 typedef enum
@@ -33,11 +33,11 @@
     no_cal,                 ///< no calibration matrix is available
 } TouchCode_t;
 
-/// type that manages locations, which is typically an x or y pixel location,
+/// Data type that manages locations, which is typically an x or y pixel location,
 /// which can range from -N to +N (even if the screen is 0 to +n). @see textloc_t.
 typedef int16_t loc_t;
 
-/// type that manages text locations, which are row or column values in
+/// Data type that manages text locations, which are row or column values in
 /// units of character, not pixel. @see loc_t.
 typedef uint16_t textloc_t;
 
@@ -51,7 +51,7 @@
     loc_t y;             ///< y value in the point
 } point_t;
 
-/// type that manages rectangles, which are pairs of points. It is recommended
+/// Data type that manages rectangles, which are pairs of points. It is recommended
 /// that p1 contains the top-left point and p2 contains the bottom-right point,
 /// even though eventually this should not matter.
 typedef struct
@@ -60,9 +60,19 @@
     point_t p2;         ///< p2 defines the opposite point on the rectangle
 } rect_t;
 
+/// Data type that manages the calibration matrix for the resistive touch panel.
+///
+/// This object, when instantiated, may be passed back and forth, stored
+/// and loaded, but the internals are generally of little interest.
 typedef struct
 {
-    int32_t An, Bn, Cn, Dn, En, Fn, Divider;
+    int32_t An;         ///< calibration factor, see source for details
+    int32_t Bn;         ///< calibration factor, see source for details
+    int32_t Cn;         ///< calibration factor, see source for details
+    int32_t Dn;         ///< calibration factor, see source for details
+    int32_t En;         ///< calibration factor, see source for details
+    int32_t Fn;         ///< calibration factor, see source for details
+    int32_t Divider;    ///< calibration factor, see source for details
 } tpMatrix_t;
 
 /// color type definition to let the compiler help keep us honest.