Diff: SPIHalfDuplex.h

Revision:

43:e2ed12d17f06

Parent:

30:3991a86798e3

--- a/SPIHalfDuplex.h	Wed Aug 29 12:44:47 2012 +0100
+++ b/SPIHalfDuplex.h	Fri Oct 26 17:40:46 2012 +0100
@@ -13,93 +13,88 @@
 
 namespace mbed {
 
-/* Class: SPIHalfDuplex
- *   A SPI half-duplex master, used for communicating with SPI slave devices
- * over a shared data line.
+/** A SPI half-duplex master, used for communicating with SPI slave devices
+ *  over a shared data line.
  *
- * The default format is set to 8-bits for both master and slave, and a
- * clock frequency of 1MHz
+ *  The default format is set to 8-bits for both master and slave, and a
+ *  clock frequency of 1MHz
  *
- * Most SPI devies will also require Chip Select and Reset signals. These
- * can be controlled using <DigitalOut> pins.
+ *  Most SPI devies will also require Chip Select and Reset signals. These
+ *  can be controlled using <DigitalOut> pins.
  *
- * Although this is for a shared data line, both MISO and MOSI are defined,
- * and should be tied together externally to the mbed. This class handles
- * the tri-stating of the MOSI pin.
+ *  Although this is for a shared data line, both MISO and MOSI are defined,
+ *  and should be tied together externally to the mbed. This class handles
+ *  the tri-stating of the MOSI pin.
  *
  * Example:
- * > // Send a byte to a SPI half-duplex slave, and record the response
- * >
- * > #include "mbed.h"
- * > 
- * > SPIHalfDuplex device(p5, p6, p7) // mosi, miso, sclk
- * >
- * > int main() {
- * >     int respone = device.write(0xAA);
- * > }
+ * @code
+ * // Send a byte to a SPI half-duplex slave, and record the response
+ *
+ * #include "mbed.h"
+ * 
+ * SPIHalfDuplex device(p5, p6, p7) // mosi, miso, sclk
+ *
+ * int main() {
+ *     int respone = device.write(0xAA);
+ * }
+ * @endcode
  */
 
 class SPIHalfDuplex : public SPI {
 
 public:
     
-    /* Constructor: SPIHalfDuplex
-     *  Create a SPI half-duplex master connected to the specified pins
+    /** Create a SPI half-duplex master connected to the specified pins
      *
-     * Variables:
-     *  mosi - SPI Master Out, Slave In pin
-     *  miso - SPI Master In, Slave Out pin
-     *  sclk - SPI Clock pin
-     *  name - (optional) A string to identify the object
-     *
-     * Pin Options:
-     *  (5, 6, 7) or (11, 12, 13)
+     *  Pin Options:
+     *    (5, 6, 7) or (11, 12, 13)
      *
      *  mosi or miso can be specfied as NC if not used
+     *
+     *  @param mosi SPI Master Out, Slave In pin
+     *  @param miso SPI Master In, Slave Out pin
+     *  @param sclk SPI Clock pin
+     *  @param name (optional) A string to identify the object
      */
     SPIHalfDuplex(PinName mosi, PinName miso, PinName sclk,
         const char *name = NULL);
 
 #if 0 // Inherited from SPI - documentation only
-    /* Function: format
-     *  Configure the data transmission format
+    /** Configure the data transmission format
      *
-     * Variables:
-     *  bits - Number of bits per SPI frame (4 - 16)
-     *  mode - Clock polarity and phase mode (0 - 3)
+     *  @param bits Number of bits per SPI frame (4 - 16)
+     *  @param mode Clock polarity and phase mode (0 - 3)
      *
-     * > mode | POL PHA
-     * > -----+--------
-     * >   0  |  0   0
-     * >   1  |  0   1
-     * >   2  |  1   0
-     * >   3  |  1   1
+     * @code
+     * mode | POL PHA
+     * -----+--------
+     *   0  |  0   0
+     *   1  |  0   1
+     *   2  |  1   0
+     *   3  |  1   1
+     * @endcode
      */
     void format(int bits, int mode = 0);
 
-    /* Function: frequency
-     *  Set the spi bus clock frequency
+    /** Set the spi bus clock frequency
      *
-     * Variables:
-     *  hz - SCLK frequency in hz (default = 1MHz)
+     *  @param hz SCLK frequency in hz (default = 1MHz)
      */
     void frequency(int hz = 1000000);
 #endif
 
-    /* Function: write
-     *  Write to the SPI Slave and return the response
+    /** Write to the SPI Slave and return the response
      *
-     * Variables:
-     *  value - Data to be sent to the SPI slave
-     *  returns - Response from the SPI slave
+     *  @param value Data to be sent to the SPI slave
+     *
+     *  @returns
+     *    Response from the SPI slave
      */
     virtual int write(int value);
     
-    /* Function: slave_format
-     *  Set the number of databits expected from the slave, from 4-16
+    /** Set the number of databits expected from the slave, from 4-16
      *
-     * Variables:
-     *  sbits - Number of expected bits in the slave response
+     *  @param sbits Number of expected bits in the slave response
      */
     void slave_format(int sbits);