forked
Diff: drivers/PortOut.h
- Revision:
- 167:e84263d55307
- Parent:
- 160:d5399cc887bb
--- a/drivers/PortOut.h Thu Jun 08 15:02:37 2017 +0100 +++ b/drivers/PortOut.h Wed Jun 21 17:46:44 2017 +0100 @@ -18,17 +18,16 @@ #include "platform/platform.h" -#if DEVICE_PORTOUT +#if defined (DEVICE_PORTOUT) || defined(DOXYGEN_ONLY) #include "hal/port_api.h" #include "platform/mbed_critical.h" namespace mbed { /** \addtogroup drivers */ -/** @{*/ /** A multiple pin digital out * - * @Note Synchronization level: Interrupt safe + * @note Synchronization level: Interrupt safe * * Example: * @code @@ -50,6 +49,7 @@ * } * } * @endcode + * @ingroup drivers */ class PortOut { public: @@ -83,18 +83,23 @@ } /** A shorthand for write() + * \sa PortOut::write() */ PortOut& operator= (int value) { write(value); return *this; } + /** A shorthand for read() + * \sa PortOut::read() + */ PortOut& operator= (PortOut& rhs) { write(rhs.read()); return *this; } /** A shorthand for read() + * \sa PortOut::read() */ operator int() { return read(); @@ -109,5 +114,3 @@ #endif #endif - -/** @}*/