Revision 2:7a1d7d6d520e, committed 2016-11-20

Comitter:

switches

Date:

Sun Nov 20 23:41:01 2016 +0000

Parent:

1:15e34492fbf1

Child:

3:09e3dbb49561

Commit message:

Modified comments for doxygen API documentation

Changed in this revision

--- a/max32630fthr.h	Sun Nov 20 23:31:36 2016 +0000
+++ b/max32630fthr.h	Sun Nov 20 23:41:01 2016 +0000
@@ -37,6 +37,36 @@
 #include "mbed.h"
 #include "MAX14690.h"
 
+/**
+ * @brief MAX32630FTHR Board Support Library
+ *
+ * @details The MAX32630FTHR is a rapid development application board for
+ * ultra low power wearable applications.  It includes common peripherals and 
+ * expansion connectors all power optimized for getting the longest life from 
+ * the battery.  This library configures the power and I/O for the board.
+ * <br>https://www.maximintegrated.com/max32630fthr
+ *
+ * @code
+ * #include "mbed.h"
+ * #include "max32630fthr.h"
+ * 
+ * DigitalOut led1(LED1);
+ * MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3);
+ * 
+ * // main() runs in its own thread in the OS
+ * // (note the calls to Thread::wait below for delays)
+ * int main()
+ * {
+ *     // initialize power and I/O on MAX32630FTHR board
+ *     pegasus.init();
+ *     
+ *     while (true) {
+ *         led1 = !led1;
+ *         Thread::wait(500);
+ *     }
+ * }
+ * @endcode
+ */
 class MAX32630FTHR
 {
 public: