Class library for a serial lcd implemented on a DISCO-F469NI Development board running specific firmware for this purpose.

Dependencies:   BufferedSerial

Revision:
2:b4877019c16a
Parent:
1:6fec01e0ac0f
Child:
3:33ee80658224
--- a/DISCOF469SerialLCD.h	Sun Feb 18 19:50:02 2018 +0000
+++ b/DISCOF469SerialLCD.h	Sun Feb 18 19:54:18 2018 +0000
@@ -162,116 +162,113 @@
     
     /** 
     * @brief Clears the LCD by filling it with the specified color pixels. 
-    * @param Color: Color to fill the screen with - represented in ARGB8888 color space format.
+    * @param Color Color to fill the screen with - represented in ARGB8888 color space format.
     */
     void Clear(uint32_t Color);
 
     /**
     * @brief  Draws a pixel on the LCD.
-    * @param 
-    *       Xpos X position
-    *       Ypos Y position
-    * @param  Xpos: X position
-    * @param  Ypos: Y position
-    * @param  Color: Pixel color in ARGB mode (8-8-8-8)
+    * @param  Xpos X position
+    * @param  Ypos Y position
+    * @param  Color Pixel color in ARGB mode (8-8-8-8)
     */
     void DrawPixel(uint16_t Xpos, uint16_t Ypos, uint32_t Color);
 
     /**
     * @brief  Reads the color of an LCD pixel.
-    * @param  Xpos: X position
-    * @param  Ypos: Y position
+    * @param  Xpos X position
+    * @param  Ypos Y position
     * @retval Pixel color in ARGB mode (8-8-8-8)
     */
     uint32_t ReadPixel(uint16_t Xpos, uint16_t Ypos);
     
     /** 
     * @brief  Draws a line on the LCD.
-    * @param  x1: Point 1 X position
-    * @param  y1: Point 1 Y position
-    * @param  x2: Point 2 X position
-    * @param  y2: Point 2 Y position
-    * @param Color: Line color in ARGB mode (8-8-8-8)
+    * @param  x1 Point 1 X position
+    * @param  y1 Point 1 Y position
+    * @param  x2 Point 2 X position
+    * @param  y2 Point 2 Y position
+    * @param Color Line color in ARGB mode (8-8-8-8)
     */
     void DrawLine(uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint32_t Color);
 
     /**
     * @brief  Draws a rectangle on the LCD.
-    * @param  Xpos: X position
-    * @param  Ypos: Y position
-    * @param  Width: Rectangle width
-    * @param  Height: Rectangle height
-    * @param  Color: Rectangle color in ARGB mode (8-8-8-8)
+    * @param  Xpos X position
+    * @param  Ypos Y position
+    * @param  Width Rectangle width
+    * @param  Height Rectangle height
+    * @param  Color Rectangle color in ARGB mode (8-8-8-8)
     */
     void DrawRectangle(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height, uint32_t Color);
     
     /**
     * @brief  Draws a filled rectangle on the LCD.
-    * @param  Xpos: X position
-    * @param  Ypos: Y position
-    * @param  Width: Rectangle width
-    * @param  Height: Rectangle height
-    * @param  Color: Rectangle color in ARGB mode (8-8-8-8)
+    * @param  Xpos X position
+    * @param  Ypos Y position
+    * @param  Width Rectangle width
+    * @param  Height Rectangle height
+    * @param  Color Rectangle color in ARGB mode (8-8-8-8)
     */
     void FillRectangle(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height, uint32_t Color);
 
     /**
     * @brief  Draws a circle on the LCD.
-    * @param  Xpos: X position
-    * @param  Ypos: Y position
-    * @param  Radius: Circle radius
-    * @param  Color: Circle color in ARGB mode (8-8-8-8)
+    * @param  Xpos X position
+    * @param  Ypos Y position
+    * @param  Radius Circle radius
+    * @param  Color Circle color in ARGB mode (8-8-8-8)
     */
     void DrawCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius, uint32_t Color);
     
     /**
     * @brief  Draws a filled circle on the LCD.
-    * @param  Xpos: X position
-    * @param  Ypos: Y position
-    * @param  Radius: Circle radius
-    * @param  Color: Circle color in ARGB mode (8-8-8-8)
+    * @param  Xpos X position
+    * @param  Ypos Y position
+    * @param  Radius Circle radius
+    * @param  Color Circle color in ARGB mode (8-8-8-8)
     */
     void FillCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius, uint32_t Color);
 
     /**
     * @brief  Draws an ellipse on the LCD.
-    * @param  Xpos: X position
-    * @param  Ypos: Y position
-    * @param  XRadius: Ellipse X radius
-    * @param  YRadius: Ellipse Y radius
-    * @param  Color: Ellipse color in ARGB mode (8-8-8-8)
+    * @param  Xpos X position
+    * @param  Ypos Y position
+    * @param  XRadius Ellipse X radius
+    * @param  YRadius Ellipse Y radius
+    * @param  Color Ellipse color in ARGB mode (8-8-8-8)
     */
     void DrawEllipse(uint16_t Xpos, uint16_t Ypos, uint16_t XRadius, uint16_t YRadius, uint32_t Color);
     
     /**
     * @brief  Draws a filled ellipse on the LCD.
-    * @param  Xpos: X position
-    * @param  Ypos: Y position
-    * @param  XRadius: Ellipse X radius
-    * @param  YRadius: Ellipse Y radius
-    * @param  Color: Ellipse color in ARGB mode (8-8-8-8)
+    * @param  Xpos X position
+    * @param  Ypos Y position
+    * @param  XRadius Ellipse X radius
+    * @param  YRadius Ellipse Y radius
+    * @param  Color Ellipse color in ARGB mode (8-8-8-8)
     */
     void FillEllipse(uint16_t Xpos, uint16_t Ypos, uint16_t XRadius, uint16_t YRadius, uint32_t Color);
     
     /**
     * @brief  Displays a string on the LCD at Xpos,Ypos.
-    * @param  Xpos: X position (in pixel)
-    * @param  Ypos: Y position (in pixel)
-    * @param  FontSize: The size of the text (0 - 4)
-    * @param  TextColor: The text foreground color
-    * @param  BackColor: The text background color
-    * @param  Text: String to display on LCD
+    * @param  Xpos X position (in pixel)
+    * @param  Ypos Y position (in pixel)
+    * @param  FontSize The size of the text (0 - 4)
+    * @param  TextColor The text foreground color
+    * @param  BackColor The text background color
+    * @param  Text String to display on LCD
     */
     void DrawStringAtXY(uint16_t Xpos, uint16_t Ypos, uint8_t FontSize, uint32_t TextColor, uint32_t BackColor, char *Text);
     
     /**
     * @brief  Displays a string on the LCD at a certain line based on the font size.
-    * @param  Line: Line where to display the string
-    * @param  FontSize: The size of the text (0 - 4)
-    * @param  TextColor: The text foreground color
-    * @param  BackColor: The text background color
-    * @param  Mode: Display mode (0=LEFT mode; 1=CENTER mode; 2=RIGHT mode)
-    * @param  Text: String to display on LCD
+    * @param  Line Line where to display the string
+    * @param  FontSize The size of the text (0 - 4)
+    * @param  TextColor The text foreground color
+    * @param  BackColor The text background color
+    * @param  Mode Display mode (0=LEFT mode; 1=CENTER mode; 2=RIGHT mode)
+    * @param  Text String to display on LCD
     */
     void DrawStringAtLine(uint16_t Line, uint8_t FontSize, uint32_t TextColor, uint32_t BackColor, uint8_t Mode, char *Text);
 
