mbed

Fork of mbed-dev by mbed official

Revision:
167:e84263d55307
Parent:
160:d5399cc887bb
diff -r c97ed07ec1a8 -r e84263d55307 drivers/DigitalIn.h
--- a/drivers/DigitalIn.h	Thu Jun 08 15:02:37 2017 +0100
+++ b/drivers/DigitalIn.h	Wed Jun 21 17:46:44 2017 +0100
@@ -23,11 +23,10 @@
 
 namespace mbed {
 /** \addtogroup drivers */
-/** @{*/
 
 /** A digital input, used for reading the state of a pin
  *
- * @Note Synchronization level: Interrupt safe
+ * @note Synchronization level: Interrupt safe
  *
  * Example:
  * @code
@@ -47,6 +46,7 @@
  *     }
  * }
  * @endcode
+ * @ingroup drivers
  */
 class DigitalIn {
 
@@ -82,7 +82,7 @@
 
     /** Set the input pin mode
      *
-     *  @param mode PullUp, PullDown, PullNone, OpenDrain
+     *  @param pull PullUp, PullDown, PullNone, OpenDrain
      */
     void mode(PinMode pull) {
         core_util_critical_section_enter();
@@ -102,6 +102,7 @@
     }
 
     /** An operator shorthand for read()
+     * \sa DigitalIn::read()
      */
     operator int() {
         // Underlying read is thread safe
@@ -115,5 +116,3 @@
 } // namespace mbed
 
 #endif
-
-/** @}*/