Diff: button.h

Revision:

3:1c47d318e457

Parent:

2:df827b705b98

Child:

6:b6a97933b3d5

--- a/button.h	Thu Aug 07 00:49:43 2014 +0000
+++ b/button.h	Thu Aug 07 03:59:45 2014 +0000
@@ -3,7 +3,16 @@
 
 #include "mbed.h"
 
-/** @file class to handle button input 
+/**
+ *  @file       button.h
+ *  Project     button handling Library
+ *  @brief      button handling library for mbed
+ *  @version    1.0
+ *  @author     Chuck Timber
+ *  @date       07/08/2014
+ */
+
+/** class to handle button input 
  *   The class use DigitalIn and Ticker
  *
  * Refered to: http://elm-chan.org/docs/tec/te03.html
@@ -38,8 +47,8 @@
 
 namespace mbed {
 
-/* Class: BTN
- *  A class which uses DigitalIn and Ticker
+/** Class: BTN
+ *  A class handles button input procedure, which uses DigitalIn and Ticker
  */
 class BTN {
 
@@ -49,6 +58,7 @@
     unsigned char STAT;
 
 private:
+    /** sample_btn input and process */
     void sample_btn(void);
     unsigned char FIL;
     DigitalIn _Pin;