Bob Merrison-Hort / Mbed 2 deprecated elec350

elec350

Dependencies:   mbed

Fork of elec350 by Bob Merrison-Hort

Diff: microphone.h

Revision:
10:021f19a9861f
Parent:
9:3801e1da153b
Child:
12:ae626e46b996
--- a/microphone.h	Wed Oct 21 19:20:17 2015 +0000
+++ b/microphone.h	Wed Oct 21 19:52:30 2015 +0000
@@ -8,9 +8,16 @@
     private:
         bool isStarted;
     public:
+        // Constructor.
         Microphone();
+        
+        // Begins sampling data from the microphone using timer 3.
         void start();
+        
+        // Ends sampling (UNTESTED!)
         void stop();
+        
+        // Returns a signed 8-bit integer containing the latest data from the microphone.
         int8_t read();    
 };