giomba
/
nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Tidy up \file & \author blocks under core/net/ipv6 

* Make these blocks appear in the respective module pages
* Re-word \file blocks to bring them up to speed with what each file actually does nowadays
This commit is contained in:
George Oikonomou 2015-02-15 19:02:07 +01:00
parent 06cfea692b
commit b0390e3e70
11 changed files with 70 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
core/net/ipv6/uip-ds6-nbr.c
View File

@ -29,20 +29,20 @@
*
*/
/**
* \addtogroup uip6
* @{
*/
/**
* \file
* IPv6 Neighbor cache (link-layer/IPv6 address mapping)
* IPv6 Neighbor cache (link-layer/IPv6 address mapping)
* \author Mathilde Durvy <mdurvy@cisco.com>
* \author Julien Abeille <jabeille@cisco.com>
* \author Simon Duquennoy <simonduq@sics.se>
*
*/
/**
* \addtogroup uip6
* @{
*/
#include <string.h>
#include <stdlib.h>
#include <stddef.h>

12
core/net/ipv6/uip-ds6-nbr.h
View File

@ -29,20 +29,20 @@
*
*/
/**
* \addtogroup uip6
* @{
*/
/**
* \file
* IPv6 Neighbor cache (link-layer/IPv6 address mapping)
* IPv6 Neighbor cache (link-layer/IPv6 address mapping)
* \author Mathilde Durvy <mdurvy@cisco.com>
* \author Julien Abeille <jabeille@cisco.com>
* \author Simon Duquennoy <simonduq@sics.se>
*
*/
/**
* \addtogroup uip6
* @{
*/
#ifndef UIP_DS6_NEIGHBOR_H_
#define UIP_DS6_NEIGHBOR_H_

10
core/net/ipv6/uip-ds6-route.c
View File

@ -29,6 +29,15 @@
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/**
* \addtogroup uip6
* @{
*/
/**
* \file
* Routing table manipulation
*/
#include "net/ipv6/uip-ds6.h"
#include "net/ip/uip.h"
@ -636,3 +645,4 @@ uip_ds6_defrt_periodic(void)
}
}
/*---------------------------------------------------------------------------*/
/** @} */

9
core/net/ipv6/uip-ds6-route.h
View File

@ -29,6 +29,14 @@
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/**
* \addtogroup uip6
* @{
*/
/**
* \file
* Header file for routing table manipulation
*/
#ifndef UIP_DS6_ROUTE_H
#define UIP_DS6_ROUTE_H
@ -158,3 +166,4 @@ uip_ds6_route_t *uip_ds6_route_next(uip_ds6_route_t *);
/** @} */
#endif /* UIP_DS6_ROUTE_H */
/** @} */

16
core/net/ipv6/uip-ds6.c
View File

@ -29,17 +29,17 @@
*/
/**
* \file
* IPv6 data structures handling functions.
* Comprises part of the Neighbor discovery (RFC 4861)
* and auto configuration (RFC 4862) state machines.
* \author Mathilde Durvy <mdurvy@cisco.com>
* \author Julien Abeille <jabeille@cisco.com>
* \addtogroup uip6
* @{
*/
/**
* \addtogroup uip6
* @{
* \file
* IPv6 data structure manipulation.
* Comprises part of the Neighbor discovery (RFC 4861)
* and auto configuration (RFC 4862) state machines.
* \author Mathilde Durvy <mdurvy@cisco.com>
* \author Julien Abeille <jabeille@cisco.com>
*/
#include <string.h>

2
core/net/ipv6/uip-ds6.h
View File

@ -5,7 +5,7 @@
/**
* \file
* Network interface and stateless autoconfiguration (RFC 4862)
* Header file for IPv6-related data structures
* \author Mathilde Durvy <mdurvy@cisco.com>
* \author Julien Abeille <jabeille@cisco.com>
*

12
core/net/ipv6/uip-icmp6.c
View File

@ -31,15 +31,15 @@
*/
/**
* \file
* ICMPv6 echo request and error messages (RFC 4443)
* \author Julien Abeille <jabeille@cisco.com>
* \author Mathilde Durvy <mdurvy@cisco.com>
* \addtogroup uip6
* @{
*/
/**
* \addtogroup uip6
* @{
* \file
* ICMPv6 (RFC 4443) implementation, with message and error handling
* \author Julien Abeille <jabeille@cisco.com>
* \author Mathilde Durvy <mdurvy@cisco.com>
*/
#include <string.h>

12
core/net/ipv6/uip-icmp6.h
View File

@ -31,15 +31,15 @@
*/
/**
* \file
* ICMPv6 echo request and error messages (RFC 4443)
* \author Julien Abeille <jabeille@cisco.com>
* \author Mathilde Durvy <mdurvy@cisco.com>
* \addtogroup uip6
* @{
*/
/**
* \addtogroup uip6
* @{
* \file
* Header file for ICMPv6 message and error handing (RFC 4443)
* \author Julien Abeille <jabeille@cisco.com>
* \author Mathilde Durvy <mdurvy@cisco.com>
*/
#ifndef ICMP6_H_

12
core/net/ipv6/uip-nd6.c
View File

@ -57,15 +57,15 @@
*/
/**
* \file
* Neighbor discovery (RFC 4861)
* \author Mathilde Durvy <mdurvy@cisco.com>
* \author Julien Abeille <jabeille@cisco.com>
* \addtogroup uip6
* @{
*/
/**
* \addtogroup uip6
* @{
* \file
* Neighbor discovery (RFC 4861)
* \author Mathilde Durvy <mdurvy@cisco.com>
* \author Julien Abeille <jabeille@cisco.com>
*/
#include <string.h>

12
core/net/ipv6/uip-nd6.h
View File

@ -31,15 +31,15 @@
*/
/**
* \file
* Neighbor discovery (RFC 4861)
* \author Julien Abeille <jabeille@cisco.com>
* \author Mathilde Durvy <mdurvy@cisco.com>
* \addtogroup uip6
* @{
*/
/**
* \addtogroup uip6
* @{
* \file
* Header file for IPv6 Neighbor discovery (RFC 4861)
* \author Julien Abeille <jabeille@cisco.com>
* \author Mathilde Durvy <mdurvy@cisco.com>
*/
#ifndef UIP_ND6_H_

12
core/net/ipv6/uip6.c
View File

@ -31,20 +31,20 @@
*
*/
/**
* \addtogroup uip6
* @{
*/
/**
* \file
* The uIP TCP/IPv6 stack code.
* The uIP TCP/IPv6 stack code.
*
* \author Adam Dunkels <adam@sics.se>
* \author Julien Abeille <jabeille@cisco.com> (IPv6 related code)
* \author Mathilde Durvy <mdurvy@cisco.com> (IPv6 related code)
*/
/**
* \addtogroup uip6
* @{
*/
/*
* uIP is a small implementation of the IP, UDP and TCP protocols (as
* well as some basic ICMP stuff). The implementation couples the IP,