The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
Diff: drivers/Ethernet.h
- Revision:
- 145:64910690c574
- Parent:
- 128:9bcdf88f62b0
- Child:
- 146:22da6e220af6
--- a/drivers/Ethernet.h Thu Jun 08 14:53:05 2017 +0100 +++ b/drivers/Ethernet.h Wed Jun 21 17:31:38 2017 +0100 @@ -18,15 +18,14 @@ #include "platform/platform.h" -#if DEVICE_ETHERNET +#if defined (DEVICE_ETHERNET) || defined(DOXYGEN_ONLY) namespace mbed { /** \addtogroup drivers */ -/** @{*/ /** An ethernet interface, to use with the ethernet pins. * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected * * Example: * @code @@ -53,6 +52,7 @@ * } * } * @endcode + * @ingroup drivers */ class Ethernet { @@ -111,15 +111,16 @@ /** Read from an recevied ethernet packet. * - * After receive returnd a number bigger than 0it is + * After receive returned a number bigger than 0 it is * possible to read bytes from this packet. - * Read will write up to size bytes into data. * - * It is possible to use read multible times. + * @param data Pointer to data packet + * @param size Size of data to be read. + * @returns The number of byte read. + * + * @note It is possible to use read multiple times. * Each time read will start reading after the last read byte before. * - * @returns - * The number of byte read. */ int read(char *data, int size); @@ -172,5 +173,3 @@ #endif #endif - -/** @}*/