riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #3676 from authmillenon/doc/fix/net

Browse Source 
doc: fix and update net and net_gnrc documentation
This commit is contained in:
Andreas "Paul" Pauli 2015-08-25 18:48:01 +02:00
commit 8855f593e2
25 changed files with 59 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sys/include/net/ethernet.h
View File

@ -9,7 +9,7 @@
/**
* @defgroup net_ethernet Ethernet
* @ingroup net
* @brief Ethernet implementation
* @brief Provides Ethernet header and helper functions
* @{
*
* @file

2
sys/include/net/gnrc.h
View File

@ -13,7 +13,7 @@
* @{
*
* @file
* @brief Pseudo header that includes all gnrc network stack base modules
* @brief Includes all essential GNRC network stack base modules
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/

8
sys/include/net/gnrc/icmpv6.h
View File

@ -7,9 +7,9 @@
*/
/**
* @defgroup net_gnrc__icmpv6 Internet Control Message Protocol for IPv6
* @ingroup net_gnrc__ipv6
* @brief Basic implementation of ICMPv6
* @defgroup net_gnrc_icmpv6 ICMPv6
* @ingroup net_gnrc_ipv6
* @brief GNRC's implementation of ICMPv6
*
* @see <a href="https://tools.ietf.org/html/rfc4443">
* RFC 4443
@ -17,7 +17,7 @@
* @{
*
* @file
* @brief Definitions for ICMPv6
* @brief Definitions for GNRC's ICMPv6 implementation
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*

6
sys/include/net/gnrc/ipv6.h
View File

@ -8,8 +8,8 @@
/**
* @defgroup net_gnrc_ipv6 IPv6
* @ingroup net
* @brief New IPv6 implementation
* @ingroup net_gnrc
* @brief GNRC's IPv6 implementation
*
* The IPv6 control thread understands messages of type
*
@ -19,7 +19,7 @@
* @{
*
* @file
* @brief Definitions for IPv6
* @brief Definitions for GNRC's IPv6 implementation
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/

4
sys/include/net/gnrc/ndp.h
View File

@ -9,11 +9,11 @@
/**
* @defgroup net_gnrc_ndp IPv6 Neighbor discovery
* @ingroup net_gnrc_icmpv6
* @brief IPv6 Neighbor Discovery Implementation
* @brief GNRC's IPv6 Neighbor Discovery implementation
* @{
*
* @file
* @brief Neighbor Discovery definitions
* @brief Definitions for GNRC's IPv6 Neighbor Discovery
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/

8
sys/include/net/gnrc/netapi.h
View File

@ -7,9 +7,9 @@
*/
/**
* @defgroup net_gnrc_netapi Generic network module interface
* @ingroup net
* @brief Generic interface for IPC communication between network modules
* @defgroup net_gnrc_netapi GNRC communication interface
* @ingroup net_gnrc
* @brief Generic interface for IPC communication between GNRC modules
*
* @details The idea of this interface is that it provides every network
* module with a basic set of commands to communicate with its
@ -19,7 +19,7 @@
* @{
*
* @file
* @brief Generic interface to communicate with network modules
* @brief Generic interface to communicate with GNRC modules
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>

3
sys/include/net/gnrc/netdev.h
View File

@ -9,7 +9,8 @@
/**
* @defgroup net_gnrc_netdev Network device driver interface
* @ingroup net
* @ingroup net_gnrc
* @brief Common network device interface
* @{
*
* @file

7
sys/include/net/gnrc/netdev_eth.h
View File

@ -9,11 +9,10 @@
*/
/**
* @defgroup gnrc_netdev_eth dev_eth ethernet interface as netdev device.
* @ingroup net
* @defgroup net_gnrc_netdev_eth dev_eth as netdev device.
* @ingroup net_gnrc_netdev
*
* @brief Allows for usage of dev_eth ethernet interfaces as ethernet netdev
* devices.
* @brief Allows for usage of @p dev_eth as ethernet netdev devices.
*
* @{
*

8
sys/include/net/gnrc/netif.h
View File

@ -8,16 +8,16 @@
/**
* @defgroup net_gnrc_netif Network interfaces
* @ingroup net
* @brief Abstraction layer for network interfaces
* @ingroup net_gnrc
* @brief Abstraction layer for GNRC's network interfaces
*
* Network interfaces in this context are threads for protocols that are
* Network interfaces in the context of GNRC are threads for protocols that are
* below the network layer.
*
* @{
*
* @file
* @brief Definitions for network interfaces
* @brief Definitions for GNRC's network interfaces
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/

3
sys/include/net/gnrc/netreg.h
View File

@ -8,7 +8,8 @@
/**
* @defgroup net_gnrc_netreg Network protocol registry
* @ingroup net
* @ingroup net_gnrc
* @brief Registry to receive messages of a specified protocol type by GNRC.
* @{
*
* @file

11
sys/include/net/gnrc/nettype.h
View File

@ -8,10 +8,13 @@
/**
* @defgroup net_gnrc_nettype Protocol type
* @ingroup net
* @brief Protocol type definitions to be used with the @ref net_gnrc_netapi,
* the @ref net_gnrc_netdev, the @ref net_gnrc_netreg, and
* the @ref net_gnrc_pkt
* @ingroup net_gnrc
* @brief Protocol type definitions and helper functions
*
* The protocol types are used with the @ref net_gnrc_netapi, the @ref net_gnrc_netdev,
* the @ref net_gnrc_netreg, and the @ref net_gnrc_pkt to identify network protocols
* throughout the network stack.
*
* @{
*
* @file

4
sys/include/net/gnrc/nomac.h
View File

@ -7,8 +7,8 @@
*/
/**
* @defgroup net_nomac Simplest possible MAC layer
* @ingroup net
* @defgroup net_gnrc_nomac Simplest possible MAC layer
* @ingroup net_gnrc
* @brief Simplest possible MAC protocol that sends without considering
* the state of the medium
* @{

8
sys/include/net/gnrc/pkt.h
View File

@ -8,13 +8,13 @@
*/
/**
* @defgroup net_gnrc_pkt Packet
* @brief Network packet abstraction types
* @ingroup net
* @defgroup net_gnrc_pkt Packets
* @ingroup net_gnrc_pktbuf
* @brief Network packet abstraction type and helper functions
* @{
*
* @file
* @brief General definitions for network packets
* @brief General definitions for network packets and their helper functions
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>

2
sys/include/net/gnrc/pktbuf.h
View File

@ -9,7 +9,7 @@
/**
* @defgroup net_gnrc_pktbuf Packet buffer
* @ingroup net
* @ingroup net_gnrc
* @brief A global network packet buffer.
*
* @note **WARNING!!** Do not store data structures that are not packed

4
sys/include/net/gnrc/pktdump.h
View File

@ -7,8 +7,8 @@
*/
/**
* @defgroup net_pktdump Dump Network Packets
* @ingroup net
* @defgroup net_gnrc_pktdump Dump Network Packets
* @ingroup net_gnrc
* @brief Dump network packets to STDOUT for debugging
*
* @{

2
sys/include/net/gnrc/pktqueue.h
View File

@ -8,8 +8,8 @@
/**
* @defgroup net_gnrc_pktqueue Packet Queue
* @ingroup net_gnrc
* @brief Packet wrapper for the Priority Queue
* @ingroup net
* @{
*
* @file

5
sys/include/net/gnrc/rpl.h
View File

@ -9,8 +9,9 @@
*/
/**
* @defgroup net_gnrc_rpl New RPL
* @ingroup net
* @defgroup net_gnrc_rpl RPL
* @ingroup net_gnrc
* @brief RPL implementation for GNRC
* @{
*
* @file

4
sys/include/net/gnrc/sixlowpan.h
View File

@ -8,8 +8,8 @@
/**
* @defgroup net_gnrc_sixlowpan 6LoWPAN
* @ingroup net
* @brief 6LoWPAN implementation
* @ingroup net_gnrc
* @brief GNRC's 6LoWPAN implementation
* @{
*
* @file

3
sys/include/net/gnrc/sixlowpan/ctx.h
View File

@ -7,9 +7,6 @@
*/
/**
* @defgroup net_gnrc_sixlowpan 6LoWPAN
* @ingroup net
*
* @defgroup net_gnrc_sixlowpan_ctx Contexts for 6LoWPAN address compression
* @ingroup net_gnrc_sixlowpan
* @brief Context buffer for stateful 6LoWPAN address compression

2
sys/include/net/gnrc/slip.h
View File

@ -8,7 +8,7 @@
/**
* @defgroup net_gnrc_slip SLIP
* @ingroup net
* @ingroup net_gnrc
* @brief Provides a SLIP interface over UART utilizing
* @ref driver_periph_uart.
* @see <a href="https://www.ietf.org/rfc/rfc1055">RFC 1055</a>

8
sys/include/net/gnrc/udp.h
View File

@ -7,14 +7,14 @@
*/
/**
* @defgroup sys_net_udp UDP
* @ingroup net
* @brief RIOT's implementation of the UDP protocol
* @defgroup net_gnrc_udp UDP
* @ingroup net_gnrc
* @brief GNRC's implementation of the UDP protocol
*
* @{
*
* @file
* @brief UDP interface definition
* @brief UDP GNRC definition
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/

2
sys/include/net/gnrc/zep.h
View File

@ -8,7 +8,7 @@
/**
* @defgroup net_gnrc_zep Zigbee Encapsulation Protocol
* @ingroup net
* @ingroup net_gnrc
* @brief Transports IEEE 802.15.4 frames over UDP (can be parsed by
* Wireshark)
* @note Stability uncertain

2
sys/include/net/ndp.h
View File

@ -7,7 +7,7 @@
*/
/**
* @defgroup net_ndp IPv6 neighbor discovery messages
* @defgroup net_ndp IPv6 neighbor discovery
* @ingroup net_ipv6
* @brief Provides IPv6 neighbor discovery message types
* @{

4
sys/include/net/sixlowpan.h
View File

@ -9,11 +9,11 @@
/**
* @defgroup net_sixlowpan 6LoWPAN
* @ingroup net
* @brief Generic 6LoWPAN types and helper functions
* @brief Provides 6LoWPAN dispatch types and helper functions
* @{
*
* @file
* @brief 6LoWPAN type and helper function definitons.
* @brief 6LoWPAN dispatch type and helper function definitons.
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/

4
sys/include/net/udp.h
View File

@ -9,14 +9,14 @@
/**
* @defgroup net_udp UDP
* @ingroup net
* @brief UDP header definition
* @brief Provides UDP header and helper functions
* @see <a href="https://tools.ietf.org/html/rfc768">
* RFC 768
* </a>
* @{
*
* @file
* @brief UDP header definition
* @brief UDP header and helper functions definition
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/