Diff: mbed_interface.h

Revision:

43:e2ed12d17f06

Parent:

27:7110ebee3484

Child:

44:24d45a770a51

--- a/mbed_interface.h	Wed Aug 29 12:44:47 2012 +0100
+++ b/mbed_interface.h	Fri Oct 26 17:40:46 2012 +0100
@@ -1,5 +1,4 @@
-/* Title: mbed_interface
- * Functions to control the mbed interface
+/** Functions to control the mbed interface
  *
  * mbed Microcontrollers have a built-in interface to provide functionality such as 
  * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file 
@@ -18,67 +17,63 @@
 extern "C" {
 #endif
 
-/* Function: mbed_interface_connected
- * Determine whether the mbed interface is connected, based on whether debug is enabled
+/** Determine whether the mbed interface is connected, based on whether debug is enabled
  * 
- * Variables:
- *  returns - 1 if interface is connected, else 0
+ *  @returns
+ *    1 if interface is connected,
+ *    0 otherwise
  */
 int mbed_interface_connected(void);
 
-/* Function: mbed_interface_reset
- * Instruct the mbed interface to reset, as if the reset button had been pressed
+/** Instruct the mbed interface to reset, as if the reset button had been pressed
  *
- * Variables:
- *  returns - 1 if successful, else 0 (e.g. interface not present)
+ *  @returns
+ *    1 if successful,
+ *    0 otherwise (e.g. interface not present)
  */
 int mbed_interface_reset(void);
 
-/* Function: mbed_interface_disconnect
- * This will disconnect the debug aspect of the interface, so semihosting will be disabled.
- * The interface will still support the USB serial aspect
+/** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
+ *  The interface will still support the USB serial aspect
  *
- * Variables:
- *  returns - 0 if successful, else -1 (e.g. interface not present)
+ *  @returns
+ *    0 if successful,
+ *   -1 otherwise (e.g. interface not present)
  */
 int mbed_interface_disconnect(void);
 
-/* Function: mbed_interface_powerdown
- * This will disconnect the debug aspect of the interface, and if the USB cable is not 
- * connected, also power down the interface. If the USB cable is connected, the interface
- * will remain powered up and visible to the host 
+/** This will disconnect the debug aspect of the interface, and if the USB cable is not 
+ *  connected, also power down the interface. If the USB cable is connected, the interface
+ *  will remain powered up and visible to the host 
  *
- * Variables:
- *  returns - 0 if successful, else -1 (e.g. interface not present)
+ *  @returns
+ *    0 if successful,
+ *   -1 otherwise (e.g. interface not present)
  */
 int mbed_interface_powerdown(void);
 
-/* Function: mbed_interface_uid
- * This returns a string containing the 32-character UID of the mbed interface
+/** This returns a string containing the 32-character UID of the mbed interface
+ *  This is a weak function that can be overwritten if required
  *
- * This is a weak function that can be overwritten if required
+ *  @param uid A 33-byte array to write the null terminated 32-byte string
  *
- * Variables:
- *  uid - A 33-byte array to write the null terminated 32-byte string
- *  returns - 0 if successful, else -1 (e.g. interface not present)
+ *  @returns
+ *    0 if successful,
+ *   -1 otherwise (e.g. interface not present)
  */
 int mbed_interface_uid(char *uid);
 
-/* Function: mbed_mac_address
- * This returns a unique 6-byte MAC address, based on the interface UID
- *
- * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
+/** This returns a unique 6-byte MAC address, based on the interface UID
+ *  If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
  *
- * This is a weak function that can be overwritten if you want to provide your own mechanism to
- * provide a MAC address.
-
- * Variables:
- *  mac - A 6-byte array to write the MAC address
+ *  This is a weak function that can be overwritten if you want to provide your own mechanism to
+ *  provide a MAC address.
+ *
+ *  @param mac A 6-byte array to write the MAC address
  */
 void mbed_mac_address(char *mac);
 
-/* Function: mbed_die
- * Cause the mbed to flash the BLOD LED sequence
+/** Cause the mbed to flash the BLOD LED sequence
  */
 void mbed_die(void);