Diff: I2CSlave.h

Revision:

43:aff670d0d510

Parent:

27:7110ebee3484

--- a/I2CSlave.h	Wed Aug 29 12:44:47 2012 +0100
+++ b/I2CSlave.h	Wed Oct 24 10:44:49 2012 +0000
@@ -16,39 +16,39 @@
 
 namespace mbed {
 
-/* Class: I2CSlave
- *  An I2C Slave, used for communicating with an I2C Master device
+/** An I2C Slave, used for communicating with an I2C Master device
  *
  * Example:
- * > // Simple I2C responder
- * > #include <mbed.h>
- * >
- * > I2CSlave slave(p9, p10);
- * >
- * > int main() {
- * >     char buf[10];
- * >     char msg[] = "Slave!";
- * >
- * >     slave.address(0xA0);
- * >     while (1) {
- * >         int i = slave.receive();
- * >         switch (i) {
- * >             case I2CSlave::ReadAddressed: 
- * >                 slave.write(msg, strlen(msg) + 1); // Includes null char
- * >                 break;
- * >             case I2CSlave::WriteGeneral:
- * >                 slave.read(buf, 10);
- * >                 printf("Read G: %s\n", buf);
- * >                 break;
- * >             case I2CSlave::WriteAddressed:
- * >                 slave.read(buf, 10);
- * >                 printf("Read A: %s\n", buf);
- * >                 break;
- * >         }
- * >         for(int i = 0; i < 10; i++) buf[i] = 0;    // Clear buffer
- * >     }
- * > }
- * >                  
+ * @code
+ * // Simple I2C responder
+ * #include <mbed.h>
+ *
+ * I2CSlave slave(p9, p10);
+ *
+ * int main() {
+ *     char buf[10];
+ *     char msg[] = "Slave!";
+ *
+ *     slave.address(0xA0);
+ *     while (1) {
+ *         int i = slave.receive();
+ *         switch (i) {
+ *             case I2CSlave::ReadAddressed: 
+ *                 slave.write(msg, strlen(msg) + 1); // Includes null char
+ *                 break;
+ *             case I2CSlave::WriteGeneral:
+ *                 slave.read(buf, 10);
+ *                 printf("Read G: %s\n", buf);
+ *                 break;
+ *             case I2CSlave::WriteAddressed:
+ *                 slave.read(buf, 10);
+ *                 printf("Read A: %s\n", buf);
+ *                 break;
+ *         }
+ *         for(int i = 0; i < 10; i++) buf[i] = 0;    // Clear buffer
+ *     }
+ * }
+ * @endcode                  
  */
 class I2CSlave : public Base {
 
@@ -61,84 +61,78 @@
         , WriteAddressed    = 3
     };
 
-    /* Constructor: I2CSlave
-     *  Create an I2C Slave interface, connected to the specified pins.
+    /** Create an I2C Slave interface, connected to the specified pins.
      *
-     * Variables:
-     *  sda - I2C data line pin
-     *  scl - I2C clock line pin
+     *  @param sda I2C data line pin
+     *  @param scl I2C clock line pin
      */
     I2CSlave(PinName sda, PinName scl, const char *name = NULL);
 
-    /* Function: frequency
-     *  Set the frequency of the I2C interface
+    /** Set the frequency of the I2C interface
      *
-     * Variables:
-     *  hz - The bus frequency in hertz
+     *  @param hz The bus frequency in hertz
      */
     void frequency(int hz);
 
-    /* Function: receive
-     *  Checks to see if this I2C Slave has been addressed.
+    /** Checks to see if this I2C Slave has been addressed.
      *
-     * Variables:
-     *  returns - a status indicating if the device has been addressed, and how
-     *  > NoData            - the slave has not been addressed
-     *  > ReadAddressed     - the master has requested a read from this slave
-     *  > WriteAddressed    - the master is writing to this slave
-     *  > WriteGeneral      - the master is writing to all slave 
+     *  @returns
+     *  A status indicating if the device has been addressed, and how
+     *  - NoData            - the slave has not been addressed
+     *  - ReadAddressed     - the master has requested a read from this slave
+     *  - WriteAddressed    - the master is writing to this slave
+     *  - WriteGeneral      - the master is writing to all slave 
      */
     int receive(void);
 
-    /* Function: read
-     *  Read from an I2C master.
+    /** Read from an I2C master.
      *
-     * Variables:
-     *  data - pointer to the byte array to read data in to
-     *  length - maximum number of bytes to read
-     *  returns - 0 on success, non-0 otherwise
+     *  @param data pointer to the byte array to read data in to
+     *  @param length maximum number of bytes to read
+     *
+     *  @returns
+     *       0 on success,
+     *   non-0 otherwise
      */
     int read(char *data, int length); 
 
-    /* Function: read
-     *  Read a single byte from an I2C master.
+    /** Read a single byte from an I2C master.
      *
-     * Variables:
-     *  returns - the byte read
+     *  @returns
+     *    the byte read
      */
     int read(void);
 
-    /* Function: write
-     *  Write to an I2C master.
+    /** Write to an I2C master.
      *
-     * Variables:
-     *  data - pointer to the byte array to be transmitted
-     *  length - the number of bytes to transmite
-     *  returns - a 0 on success, non-0 otherwise
+     *  @param data pointer to the byte array to be transmitted
+     *  @param length the number of bytes to transmite
+     *
+     *  @returns
+     *       0 on success,
+     *   non-0 otherwise
      */
     int write(const char *data, int length);
 
-    /* Function: write
-     *  Write a single byte to an I2C master.
+    /** Write a single byte to an I2C master.
+     *
+     *  @data the byte to write
      *
-     * Variables
-     *  data - the byte to write
-     *  returns - a '1' if an ACK was received, a '0' otherwise
+     *  @returns
+     *    '1' if an ACK was received,
+     *    '0' otherwise
      */
     int write(int data);
 
-    /* Function: address
-     *  Sets the I2C slave address.
+    /** Sets the I2C slave address.
      *
-     * Variables
-     *  address - the address to set for the slave (ignoring the least
-     *  signifcant bit). If set to 0, the slave will only respond to the
-     *  general call address.
+     *  @param address The address to set for the slave (ignoring the least
+     *    signifcant bit). If set to 0, the slave will only respond to the
+     *    general call address.
      */
     void address(int address);
 
-    /* Function: stop
-     *  Reset the I2C slave back into the known ready receiving state.
+    /** Reset the I2C slave back into the known ready receiving state.
      */
     void stop(void);