Diff: DMBoard.h

Revision:

9:a33326afd686

Parent:

5:c77fdb6e3438

Child:

10:1ac4b213f0f7

--- a/DMBoard.h	Thu Dec 11 11:50:29 2014 +0000
+++ b/DMBoard.h	Thu Dec 11 18:23:07 2014 +0000
@@ -69,13 +69,16 @@
         TouchError    =       3,
     };
     
+    /** Get the only instance of the DMBoard
+     *
+     *  @returns The DMBoard
+     */
     static DMBoard& instance()
     {
         static DMBoard singleton;
         return singleton;
     }
   
-
     /** Initializes the wanted features
      *
      *  @returns
@@ -84,6 +87,11 @@
      */
     BoardError init();
   
+    /** Controls the four LEDs on the Display Module
+     *
+     * @param led One of Led1, Led2, Led3 or Led4
+     * @param on true to turn the LED on regardless of its polarity
+     */
     void setLED(Leds led, bool on);
     
     /** Controls the buzzer
@@ -99,16 +107,37 @@
      * @param duration_ms the number of milliseconds to play or 0 for forever
      */
     void buzzer(int frequency=0, int duration_ms=0);
+    
+    /** Test if the USER button is pressed or not
+     *
+     *  @returns
+     *       True if the button is pressed, false if not
+     */
     bool buttonPressed();
     
 #if defined(DM_BOARD_USE_TOUCH)
+    /** Returns the TouchPanel interface
+     *
+     *  @returns
+     *       The touch panel
+     */
     TouchPanel* touchPanel() { return _touch; }
 #endif
 #if defined(DM_BOARD_USE_DISPLAY)
+    /** Returns the Display interface
+     *
+     *  @returns
+     *       The display
+     */
     Display* display() { return &(Display::instance()); }
 
     friend class Display;
 #endif
+    /** Returns the logger interface
+     *
+     *  @returns
+     *       The logger
+     */
     RtosLog* logger() { return &_logger; }
 
 private:
@@ -148,4 +177,3 @@
 };
 
 #endif
-