diff options
| author | amcewen <amcewen@bcs.org.uk> | 2011-04-02 11:33:27 +0100 |
|---|---|---|
| committer | amcewen <amcewen@bcs.org.uk> | 2011-04-02 11:33:27 +0100 |
| commit | 49155d0a4604eb50d756527ef9512499d2ea6cf4 (patch) | |
| tree | c8077c6a479627c326cd181e153fb2b51f27045c /cores/arduino/Printable.h | |
| parent | 2cedbeef132256ceca033f4b5073ab9aba818130 (diff) | |
Added a brief explanation of how you'd use Printable
Diffstat (limited to 'cores/arduino/Printable.h')
| -rw-r--r-- | cores/arduino/Printable.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/cores/arduino/Printable.h b/cores/arduino/Printable.h index fc64858..e5d7732 100644 --- a/cores/arduino/Printable.h +++ b/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: |
