[gnoduino: 37/237] Added a brief explanation of how you'd use Printable



commit 264b50b2e113f2b9db61bb1b0bd9f2c9a8dc3dff
Author: amcewen <amcewen bcs org uk>
Date:   Sat Apr 2 11:33:27 2011 +0100

    Added a brief explanation of how you'd use Printable

 arduino/cores/arduino/Printable.h |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)
---
diff --git a/arduino/cores/arduino/Printable.h b/arduino/cores/arduino/Printable.h
index fc64858..e5d7732 100644
--- a/arduino/cores/arduino/Printable.h
+++ b/arduino/cores/arduino/Printable.h
@@ -22,6 +22,12 @@
 
 class Print;
 
+/** The Printable class provides a way for new classes to allow themselves to be printed.
+    By deriving from Printable and implementing the printTo method, it will then be possible
+    for users to print out instances of this class by passing them into the usual
+    Print::print and Print::println methods.
+*/
+
 class Printable
 {
   public:



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]