deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Tidy-up multicast documentation

Browse source 
* Create a doxygen group and add files to it, so that documents appear as modules rather than simply under files
* Document plenty of functions, macros, constants, data types which were previously undocumented
* Re-structure some doxygen comments to improve structure and readability
This commit is contained in:
George Oikonomou 2015-02-15 19:16:16 +01:00
parent a4e7cc29e8
commit 5efb3f0769
10 changed files with 203 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

25
core/net/ipv6/multicast/uip-mcast6.h
View file

@ -30,9 +30,11 @@
*/
/**
* \file
* This header file contains configuration directives for uIPv6
* multicast support.
* \addtogroup uip6
* @{
*/
/**
* \defgroup uip6-multicast IPv6 Multicast Forwarding
*
* We currently support 2 engines:
* - 'Stateless Multicast RPL Forwarding' (SMRF)
@ -42,6 +44,14 @@
* in the internet draft:
* http://tools.ietf.org/html/draft-ietf-roll-trickle-mcast
*
* @{
*/
/**
* \file
* This header file contains configuration directives for uIPv6
* multicast support.
*
* \author
* George Oikonomou - <oikonomou@users.sourceforge.net>
*/
@ -83,7 +93,11 @@
* Multicast API. Similar to NETSTACK, each engine must define a driver and
* populate the fields with suitable function pointers
*/
/**
* \brief The data structure used to represent a multicast engine
*/
struct uip_mcast6_driver {
/** The driver's name */
char *name;
/** Initialize the multicast engine */
@ -110,6 +124,7 @@ struct uip_mcast6_driver {
*
* \return 0: Drop, 1: Deliver
*
*
* When a datagram with a multicast destination address is received,
* the forwarding logic in core is bypassed. Instead, we let the
* multicast engine handle forwarding internally if and as necessary.
@ -158,5 +173,7 @@ extern const struct uip_mcast6_driver UIP_MCAST6;
#error "Check the value of UIP_CONF_IPV6_RPL in conf files."
#endif
/*---------------------------------------------------------------------------*/
#endif /* UIP_MCAST6_H_ */
/*---------------------------------------------------------------------------*/
/** @} */
/** @} */