@@ -283,39 +280,39 @@
            
     /**
     * @brief  Gets the x and y coordinates of the first touch on the touchscreen.
-    * @param  x: Pointer to the x coordinate
-    * @param  y: Pointer to the y coordinate
+    * @param  x Pointer to the x coordinate
+    * @param  y Pointer to the y coordinate
     */
     void GetTouch1(uint16_t *x, uint16_t *y);
     
     /**
     * @brief  Gets the x and y coordinates of the second touch on the touchscreen.
-    * @param  x: Pointer to the x coordinate
-    * @param  y: Pointer to the y coordinate
+    * @param  x Pointer to the x coordinate
+    * @param  y Pointer to the y coordinate
     */
     void GetTouch2(uint16_t *x, uint16_t *y);
     
     /**
     * @brief  Writes to the LCD's LED1.
-    * @param  OnOff: 1 = On; 0 = Off
+    * @param  OnOff 1 = On; 0 = Off
     */
     void LED1(uint8_t OnOff);
     
     /**
     * @brief  Writes to the LCD's LED1.
-    * @param  OnOff: 1 = On; 0 = Off
+    * @param  OnOff 1 = On; 0 = Off
     */
     void LED2(uint8_t OnOff);
     
     /**
     * @brief  Writes to the LCD's LED1.
-    * @param  OnOff: 1 = On; 0 = Off
+    * @param  OnOff 1 = On; 0 = Off
     */
     void LED3(uint8_t OnOff);
     
     /**
     * @brief  Writes to the LCD's LED1.
-    * @param  OnOff: 1 = On; 0 = Off
+    * @param  OnOff 1 = On; 0 = Off
     */
     void LED4(uint8_t OnOff);