ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Mark Ethernet.h methods as Deprecated in Doxygen documentation (#11146)

pull/11073/head
Hugues Kamba 2019-08-01 11:39:36 +01:00 committed by Evelyne Donnaes
parent f0f408b2d8
commit df85e8e233
1 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
drivers/Ethernet.h
View File

@ -75,12 +75,16 @@ class
public: public:
/** Initialize the ethernet interface. /**
* @deprecated
* Initialize the ethernet interface.
*/ */
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.") MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
Ethernet(); Ethernet();
/** Powers the hardware down. /**
* @deprecated
* Powers the hardware down.
*/ */
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.") MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
virtual ~Ethernet(); virtual ~Ethernet();
@ -93,7 +97,9 @@ public:
FullDuplex100 FullDuplex100
}; };
/** Writes into an outgoing ethernet packet. /**
* @deprecated
* Writes into an outgoing ethernet packet.
* *
* It will append size bytes of data to the previously written bytes. * It will append size bytes of data to the previously written bytes.
* *
@ -106,7 +112,9 @@ public:
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.") MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int write(const char *data, int size); int write(const char *data, int size);
/** Send an outgoing ethernet packet. /**
* @deprecated
* Send an outgoing ethernet packet.
* *
* After filling in the data in an ethernet packet it must be send. * After filling in the data in an ethernet packet it must be send.
* Send will provide a new packet to write to. * Send will provide a new packet to write to.
@ -118,7 +126,9 @@ public:
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.") MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int send(); int send();
/** Receives an arrived ethernet packet. /**
* @deprecated
* Receives an arrived ethernet packet.
* *
* Receiving an ethernet packet will drop the last received ethernet packet * Receiving an ethernet packet will drop the last received ethernet packet
* and make a new ethernet packet ready to read. * and make a new ethernet packet ready to read.
@ -131,7 +141,9 @@ public:
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.") MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int receive(); int receive();
/** Read from an received ethernet packet. /**
* @deprecated
* Read from an received ethernet packet.
* *
* After receive returned a number bigger than 0 it is * After receive returned a number bigger than 0 it is
* possible to read bytes from this packet. * possible to read bytes from this packet.
@ -147,14 +159,18 @@ public:
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.") MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int read(char *data, int size); int read(char *data, int size);
/** Gives the ethernet address of the mbed. /**
* @deprecated
* Gives the ethernet address of the mbed.
* *
* @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in. * @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in.
*/ */
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.") MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
void address(char *mac); void address(char *mac);
/** Returns if an ethernet link is present or not. It takes a while after Ethernet initialization to show up. /**
* @deprecated
* Returns if an ethernet link is present or not. It takes a while after Ethernet initialization to show up.
* *
* @returns * @returns
* 0 if no ethernet link is present, * 0 if no ethernet link is present,
@ -180,7 +196,9 @@ public:
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.") MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int link(); int link();
/** Sets the speed and duplex parameters of an ethernet link /**
* @deprecated
* Sets the speed and duplex parameters of an ethernet link
* *
* - AutoNegotiate Auto negotiate speed and duplex * - AutoNegotiate Auto negotiate speed and duplex
* - HalfDuplex10 10 Mbit, half duplex * - HalfDuplex10 10 Mbit, half duplex