Documentation updates

This commit is contained in:
adamdunkels 2007-04-02 18:07:10 +00:00
parent 35957aa600
commit d42b91fd20
3 changed files with 23 additions and 16 deletions

View file

@ -1,3 +1,8 @@
/**
* \addtogroup uip
* @{
*/
/** /**
* \defgroup uipopt Configuration options for uIP * \defgroup uipopt Configuration options for uIP
* @{ * @{
@ -53,7 +58,7 @@
* *
* This file is part of the uIP TCP/IP stack. * This file is part of the uIP TCP/IP stack.
* *
* $Id: uipopt.h,v 1.2 2006/08/09 16:13:40 bg- Exp $ * $Id: uipopt.h,v 1.3 2007/04/02 18:08:36 adamdunkels Exp $
* *
*/ */
@ -542,3 +547,4 @@ typedef struct httpd_state uip_tcp_appstate_t
#endif /* __UIPOPT_H__ */ #endif /* __UIPOPT_H__ */
/** @} */ /** @} */
/** @} */

View file

@ -28,7 +28,7 @@
* *
* This file is part of the Contiki operating system. * This file is part of the Contiki operating system.
* *
* @(#)$Id: process.h,v 1.6 2007/03/30 00:04:12 adamdunkels Exp $ * @(#)$Id: process.h,v 1.7 2007/04/02 18:07:26 adamdunkels Exp $
*/ */
/** /**
@ -39,7 +39,7 @@
/** /**
* \defgroup process Contiki processes * \defgroup process Contiki processes
* *
* A process in Contiki consists of a single \ref pt protothread. * A process in Contiki consists of a single \ref pt "protothread".
* *
* @{ * @{
*/ */

View file

@ -13,20 +13,21 @@ Contiki is designed for embedded systems with small amounts of
memory. A typical Contiki configuration is 2 kilobytes of RAM and 40 memory. A typical Contiki configuration is 2 kilobytes of RAM and 40
kilobytes of ROM. Contiki consists of an event-driven kernel on top of kilobytes of ROM. Contiki consists of an event-driven kernel on top of
which application programs are dynamically loaded and unloaded at which application programs are dynamically loaded and unloaded at
runtime. Contiki processes use light-weight protothreads that provide runtime. Contiki processes use light-weight \ref pt "protothreads"
a linear, thread-like programming style on top of the event-driven that provide a linear, thread-like programming style on top of the
kernel. Contiki also supports per-process optional preemptive event-driven kernel. Contiki also supports per-process optional
multi-threading, interprocess communication using message passing preemptive multi-threading, interprocess communication using message
through events, as well as an optional GUI subsystem with either passing through events, as well as an optional GUI subsystem with
direct graphic support for locally connected terminals or networked either direct graphic support for locally connected terminals or
virtual display with VNC or over Telnet. networked virtual display with VNC or over Telnet.
Contiki contains two communication stacks: uIP and Rime. uIP is a Contiki contains two communication stacks: \ref uip "uIP" and \ref
small RFC-compliant TCP/IP stack that makes it possible for Contiki to rime "Rime". uIP is a small RFC-compliant TCP/IP stack that makes it
communicate over the Internet. Rime is a lightweight communication possible for Contiki to communicate over the Internet. Rime is a
stack designed for low-power radios. Rime provides a wide range of lightweight communication stack designed for low-power radios. Rime
communication primitives, from best-effort local area broadcast, to provides a wide range of communication primitives, from \ref rimeabc
reliable multi-hop bulk data flooding. "best-effort local area broadcast", to \ref rudolph1
"reliable multi-hop bulk data flooding".
Contiki runs on a variety of platform ranging from embedded Contiki runs on a variety of platform ranging from embedded
microcontrollers such as the MSP430 and the AVR to old microcontrollers such as the MSP430 and the AVR to old