RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #13725 from miri64/gnrc_netif/doc/out-params

Browse Source 
gnrc_netif: document new *_create() out parameter as such
This commit is contained in:
José Alamos 2020-03-26 15:21:06 +01:00 committed by GitHub
commit 18c4cfe2ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cpu/esp_common/esp-now/esp_now_gnrc.h
View File

@ -27,7 +27,7 @@ extern "C" {
/**
* @brief Creates the ESP-NOW network interface
* @see gnrc_netif_create
* @param [in] netif The interface. May not be `NULL`.
* @param [out] netif The interface. May not be `NULL`.
* @param [in] stack The stack for the network interface's thread.
* @param [in] stacksize Size of stack.
* @param [in] priority Priority for the network interface's thread.

2
drivers/include/cc1xxx_common.h
View File

@ -115,7 +115,7 @@ typedef struct netdev_radio_rx_info cc1xxx_rx_info_t;
/**
* @brief Creates a CC110x/CC1200 network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the network interface's thread.

2
drivers/xbee/include/gnrc_netif_xbee.h
View File

@ -27,7 +27,7 @@ extern "C" {
/**
* @brief Creates an Xbee network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the network interface's thread.

2
sys/include/net/gnrc/gomach/gomach.h
View File

@ -354,7 +354,7 @@ extern "C" {
/**
* @brief Creates an IEEE 802.15.4 GoMacH network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the GoMacH network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the GoMacH network interface's thread.

2
sys/include/net/gnrc/lwmac/lwmac.h
View File

@ -300,7 +300,7 @@ extern "C" {
/**
* @brief Creates an IEEE 802.15.4 LWMAC network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the LWMAC network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the LWMAC network interface's thread.

2
sys/include/net/gnrc/netif.h
View File

@ -246,7 +246,7 @@ void gnrc_netif_init_devs(void);
/**
* @brief Creates a network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the network interface's thread.

2
sys/include/net/gnrc/netif/ethernet.h
View File

@ -27,7 +27,7 @@ extern "C" {
/**
* @brief Creates an Ethernet network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the network interface's thread.

2
sys/include/net/gnrc/netif/ieee802154.h
View File

@ -27,7 +27,7 @@ extern "C" {
/**
* @brief Creates an IEEE 802.15.4 network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the network interface's thread.

2
sys/include/net/gnrc/netif/lorawan_base.h
View File

@ -27,7 +27,7 @@ extern "C" {
/**
* @brief Creates a raw network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the network interface's thread.

2
sys/include/net/gnrc/netif/raw.h
View File

@ -28,7 +28,7 @@ extern "C" {
/**
* @brief Creates a raw network interface
*
* @param[in] netif The interface. May not be `NULL`.
* @param[out] netif The interface. May not be `NULL`.
* @param[in] stack The stack for the network interface's thread.
* @param[in] stacksize Size of @p stack.
* @param[in] priority Priority for the network interface's thread.