Diff: morsegenerator.h

Revision:

1:23b6dc8f569e

Parent:

0:44a2d3f18e9f

Child:

2:bdf2fa2879cf

--- a/morsegenerator.h	Mon Apr 30 21:05:30 2012 +0000
+++ b/morsegenerator.h	Mon Apr 30 21:13:48 2012 +0000
@@ -10,6 +10,29 @@
 const std::string MORSE_LETTERS[] = {".-", "-...", "-.-.", "-..", ".", "..-.", "--.", "....", "..", ".---", "-.-", ".-..", "--", "-.", "---", ".--.", "--.-", ".-.", "...", "-", "..-", "...-", ".--", "-..-", "-.--", "--.."};
 const std::string MORSE_NUMBERS[] = {".----", "..---", "...--", "....-", ".....", "-....", "--...", "---..", "----.", "-----"};
 
+/** MorseGenerator class.
+ *
+ * Example:
+ * @code
+ * #include "mbed.h"
+ * #include "main.h"
+ * #include "morsegenerator.h"
+ *
+ * DigitalOut myled(p18);
+ *
+ * void morse_callback(int val) {
+ *     myled = val;
+ * }
+ * 
+ * int main() {
+ *     MorseGenerator morse = MorseGenerator(morse_callback);
+ * 
+ *     while (1) {
+ *         morse.transmit("CQCQ DE M6SPX");
+ *     }
+ * }
+ * @endcode
+ */
 class MorseGenerator {
     MapType morse_map;
     callback_type callback;