Document IGMP and MLD6 API in doxygen module style

This commit is contained in:
Dirk Ziegelmeier
2016-07-26 18:20:30 +02:00
parent dc0859b8d1
commit 67d674a59c
5 changed files with 30 additions and 9 deletions

View File

@@ -64,6 +64,7 @@
/**
* @defgroup autoip AUTOIP
* @ingroup ip4
* AUTOIP related functions
* @see netifapi_autoip
*/

View File

@@ -67,6 +67,7 @@
/**
* @defgroup dhcp4 DHCPv4
* @ingroup ip4
* DHCP (IPv4) related functions
* @see netifapi_dhcp4
*/

View File

@@ -38,6 +38,12 @@
* source code.
*/
/**
* @defgroup igmp IGMP
* @ingroup ip4
* To be called from TCPIP thread
*/
/*-------------------------------------------------------------
Note 1)
Although the rfc requires V1 AND V2 capability
@@ -477,6 +483,7 @@ igmp_input(struct pbuf *p, struct netif *inp, const ip4_addr_t *dest)
}
/**
* @ingroup igmp
* Join a group on one network interface.
*
* @param ifaddr ip address of the network interface which should join a new group
@@ -513,6 +520,7 @@ igmp_joingroup(const ip4_addr_t *ifaddr, const ip4_addr_t *groupaddr)
}
/**
* @ingroup igmp
* Join a group on one network interface.
*
* @param netif the network interface which should join a new group
@@ -571,6 +579,7 @@ igmp_joingroup_netif(struct netif *netif, const ip4_addr_t *groupaddr)
}
/**
* @ingroup igmp
* Leave a group on one network interface.
*
* @param ifaddr ip address of the network interface which should leave a group
@@ -606,6 +615,7 @@ igmp_leavegroup(const ip4_addr_t *ifaddr, const ip4_addr_t *groupaddr)
}
/**
* @ingroup igmp
* Leave a group on one network interface.
*
* @param netif the network interface which should leave a group