mirror of
https://github.com/oliverschmidt/contiki.git
synced 2024-12-22 10:30:13 +00:00
fixed documentation typos.
This commit is contained in:
parent
b20f0884ed
commit
4b6c110706
@ -28,11 +28,11 @@
|
|||||||
*
|
*
|
||||||
* This file is part of the Contiki operating system.
|
* This file is part of the Contiki operating system.
|
||||||
*
|
*
|
||||||
* @(#)$Id: hc.h,v 1.2 2006/10/09 11:53:43 adamdunkels Exp $
|
* @(#)$Id: hc.h,v 1.3 2009/03/17 20:28:44 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* \file
|
* \file
|
||||||
* TCP/IP header compresison header file.
|
* TCP/IP header compression header file.
|
||||||
* \author Adam Dunkels <adam@sics.se>
|
* \author Adam Dunkels <adam@sics.se>
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -30,7 +30,7 @@
|
|||||||
*
|
*
|
||||||
* Author: Adam Dunkels <adam@sics.se>
|
* Author: Adam Dunkels <adam@sics.se>
|
||||||
*
|
*
|
||||||
* $Id: psock.h,v 1.4 2007/11/17 18:05:21 adamdunkels Exp $
|
* $Id: psock.h,v 1.5 2009/03/17 20:28:44 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -263,7 +263,7 @@ PT_THREAD(psock_readto(struct psock *psock, unsigned char c));
|
|||||||
*
|
*
|
||||||
* This macro will block waiting for data and read the data into the
|
* This macro will block waiting for data and read the data into the
|
||||||
* input buffer specified with the call to PSOCK_INIT(). Data is only
|
* input buffer specified with the call to PSOCK_INIT(). Data is only
|
||||||
* read until the specifieed character appears in the data stream.
|
* read until the specified character appears in the data stream.
|
||||||
*
|
*
|
||||||
* \param psock (struct psock *) A pointer to the protosocket from which
|
* \param psock (struct psock *) A pointer to the protosocket from which
|
||||||
* data should be read.
|
* data should be read.
|
||||||
|
@ -33,7 +33,7 @@
|
|||||||
*
|
*
|
||||||
* This file is part of the Contiki operating system.
|
* This file is part of the Contiki operating system.
|
||||||
*
|
*
|
||||||
* $Id: rime.h,v 1.22 2009/03/12 21:58:20 adamdunkels Exp $
|
* $Id: rime.h,v 1.23 2009/03/17 20:28:44 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -82,7 +82,7 @@ void rime_init(const struct mac_driver *);
|
|||||||
* \brief Send an incoming packet to Rime
|
* \brief Send an incoming packet to Rime
|
||||||
*
|
*
|
||||||
* This function should be called by the network driver to
|
* This function should be called by the network driver to
|
||||||
* hand over a packet to Rime for furhter processing. The
|
* hand over a packet to Rime for further processing. The
|
||||||
* packet should be placed in the packetbuf (with
|
* packet should be placed in the packetbuf (with
|
||||||
* packetbuf_copyfrom()) before calling this function.
|
* packetbuf_copyfrom()) before calling this function.
|
||||||
*
|
*
|
||||||
@ -93,11 +93,11 @@ void rime_input(void);
|
|||||||
* \brief Rime calls this function to send out a packet
|
* \brief Rime calls this function to send out a packet
|
||||||
*
|
*
|
||||||
* This function must be implemented by the driver running
|
* This function must be implemented by the driver running
|
||||||
* below Rime. It is called by abRime to send out a
|
* below Rime. It is called by anonymous broadcast (abc) to
|
||||||
* packet. The packet is consecutive in the packetbuf. A
|
* send out a packet. The packet is consecutive in the
|
||||||
* pointer to the first byte of the packet is obtained
|
* packetbuf. A pointer to the first byte of the packet is
|
||||||
* with the packetbuf_hdrptr() function. The length of the
|
* obtained from the packetbuf_hdrptr() function. The length
|
||||||
* packet to send is obtained with the packetbuf_totlen()
|
* of the packet to send is obtained with the packetbuf_totlen()
|
||||||
* function.
|
* function.
|
||||||
*
|
*
|
||||||
* The driver, which typically is a MAC protocol, may
|
* The driver, which typically is a MAC protocol, may
|
||||||
|
@ -33,7 +33,7 @@
|
|||||||
*
|
*
|
||||||
* This file is part of the Contiki operating system.
|
* This file is part of the Contiki operating system.
|
||||||
*
|
*
|
||||||
* $Id: sicslowpan.h,v 1.2 2008/10/14 12:26:18 adamdunkels Exp $
|
* $Id: sicslowpan.h,v 1.3 2009/03/17 20:28:44 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* \file
|
* \file
|
||||||
@ -54,14 +54,14 @@
|
|||||||
* \name General sicslowpan defines
|
* \name General sicslowpan defines
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
/* Min and Max compressable UDP ports */
|
/* Min and Max compressible UDP ports */
|
||||||
#define SICSLOWPAN_UDP_PORT_MIN 0xF0B0
|
#define SICSLOWPAN_UDP_PORT_MIN 0xF0B0
|
||||||
#define SICSLOWPAN_UDP_PORT_MAX 0xF0BF /* F0B0 + 15 */
|
#define SICSLOWPAN_UDP_PORT_MAX 0xF0BF /* F0B0 + 15 */
|
||||||
/** @} */
|
/** @} */
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \name 6lowpan dispatchs
|
* \name 6lowpan dispatches
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
#define SICSLOWPAN_DISPATCH_IPV6 0x41 /* 01000001 = 65 */
|
#define SICSLOWPAN_DISPATCH_IPV6 0x41 /* 01000001 = 65 */
|
||||||
@ -142,7 +142,7 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief The header for fragments
|
* \brief The header for fragments
|
||||||
* \note We do not define different structuresfor FRAG1
|
* \note We do not define different structures for FRAG1
|
||||||
* and FRAGN headers, which are different. For FRAG1, the
|
* and FRAGN headers, which are different. For FRAG1, the
|
||||||
* offset field is just not used
|
* offset field is just not used
|
||||||
*/
|
*/
|
||||||
@ -232,7 +232,7 @@ struct sicslowpan_addr_context {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief check whether the 112-bit group-id of the
|
* \brief check whether the 112-bit group-id of the
|
||||||
* multicast address is mapable to a 9-bit group-id
|
* multicast address is mappable to a 9-bit group-id
|
||||||
* It is true if the group is the all nodes or all
|
* It is true if the group is the all nodes or all
|
||||||
* routers group.
|
* routers group.
|
||||||
*/
|
*/
|
||||||
|
@ -39,7 +39,7 @@
|
|||||||
*
|
*
|
||||||
* This file is part of the uIP TCP/IP stack.
|
* This file is part of the uIP TCP/IP stack.
|
||||||
*
|
*
|
||||||
* $Id: slipdev.h,v 1.1 2006/06/17 22:41:18 adamdunkels Exp $
|
* $Id: slipdev.h,v 1.2 2009/03/17 20:28:44 nvt-se Exp $
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@ -69,7 +69,7 @@ void slipdev_char_put(u8_t c);
|
|||||||
* The function should return immediately regardless if a character is
|
* The function should return immediately regardless if a character is
|
||||||
* available or not. If a character is available it should be placed
|
* available or not. If a character is available it should be placed
|
||||||
* at the memory location pointed to by the pointer supplied by the
|
* at the memory location pointed to by the pointer supplied by the
|
||||||
* arguement c.
|
* argument c.
|
||||||
*
|
*
|
||||||
* \param c A pointer to a byte that is filled in by the function with
|
* \param c A pointer to a byte that is filled in by the function with
|
||||||
* the received character, if available.
|
* the received character, if available.
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
*
|
*
|
||||||
* Author: Adam Dunkels <adam@sics.se>
|
* Author: Adam Dunkels <adam@sics.se>
|
||||||
*
|
*
|
||||||
* $Id: tcpip.h,v 1.14 2009/02/28 11:57:46 oliverschmidt Exp $
|
* $Id: tcpip.h,v 1.15 2009/03/17 20:28:44 nvt-se Exp $
|
||||||
*/
|
*/
|
||||||
#ifndef __TCPIP_H__
|
#ifndef __TCPIP_H__
|
||||||
#define __TCPIP_H__
|
#define __TCPIP_H__
|
||||||
@ -246,9 +246,9 @@ struct uip_udp_conn *udp_broadcast_new(u16_t port, void *appstate);
|
|||||||
/**
|
/**
|
||||||
* Bind a UDP connection to a local port.
|
* Bind a UDP connection to a local port.
|
||||||
*
|
*
|
||||||
* This function binds a UDP conncetion to a specified local port.
|
* This function binds a UDP connection to a specified local port.
|
||||||
*
|
*
|
||||||
* When a connction is created with udp_new(), it gets a local port
|
* When a connection is created with udp_new(), it gets a local port
|
||||||
* number assigned automatically. If the application needs to bind the
|
* number assigned automatically. If the application needs to bind the
|
||||||
* connection to a specified local port, this function should be used.
|
* connection to a specified local port, this function should be used.
|
||||||
*
|
*
|
||||||
@ -291,8 +291,8 @@ CCIF void tcpip_poll_udp(struct uip_udp_conn *conn);
|
|||||||
* If no application registers, some ICMPv6 packets will be
|
* If no application registers, some ICMPv6 packets will be
|
||||||
* processed by the "kernel" as usual (NS, NA, RS, RA, Echo request),
|
* processed by the "kernel" as usual (NS, NA, RS, RA, Echo request),
|
||||||
* others will be dropped.
|
* others will be dropped.
|
||||||
* If an appplication registers here, it will be polled with a
|
* If an application registers here, it will be polled with a
|
||||||
* process_post_synch everytime an ICMPv6 packet is received.
|
* process_post_synch every time an ICMPv6 packet is received.
|
||||||
*/
|
*/
|
||||||
u8_t icmp6_new(void *appstate);
|
u8_t icmp6_new(void *appstate);
|
||||||
|
|
||||||
@ -308,7 +308,7 @@ void tcpip_icmp6_call(u8_t type);
|
|||||||
/**
|
/**
|
||||||
* The uIP event.
|
* The uIP event.
|
||||||
*
|
*
|
||||||
* This event is posted to a process whenever a uIP event has occured.
|
* This event is posted to a process whenever a uIP event has occurred.
|
||||||
*/
|
*/
|
||||||
CCIF extern process_event_t tcpip_event;
|
CCIF extern process_event_t tcpip_event;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user