test
Fork of mbed-dev by
Diff: drivers/SerialBase.h
- Revision:
- 168:e84263d55307
- Parent:
- 160:d5399cc887bb
- Child:
- 169:9672193075cf
diff -r c97ed07ec1a8 -r e84263d55307 drivers/SerialBase.h --- a/drivers/SerialBase.h Thu Jun 08 15:02:37 2017 +0100 +++ b/drivers/SerialBase.h Wed Jun 21 17:46:44 2017 +0100 @@ -18,9 +18,8 @@ #include "platform/platform.h" -#if DEVICE_SERIAL +#if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY) -#include "Stream.h" #include "Callback.h" #include "serial_api.h" #include "mbed_toolchain.h" @@ -32,12 +31,12 @@ namespace mbed { /** \addtogroup drivers */ -/** @{*/ /** A base class for serial port implementations * Can't be instantiated directly (use Serial or RawSerial) * - * @Note Synchronization level: Set by subclass + * @note Synchronization level: Set by subclass + * @ingroup drivers */ class SerialBase { @@ -74,7 +73,7 @@ * * @param bits The number of bits in a word (5-8; default = 8) * @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None) - * @param stop The number of stop bits (1 or 2; default = 1) + * @param stop_bits The number of stop bits (1 or 2; default = 1) */ void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1); @@ -258,5 +257,3 @@ #endif #endif - -/** @}*/