From 465631f83cd5e4bfd5f94241a7b71aa01390c649 Mon Sep 17 00:00:00 2001
From: Martine Lenders <mail@martine-lenders.eu>
Date: Fri, 30 Nov 2018 09:02:05 +0100
Subject: [PATCH] gnrc_netif: doc-group device-type based functions
---
sys/include/net/gnrc/netif/internal.h | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/sys/include/net/gnrc/netif/internal.h b/sys/include/net/gnrc/netif/internal.h
index 22e31ed08c..3e71290602 100644
--- a/sys/include/net/gnrc/netif/internal.h
+++ b/sys/include/net/gnrc/netif/internal.h
@@ -403,6 +403,17 @@ static inline bool gnrc_netif_is_6lbr(const gnrc_netif_t *netif)
#define gnrc_netif_is_6lbr(netif) (false)
#endif
+/**
+ * @name Device type based function
+ *
+ * These functions' behavior is based around the gnrc_netif_t::device_type of
+ * an interface.
+ *
+ * @attention Special care needs to be taken for those functions when porting
+ * a new network device type or link-layer protocol: They might
+ * need adaptions for your port
+ * @{
+ */
#if defined(MODULE_GNRC_IPV6) || defined(DOXYGEN)
/**
* @brief Converts a given hardware address to an IPv6 IID.
@@ -489,6 +500,7 @@ static inline int gnrc_netif_ipv6_get_iid(gnrc_netif_t *netif, eui64_t *iid)
#define gnrc_netif_ipv6_iid_to_addr(netif, iid, addr) (-ENOTSUP)
#define gnrc_netif_ipv6_get_iid(netif, iid) (-ENOTSUP)
#endif /* defined(MODULE_GNRC_IPV6) || defined(DOXYGEN) */
+/** @} */
#ifdef __cplusplus
}
--
GitLab