riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

netopt: update doc of NETOPT_LINK

Browse Source
This commit is contained in:
Jose Alamos 2019-10-29 15:54:13 +01:00
parent 43a5fdc870
commit 6beec0a4f6
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
sys/include/net/netopt.h
View File

@ -295,14 +295,11 @@ typedef enum {
NETOPT_AUTOCCA,
/**
* @brief (@ref netopt_enable_t) Phy link status.
* @brief (@ref netopt_enable_t) network interface link status.
*
* Returns NETOPT_ENABLE when the the link of the interface is up,
* NETOPT_DISABLE when the link is down. If the interface is wireless or
* doesn't support link status detection this function will return
* -ENOTSUP.
* This option is used to set or check the link status (up or down).
*
* @note Setting this option will always return -ENOTSUP.
* @note On error this option should return a negative number.
*/
NETOPT_LINK,