Revision 2:b36bd99c6755, committed 2015-10-22

Comitter:

mpetrut

Date:

Thu Oct 22 16:21:42 2015 +0000

Parent:

1:399a3ad230c8

Child:

3:b258cf76ee4f

Commit message:

Doxygen

Changed in this revision

--- a/Midi5Pin.h	Thu Oct 22 16:09:13 2015 +0000
+++ b/Midi5Pin.h	Thu Oct 22 16:21:42 2015 +0000
@@ -9,24 +9,46 @@
  
 class Midi5Pin {
 public:
-    /// Create a Midi5Pin object with the specified
-    /// transmit and receive pins
+    /** Create a Midi5Pin object with the specified
+     * transmit and receive pins
+     *
+     * @param txPin Transmit pin
+     * @param rxPin Receive pin
+     */
     Midi5Pin(PinName txPin, PinName rxPin);
     
-    /// Send a command to the 5-pin output port
+    /** Send a command to the 5-pin output port
+     *
+     * @param command The MIDI command byte
+     * @param param1 First parameter (depends on command)
+     * @param param2 Second parameter (depends on command)
+     */
     void write(char command, char param1, char param2);
     
-    /// Send a noteOn MIDI message to the 5-pin output
+    /** Send a noteOn MIDI message to the 5-pin output
+     *
+     * @param note MIDI note number
+     * @param velocity MIDI note velocity (loudness)
+     */
     void noteOn(char note, char velocity);
     
-    /// Send a noteOff MIDI message to the 5-pin output
+    /** Send a noteOff MIDI message to the 5-pin output
+     *
+     * @param note MIDI note number
+     */
     void noteOff(char note);
     
-    /// Send a continuous control message to the 5-pin output
+    /** Send a continuous control message to the 5-pin output
+     *
+     * @param ccNumber The continuous control message number
+     * @param value Value of the continuous control message
+     */
     void contCtrl(char ccNumber, char value);
     
-    /// Read from the 5-pin input connection and send
-    /// it to the PC through the USB virtual com port
+    /** Read from the 5-pin input connection and send
+     * it to the PC through the USB virtual com port
+     *
+     */
     void read();
   
 private: