Minor: Documentation updates

This commit is contained in:
Dirk Ziegelmeier 2016-09-27 21:18:03 +02:00
parent 6abcd00f71
commit 5d811d799c
3 changed files with 7 additions and 3 deletions

View File

@ -49,7 +49,7 @@
* Porting: implement all functions in @ref sys_time and @ref sys_prot.\n * Porting: implement all functions in @ref sys_time and @ref sys_prot.\n
* You can only use @ref callbackstyle_api in this mode.\n * You can only use @ref callbackstyle_api in this mode.\n
* Sample code:\n * Sample code:\n
* @verbinclude NO_SYS_SampleCode.c * @include NO_SYS_SampleCode.c
*/ */
/** /**

View File

@ -99,7 +99,9 @@ err_t igmp_leavegroup(const ip4_addr_t *ifaddr, const ip4_addr_t *groupaddr);
err_t igmp_leavegroup_netif(struct netif *netif, const ip4_addr_t *groupaddr); err_t igmp_leavegroup_netif(struct netif *netif, const ip4_addr_t *groupaddr);
void igmp_tmr(void); void igmp_tmr(void);
/* Get list of IGMP groups for netif */ /** @ingroup igmp
* Get list head of IGMP groups for netif
*/
#define netif_igmp_data(netif) ((struct igmp_group *)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_IGMP)) #define netif_igmp_data(netif) ((struct igmp_group *)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_IGMP))
#ifdef __cplusplus #ifdef __cplusplus

View File

@ -82,7 +82,9 @@ err_t mld6_joingroup_netif(struct netif *netif, const ip6_addr_t *groupaddr);
err_t mld6_leavegroup(const ip6_addr_t *srcaddr, const ip6_addr_t *groupaddr); err_t mld6_leavegroup(const ip6_addr_t *srcaddr, const ip6_addr_t *groupaddr);
err_t mld6_leavegroup_netif(struct netif *netif, const ip6_addr_t *groupaddr); err_t mld6_leavegroup_netif(struct netif *netif, const ip6_addr_t *groupaddr);
/* Get list of MLD6 groups for netif */ /** @ingroup mld6
* Get list head of MLD6 groups for netif
*/
#define netif_mld6_data(netif) ((struct mld_group *)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_MLD6)) #define netif_mld6_data(netif) ((struct mld_group *)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_MLD6))
#ifdef __cplusplus #ifdef __cplusplus