From 62d48d5bf307f25852b80bc1066e284e727a158a Mon Sep 17 00:00:00 2001 From: "Martine S. Lenders" Date: Thu, 26 Mar 2020 14:37:44 +0100 Subject: [PATCH] gnrc_netif: document new *_create() out parameter as such --- cpu/esp_common/esp-now/esp_now_gnrc.h | 2 +- drivers/include/cc1xxx_common.h | 2 +- drivers/xbee/include/gnrc_netif_xbee.h | 2 +- sys/include/net/gnrc/gomach/gomach.h | 2 +- sys/include/net/gnrc/lwmac/lwmac.h | 2 +- sys/include/net/gnrc/netif.h | 2 +- sys/include/net/gnrc/netif/ethernet.h | 2 +- sys/include/net/gnrc/netif/ieee802154.h | 2 +- sys/include/net/gnrc/netif/lorawan_base.h | 2 +- sys/include/net/gnrc/netif/raw.h | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/cpu/esp_common/esp-now/esp_now_gnrc.h b/cpu/esp_common/esp-now/esp_now_gnrc.h index fab28de7fd..4376c679ba 100644 --- a/cpu/esp_common/esp-now/esp_now_gnrc.h +++ b/cpu/esp_common/esp-now/esp_now_gnrc.h @@ -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. diff --git a/drivers/include/cc1xxx_common.h b/drivers/include/cc1xxx_common.h index 238444bf39..47eab5faee 100644 --- a/drivers/include/cc1xxx_common.h +++ b/drivers/include/cc1xxx_common.h @@ -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. diff --git a/drivers/xbee/include/gnrc_netif_xbee.h b/drivers/xbee/include/gnrc_netif_xbee.h index b881c9889c..ea874fdcd7 100644 --- a/drivers/xbee/include/gnrc_netif_xbee.h +++ b/drivers/xbee/include/gnrc_netif_xbee.h @@ -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. diff --git a/sys/include/net/gnrc/gomach/gomach.h b/sys/include/net/gnrc/gomach/gomach.h index de0b37ce4f..dac407a2b7 100644 --- a/sys/include/net/gnrc/gomach/gomach.h +++ b/sys/include/net/gnrc/gomach/gomach.h @@ -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. diff --git a/sys/include/net/gnrc/lwmac/lwmac.h b/sys/include/net/gnrc/lwmac/lwmac.h index 3b3026501b..3799708e9a 100644 --- a/sys/include/net/gnrc/lwmac/lwmac.h +++ b/sys/include/net/gnrc/lwmac/lwmac.h @@ -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. diff --git a/sys/include/net/gnrc/netif.h b/sys/include/net/gnrc/netif.h index ac31a51710..fff5b18ac6 100644 --- a/sys/include/net/gnrc/netif.h +++ b/sys/include/net/gnrc/netif.h @@ -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. diff --git a/sys/include/net/gnrc/netif/ethernet.h b/sys/include/net/gnrc/netif/ethernet.h index 49eb400b1d..d4350e2cb9 100644 --- a/sys/include/net/gnrc/netif/ethernet.h +++ b/sys/include/net/gnrc/netif/ethernet.h @@ -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. diff --git a/sys/include/net/gnrc/netif/ieee802154.h b/sys/include/net/gnrc/netif/ieee802154.h index c9e8c34d9b..c6976597c5 100644 --- a/sys/include/net/gnrc/netif/ieee802154.h +++ b/sys/include/net/gnrc/netif/ieee802154.h @@ -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. diff --git a/sys/include/net/gnrc/netif/lorawan_base.h b/sys/include/net/gnrc/netif/lorawan_base.h index 2fb48b5abf..cc56ce5e30 100644 --- a/sys/include/net/gnrc/netif/lorawan_base.h +++ b/sys/include/net/gnrc/netif/lorawan_base.h @@ -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. diff --git a/sys/include/net/gnrc/netif/raw.h b/sys/include/net/gnrc/netif/raw.h index 761d11fb70..870838be9a 100644 --- a/sys/include/net/gnrc/netif/raw.h +++ b/sys/include/net/gnrc/netif/raw.h @@ -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.