Fix doxygen warnings in the uip6 group

This commit is contained in:
George Oikonomou 2015-02-15 20:08:57 +01:00
parent b0390e3e70
commit c8b802dc16
2 changed files with 32 additions and 11 deletions

View file

@ -105,7 +105,10 @@ struct uip_stats uip_stat;
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @{ \name Layer 2 variables */ /**
* \name Layer 2 variables
* @{
*/
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** Host L2 address */ /** Host L2 address */
#if UIP_CONF_LL_802154 #if UIP_CONF_LL_802154
@ -116,7 +119,10 @@ uip_lladdr_t uip_lladdr = {{0x00,0x06,0x98,0x00,0x02,0x32}};
/** @} */ /** @} */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @{ \name Layer 3 variables */ /**
* \name Layer 3 variables
* @{
*/
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** /**
* \brief Type of the next header in IPv6 header or extension headers * \brief Type of the next header in IPv6 header or extension headers
@ -141,8 +147,9 @@ uint8_t uip_ext_opt_offset = 0;
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/* Buffers */ /* Buffers */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** \name Buffer defines /**
* @{ * \name Buffer defines
* @{
*/ */
#define FBUF ((struct uip_tcpip_hdr *)&uip_reassbuf[0]) #define FBUF ((struct uip_tcpip_hdr *)&uip_reassbuf[0])
#define UIP_IP_BUF ((struct uip_ip_hdr *)&uip_buf[UIP_LLH_LEN]) #define UIP_IP_BUF ((struct uip_ip_hdr *)&uip_buf[UIP_LLH_LEN])
@ -161,8 +168,9 @@ uint8_t uip_ext_opt_offset = 0;
#endif /* UIP_CONF_IPV6_RPL */ #endif /* UIP_CONF_IPV6_RPL */
#define UIP_ICMP6_ERROR_BUF ((struct uip_icmp6_error *)&uip_buf[uip_l2_l3_icmp_hdr_len]) #define UIP_ICMP6_ERROR_BUF ((struct uip_icmp6_error *)&uip_buf[uip_l2_l3_icmp_hdr_len])
/** @} */ /** @} */
/** \name Buffer variables /**
* @{ * \name Buffer variables
* @{
*/ */
/** Packet buffer for incoming and outgoing packets */ /** Packet buffer for incoming and outgoing packets */
#ifndef UIP_CONF_EXTERNAL_BUFFER #ifndef UIP_CONF_EXTERNAL_BUFFER
@ -185,7 +193,10 @@ uint16_t uip_len, uip_slen;
/** @} */ /** @} */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @{ \name General variables */ /**
* \name General variables
* @{
*/
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/* The uip_flags variable is used for communication between the TCP/IP stack /* The uip_flags variable is used for communication between the TCP/IP stack
@ -209,7 +220,8 @@ static uint16_t lastport;
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/* TCP */ /* TCP */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** \name TCP defines /**
* \name TCP defines
*@{ *@{
*/ */
/* Structures and definitions. */ /* Structures and definitions. */
@ -227,7 +239,8 @@ static uint16_t lastport;
#define TCP_OPT_MSS_LEN 4 /* Length of TCP MSS option. */ #define TCP_OPT_MSS_LEN 4 /* Length of TCP MSS option. */
/** @} */ /** @} */
/** \name TCP variables /**
* \name TCP variables
*@{ *@{
*/ */
#if UIP_TCP #if UIP_TCP
@ -248,7 +261,10 @@ static uint16_t tmp16;
/** @} */ /** @} */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @{ \name UDP variables */ /**
* \name UDP variables
* @{
*/
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
#if UIP_UDP #if UIP_UDP
struct uip_udp_conn *uip_udp_conn; struct uip_udp_conn *uip_udp_conn;
@ -257,7 +273,10 @@ struct uip_udp_conn uip_udp_conns[UIP_UDP_CONNS];
/** @} */ /** @} */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @{ \name ICMPv6 variables */ /**
* \name ICMPv6 variables
* @{
*/
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
#if UIP_CONF_ICMP6 #if UIP_CONF_ICMP6
/** single possible icmpv6 "connection" */ /** single possible icmpv6 "connection" */

View file

@ -377,5 +377,7 @@ We pass all the tests for phase 2 except:
<HR> <HR>
@{
*/ */
/** @} */ /** @} */
/** @} */