fixed some documentation typos.
also uc -> unicast, stuc -> stunicast.
This commit is contained in:
parent
f115894193
commit
9277f922f1
5 changed files with 19 additions and 19 deletions
|
@ -54,7 +54,7 @@
|
||||||
*
|
*
|
||||||
* This file is part of the Contiki operating system.
|
* This file is part of the Contiki operating system.
|
||||||
*
|
*
|
||||||
* $Id: announcement.h,v 1.3 2009/05/06 15:04:20 adamdunkels Exp $
|
* $Id: announcement.h,v 1.4 2009/05/26 13:58:53 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -76,7 +76,7 @@ typedef void (*announcement_callback_t)(struct announcement *a,
|
||||||
uint16_t id, uint16_t val);
|
uint16_t id, uint16_t val);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Repressentation of an announcement.
|
* \brief Representation of an announcement.
|
||||||
*
|
*
|
||||||
* This structure holds the state of an announcement. It
|
* This structure holds the state of an announcement. It
|
||||||
* is an opaque structure with no user-visible elements.
|
* is an opaque structure with no user-visible elements.
|
||||||
|
@ -154,7 +154,7 @@ void announcement_set_value(struct announcement *a, uint16_t value);
|
||||||
void announcement_set_id(struct announcement *a, uint16_t id);
|
void announcement_set_id(struct announcement *a, uint16_t id);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Listen for announcements for a spefic amount of
|
* \brief Listen for announcements for a specific amount of
|
||||||
* announcement periods
|
* announcement periods
|
||||||
* \param periods The number of periods to listen for announcement
|
* \param periods The number of periods to listen for announcement
|
||||||
*
|
*
|
||||||
|
|
|
@ -41,7 +41,7 @@
|
||||||
*
|
*
|
||||||
* This file is part of the Contiki operating system.
|
* This file is part of the Contiki operating system.
|
||||||
*
|
*
|
||||||
* $Id: packetqueue.h,v 1.2 2009/05/06 08:37:48 zhitao Exp $
|
* $Id: packetqueue.h,v 1.3 2009/05/26 13:58:53 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -61,7 +61,7 @@
|
||||||
#include "net/rime/queuebuf.h"
|
#include "net/rime/queuebuf.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Repressentation of a packet queue.
|
* \brief Representation of a packet queue.
|
||||||
*
|
*
|
||||||
* This structure holds the state of a packet queue. It is
|
* This structure holds the state of a packet queue. It is
|
||||||
* an opaque structure with no user-visible elements.
|
* an opaque structure with no user-visible elements.
|
||||||
|
@ -72,7 +72,7 @@ struct packetqueue {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Repressentation of an item in a packet queue.
|
* \brief Representation of an item in a packet queue.
|
||||||
*
|
*
|
||||||
* This structure holds the state of a packet queue. It is
|
* This structure holds the state of a packet queue. It is
|
||||||
* an opaque structure with no user-visible elements. The
|
* an opaque structure with no user-visible elements. The
|
||||||
|
@ -132,7 +132,7 @@ void packetqueue_init(struct packetqueue *q);
|
||||||
* This function enqueues the \ref packetbuf "packetbuf"
|
* This function enqueues the \ref packetbuf "packetbuf"
|
||||||
* to the packet queue pointed to by the q parameter. The
|
* to the packet queue pointed to by the q parameter. The
|
||||||
* packet queue must previously have been defined with
|
* packet queue must previously have been defined with
|
||||||
* PACKETQUEUE() and initalized with packetqueue_init().
|
* PACKETQUEUE() and initialized with packetqueue_init().
|
||||||
*
|
*
|
||||||
* Each packet queue item has a maximum lifetime. When the
|
* Each packet queue item has a maximum lifetime. When the
|
||||||
* lifetime expires, the packet queue item is
|
* lifetime expires, the packet queue item is
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
* \defgroup rimeaddr Rime addresses
|
* \defgroup rimeaddr Rime addresses
|
||||||
* @{
|
* @{
|
||||||
*
|
*
|
||||||
* The rimeaddr module is an abstract repressentation of addresses in
|
* The rimeaddr module is an abstract representation of addresses in
|
||||||
* Rime.
|
* Rime.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -42,12 +42,12 @@
|
||||||
*
|
*
|
||||||
* This file is part of the Contiki operating system.
|
* This file is part of the Contiki operating system.
|
||||||
*
|
*
|
||||||
* $Id: rimeaddr.h,v 1.5 2008/11/30 18:26:06 adamdunkels Exp $
|
* $Id: rimeaddr.h,v 1.6 2009/05/26 13:58:53 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \file
|
* \file
|
||||||
* Header file for the Rime address repressentation
|
* Header file for the Rime address representation
|
||||||
* \author
|
* \author
|
||||||
* Adam Dunkels <adam@sics.se>
|
* Adam Dunkels <adam@sics.se>
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
*
|
*
|
||||||
* The stbroadcast module provides stubborn anonymous best-effort local area
|
* The stbroadcast module provides stubborn anonymous best-effort local area
|
||||||
* broadcast. A message sent with the stbroadcast module is repeated until
|
* broadcast. A message sent with the stbroadcast module is repeated until
|
||||||
* either the mssage is canceled or a new message is sent. Messages
|
* either the message is canceled or a new message is sent. Messages
|
||||||
* sent with the stbroadcast module are not identified with a sender ID.
|
* sent with the stbroadcast module are not identified with a sender ID.
|
||||||
*
|
*
|
||||||
* \section channels Channels
|
* \section channels Channels
|
||||||
|
@ -48,7 +48,7 @@
|
||||||
*
|
*
|
||||||
* This file is part of the Contiki operating system.
|
* This file is part of the Contiki operating system.
|
||||||
*
|
*
|
||||||
* $Id: stbroadcast.h,v 1.1 2008/06/30 08:28:53 adamdunkels Exp $
|
* $Id: stbroadcast.h,v 1.2 2009/05/26 13:58:53 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -13,17 +13,17 @@
|
||||||
* until an upper layer primitive or protocol cancels the
|
* until an upper layer primitive or protocol cancels the
|
||||||
* transmission. While it is possible for applications and protocols
|
* transmission. While it is possible for applications and protocols
|
||||||
* that use Rime to use the stubborn single-hop unicast primitive
|
* that use Rime to use the stubborn single-hop unicast primitive
|
||||||
* directly, the stuc primitive is primarily used by the reliable
|
* directly, the stunicast primitive is primarily used by the reliable
|
||||||
* single-hop unicast (runicast) primitive.
|
* single-hop unicast (runicast) primitive.
|
||||||
*
|
*
|
||||||
* Before the stunicast primitive sends a packet, it allocates a queue
|
* Before the stunicast primitive sends a packet, it allocates a queue
|
||||||
* buffer, to which the application data and packet attributes is
|
* buffer, to which the application data and packet attributes is
|
||||||
* copied, and sets a timer. When the timer expires, the stuc
|
* copied, and sets a timer. When the timer expires, the stunicast
|
||||||
* primitive copies the queue buffer to the Rime buffer and sends the
|
* primitive copies the queue buffer to the Rime buffer and sends the
|
||||||
* packet using the uc primitive. The stuc primitive sets the number
|
* packet using the unicast primitive. The stunicast primitive sets the
|
||||||
* of retransmissions for a packet as a packet attribute on outgoing
|
* number of retransmissions for a packet as a packet attribute on
|
||||||
* packets.
|
* outgoing packets.
|
||||||
|
*
|
||||||
* \section channels Channels
|
* \section channels Channels
|
||||||
*
|
*
|
||||||
* The stunicast module uses 1 channel.
|
* The stunicast module uses 1 channel.
|
||||||
|
@ -60,7 +60,7 @@
|
||||||
*
|
*
|
||||||
* This file is part of the Contiki operating system.
|
* This file is part of the Contiki operating system.
|
||||||
*
|
*
|
||||||
* $Id: stunicast.h,v 1.2 2009/03/07 11:15:46 adamdunkels Exp $
|
* $Id: stunicast.h,v 1.3 2009/05/26 13:58:53 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
Loading…
Reference in a new issue