Improve 6LoWPAN documentation

This commit is contained in:
Dirk Ziegelmeier 2018-03-03 11:05:30 +01:00
parent 08bf8b7121
commit 91038e4979
2 changed files with 5 additions and 5 deletions

View File

@ -43,7 +43,7 @@
*/ */
/** /**
* @defgroup sixlowpan 6LowPAN * @defgroup sixlowpan 6LoWPAN (RFC4944)
* @ingroup netifs * @ingroup netifs
* 6LowPAN netif implementation * 6LowPAN netif implementation
*/ */

View File

@ -38,7 +38,7 @@
/** /**
* @defgroup rfc7668if RFC7668 - 6LoWPAN over BLE netif * @defgroup rfc7668if 6LoWPAN over BLE (RFC7668)
* @ingroup netifs * @ingroup netifs
* This file implements a RFC7668 implementation for 6LoWPAN over * This file implements a RFC7668 implementation for 6LoWPAN over
* Bluetooth Low Energy. The specification is very similar to 6LoWPAN, * Bluetooth Low Energy. The specification is very similar to 6LoWPAN,
@ -49,11 +49,11 @@
* Usage: * Usage:
* - add this netif * - add this netif
* - don't add IPv4 addresses (no IPv4 support in RFC7668), pass 'NULL','NULL','NULL' * - don't add IPv4 addresses (no IPv4 support in RFC7668), pass 'NULL','NULL','NULL'
* - use the BLE to EUI64 conversation util to create an IPv6 link-local address from the BLE MAC ( @see ble_addr_to_eui64) * - use the BLE to EUI64 conversation util to create an IPv6 link-local address from the BLE MAC (@ref ble_addr_to_eui64)
* - input function: @see rfc7668_input * - input function: @ref rfc7668_input
* - set the link output function, which transmits output data to an established L2CAP channel * - set the link output function, which transmits output data to an established L2CAP channel
* - If data arrives (HCI event "L2CAP_DATA_PACKET"): * - If data arrives (HCI event "L2CAP_DATA_PACKET"):
* - allocate a @see PBUF_RAW buffer * - allocate a @ref PBUF_RAW buffer
* - let the pbuf struct point to the incoming data or copy it to the buffer * - let the pbuf struct point to the incoming data or copy it to the buffer
* - call netif->input * - call netif->input
* *