Diff: RA8875.h

Revision:

196:56820026701b

Parent:

195:17e176dbd6eb

Child:

197:853d08e2fb53

diff -r 17e176dbd6eb -r 56820026701b RA8875.h
--- a/RA8875.h	Tue Feb 11 18:33:44 2020 +0000
+++ b/RA8875.h	Tue Feb 11 21:26:59 2020 +0000
@@ -58,19 +58,29 @@
 /// * @ref External_Resources
 /// * @ref Future_Plans
 ///
-/// @todo Add APIs for the 2nd RA8875 PWM channel. If the frequency can be independently
-///     controlled, it could be used as a simple beeper.
+/// @todo Move the global enums into the class (e.g. NOFILL becomes RA8875::NOFILL) to
+///     avoid namespace clashes.
+/// @todo Integrate the touch as a runtime linkable feature, which can then eliminate
+///     the huge memory footprint for the GSL1680 firmware when it is not needed.
+/// @todo Integrate installed font-rom.
 /// @todo Figure out how to "init()" in the constructor. I ran into some issues if
 ///     the display was instantiated before main(), and the code would not run,
 ///     thus the exposure and activation of the init() function. If the constructor
 ///     was within main(), then it seemed to work as expected.
+/// @todo Add Scroll support for text.
+/// @todo Add Hardware reset signal - but testing to date indicates it is not needed.
+/// @todo Add high level objects - x-y graph, meter, others... but these will
+///     probably be best served in another class, since they may not
+///     be needed for many uses.
+/// @todo Add APIs for the 2nd RA8875 PWM channel. If the frequency can be independently
+///     controlled, it could be used as a simple beeper.
 ///
 /// @note As the author of this library, let me state that I am not affiliated with
 ///     Raio (silicon provider of the RA8875), or with BuyDisplay.com (where a lot
 ///     of these displays can be purchased), I am simply a very satisfied customer
 ///     of the technology of the RA8875 chip.
 ///
-/// @copyright Copyright © 2012-2019 by Smartware Computing, all rights reserved.
+/// @copyright Copyright © 2012-2020 by Smartware Computing, all rights reserved.
 ///     This library is predominantly, that of Smartware Computing, however some
 ///     portions are compiled from the work of others. Where the contribution of
 ///     others was listed as copyright, that copyright is maintained, even as a
@@ -503,14 +513,6 @@
 /// }
 /// @endcode
 ///
-/// @todo Add Scroll support for text.
-/// @todo Add Hardware reset signal - but testing to date indicates it is not needed.
-/// @todo Add high level objects - x-y graph, meter, others... but these will
-///     probably be best served in another class, since they may not
-///     be needed for many uses.
-/// @todo Move the global enums into the class (e.g. NOFILL becomes RA8875::NOFILL) to
-///     avoid namespace clashes.
-///
 class RA8875 : public GraphicsDisplay
 {
 public:
@@ -1996,6 +1998,18 @@
     /// Write string of text to the display at the specified location.
     ///
     /// @code
+    ///     const point_t pt = {10, 25};
+    ///     lcd.puts(pt, "Test STring");
+    /// @endcode
+    ///
+    /// @param[in] pt is the x,y position as a point
+    /// @param[in] string is the null terminated string to send to the display.
+    ///
+    void puts(point_t pt, const char * string);
+
+    /// Write string of text to the display at the specified location.
+    ///
+    /// @code
     ///     lcd.puts(10,25, "Test STring");
     /// @endcode
     ///