Merge pull request #3305 from OlegHahm/sixlowpan_doc_fixes

doc: some fixes in 6LoWPAN documentation
This commit is contained in:
Oleg Hahm 2015-07-03 16:40:29 +02:00
commit f0c67d194c
3 changed files with 10 additions and 6 deletions

View File

@ -32,14 +32,14 @@ extern "C" {
#endif
/**
* @brief Default stack size to use for the 6LoWPAN thread
* @brief Default stack size to use for the 6LoWPAN thread.
*/
#ifndef NG_SIXLOWPAN_STACK_SIZE
#define NG_SIXLOWPAN_STACK_SIZE (THREAD_STACKSIZE_DEFAULT)
#endif
/**
* @brief Default priority for the 6LoWPAN thread
* @brief Default priority for the 6LoWPAN thread.
*/
#ifndef NG_SIXLOWPAN_PRIO
#define NG_SIXLOWPAN_PRIO (THREAD_PRIORITY_MAIN - 4)
@ -58,7 +58,7 @@ extern "C" {
#define NG_SIXLOWPAN_UNCOMPRESSED (0x41)
/**
* @brief Checks if dispatch indicats that fram is not a 6LoWPAN (NALP) frame.
* @brief Checks if dispatch indicates that frame is not a 6LoWPAN (NALP) frame.
*
* @param[in] disp The first byte of a frame.
*

View File

@ -44,8 +44,12 @@ extern "C" {
/**
* @brief General and 1st 6LoWPAN fragmentation header
*
* @see <a href="https://tools.ietf.org/html/rfc4944#section-5.1">
* RFC 4944, section 5.1
* @note The general 6LoWPAN fragmentation header refers to the first 4
* bytes of a \c FRAG0 or \c FRAGN fragmentation header, which are
* identical.
*
* @see <a href="https://tools.ietf.org/html/rfc4944#section-5.3">
* RFC 4944, section 5.3
* </a>
*/
typedef struct __attribute__((packed)) {

View File

@ -53,7 +53,7 @@ void ng_sixlowpan_netif_init(void);
void ng_sixlowpan_netif_add(kernel_pid_t pid, uint16_t max_frag_size);
/**
* @brief REmove interface from 6LoWPAN.
* @brief Remove interface from 6LoWPAN.
*
* @param[in] pid The PID to the interface.
*/