Diff: WDplayer.h

Revision:

2:41149130ecf4

Parent:

1:f24e1ca9c03a

Child:

3:574fdfeb949e

--- a/WDplayer.h	Tue Apr 09 04:28:55 2019 +0000
+++ b/WDplayer.h	Tue Apr 09 04:32:52 2019 +0000
@@ -1,41 +1,41 @@
 #ifndef WDPLAYER_H
 #define WDPLAYER_H
 
-/* WDplayer Class
-  A PWM Audio Player for .Wav runs for 8-bit Mono Audio samples
-  
-  Example:
- @code
- #include "mbed.h"
- #include "SDFileSystem.h"
- #include "WDplayer.h"
- 
- SDFileSystem sd(PTE3, PTE1, PTE2, PTE4, "sd");
- 
- int main() {
-     //Defining a File Path
-    const char *mp3p; 
-    mp3p = "/sd/Game-Files/AudBin/play1.wav";
- 
-    //Creating an Object
-    WDplayer mp3;
- 
-    //Intialize with File Path
-    mp3.intWD(mp3p);
- 
-    //Play the File
-    mp3.WDplay();
-    
-    //Changing Path
-    mp3p = "/sd/Game-Files/AudBin/play2.wav";
- 
-    //Using the One Tick One Sample Playing
-    while(1) {
-        mp3.WDtck();
-    }
-   
- }
- @endcode
+/** WDplayer Class
+ * A PWM Audio Player for .Wav runs for 8-bit Mono Audio samples
+ * 
+ * Example:
+ *@code
+ *#include "mbed.h"
+ *#include "SDFileSystem.h"
+ *#include "WDplayer.h"
+ *
+ *SDFileSystem sd(PTE3, PTE1, PTE2, PTE4, "sd");
+ *
+ *int main() {
+ *    //Defining a File Path
+ *   const char *mp3p; 
+ *   mp3p = "/sd/Game-Files/AudBin/play1.wav";
+ *
+ *   //Creating an Object
+ *   WDplayer mp3;
+ *
+ *   //Intialize with File Path
+ *   mp3.intWD(mp3p);
+ *
+ *   //Play the File
+ *   mp3.WDplay();
+ *  
+ *  //Changing Path
+ *   mp3p = "/sd/Game-Files/AudBin/play2.wav";
+ *
+ *   //Using the One Tick One Sample Playing
+ *   while(1) {
+ *       mp3.WDtck();
+ *   }
+ *  
+ *}
+ *@endcode
  */