Diff: wave_player.h

Revision:

1:acc3e18e77ad

Parent:

0:62c18ade9a60

Child:

2:da5d90e12f27

--- a/wave_player.h	Tue Jan 18 03:41:02 2011 +0000
+++ b/wave_player.h	Tue Jan 18 03:57:27 2011 +0000
@@ -9,10 +9,17 @@
   short sig_bps;
 } FMT_STRUCT;
 
-/** wave file player class, taking a pointer to an AnalogOut object.
+
+/** wave file player class.
  *
  * Example:
  * @code
+ * #include <mbed.h>
+ * #include <wave_player.h>
+ *
+ * AnalogOut DACout(p18);
+ * wave_player waver(&DACout);
+ *
  * int main() {
  *  FILE *wave_file;
  *  
@@ -28,7 +35,7 @@
 public:
 /** Create a wave player using a pointer to the given AnalogOut object.
  *
- * @param dac AnalogOut object to which the samples are sent.
+ * @param _dac pointer to an AnalogOut object to which the samples are sent.
  */
 wave_player(AnalogOut *_dac);
 
@@ -62,6 +69,4 @@
 short DAC_on;
 };
 
-//void play_wave(FILE *wavefile,AnalogOut *dac);
-//void dac_out();