Gordon Craig / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

Diff: drivers/RawSerial.h

Revision:
167:e84263d55307
Parent:
149:156823d33999
Child:
168:9672193075cf
--- a/drivers/RawSerial.h	Thu Jun 08 15:02:37 2017 +0100
+++ b/drivers/RawSerial.h	Wed Jun 21 17:46:44 2017 +0100
@@ -18,14 +18,13 @@
 
 #include "platform/platform.h"
 
-#if DEVICE_SERIAL
+#if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY)
 
 #include "drivers/SerialBase.h"
 #include "hal/serial_api.h"
 
 namespace mbed {
 /** \addtogroup drivers */
-/** @{*/
 
 /** A serial port (UART) for communication with other serial devices
  * This is a variation of the Serial class that doesn't use streams,
@@ -34,7 +33,7 @@
  * Can be used for Full Duplex communication, or Simplex by specifying
  * one pin as NC (Not Connected)
  *
- * @Note Synchronization level: Not protected
+ * @note Synchronization level: Not protected
  *
  * Example:
  * @code
@@ -48,6 +47,7 @@
  *     pc.putc('A');
  * }
  * @endcode
+ * @ingroup drivers
  */
 class RawSerial: public SerialBase {
 
@@ -89,11 +89,11 @@
 
 protected:
 
-    /** Acquire exclusive access to this serial port
+    /* Acquire exclusive access to this serial port
      */
     virtual void lock(void);
 
-    /** Release exclusive access to this serial port
+    /* Release exclusive access to this serial port
      */
     virtual void unlock(void);
 };
@@ -103,5 +103,3 @@
 #endif
 
 #endif
-
-/** @}*/