Diff: VS1053.h

Revision:

3:696c8e6744b2

Parent:

2:47ba7e2259cd

Child:

4:6e0fb5342efa

diff -r 47ba7e2259cd -r 696c8e6744b2 VS1053.h
--- a/VS1053.h	Sat Nov 09 10:23:04 2013 +0000
+++ b/VS1053.h	Wed Dec 04 16:58:44 2013 +0000
@@ -1,4 +1,4 @@
-// ==================================================== Nov 09 2013, kayeks ==
+// ==================================================== Dec 05 2013, kayeks ==
 // VS1053.h
 // ===========================================================================
 // Just a simple library for VLSI's mp3/midi codec chip
@@ -34,37 +34,15 @@
     static const uint8_t SCI_AICTRL2     = 0x0e;
     static const uint8_t SCI_AICTRL3     = 0x0f;
     
-    /** Constructor of class VS1053. */
     VS1053(PinName mosiPin, PinName misoPin, PinName sckPin,
            PinName cs, PinName bsync, PinName dreq, PinName rstPin,
            uint32_t spiFrequency=1000000);
-    
-    /** Destructor of class VS1053. */
     ~VS1053();
-    
-    /** Make a hardware reset by hitting VS1053's RESET pin. */
     void hardwareReset();
-    
-    /** Send a data byte to VS1053. */
     void sendDataByte(uint8_t data);
-    
-    /** Send a data block specified as a pointer to VS1053.
-     *  @return Data length successfully sent.
-     */
     size_t sendDataBlock(uint8_t* pData, size_t length);
-    
-    /** Change VS1053's PLL setting for speedup. */
     void clockUp();
-    
-    /** Send cancel request to VS1053.
-     *  @return 0 at failure, 1 at success.
-     */
     bool sendCancel();
-    
-    /** Attempts "stop playing".
-     *  Call this repeatedly during data stream tramsission until it successes.
-     *  @return 0 at failure, 1 at success.
-     */
     bool stop();
     
 private: