Documentation fixes

core/net/rime/abc.h

@@ -1,5 +1,5 @@
 /**
- * \addtogroup rimed
+ * \addtogroup rime
  * @{
  */
 
@@ -41,7 +41,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: abc.h,v 1.9 2007/03/28 19:51:33 adamdunkels Exp $
+ * $Id: abc.h,v 1.10 2007/03/29 23:18:47 adamdunkels Exp $
  */
 /**
  * \file
@@ -129,6 +129,6 @@ int abc_send(struct abc_conn *c);
  */
 void abc_input_packet(void);
 
-#endif /* __BC_H__ */
+#endif /* __ABC_H__ */
 /** @} */
 /** @} */

core/net/rime/ibc.h

@@ -4,7 +4,7 @@
  */
 
 /**
- * \defgroup rime-ibc Identified best-effort local area broadcast (ibc)
+ * \defgroup rimeibc Identified best-effort local area broadcast (ibc)
  * @{
  *
  * The ibc module sends packets to all local area neighbors with an a
@@ -41,7 +41,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: ibc.h,v 1.6 2007/03/25 12:05:51 adamdunkels Exp $
+ * $Id: ibc.h,v 1.7 2007/03/29 23:18:48 adamdunkels Exp $
  */
 
 /**

core/net/rime/mesh.c

@@ -1,5 +1,5 @@
 /**
- * \addtogroup rime-mesh
+ * \addtogroup rimemesh
  * @{
  */
 
@@ -33,7 +33,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: mesh.c,v 1.6 2007/03/25 12:06:57 adamdunkels Exp $
+ * $Id: mesh.c,v 1.7 2007/03/29 23:18:48 adamdunkels Exp $
  */
 
 /**

core/net/rime/mesh.h

@@ -4,7 +4,7 @@
  */
 
 /**
- * \defgroup rime-mesh Mesh routing
+ * \defgroup rimemesh Mesh routing
  * @{
  *
  * The abc module sends packets using multi-hop routing to a specified
@@ -42,7 +42,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: mesh.h,v 1.6 2007/03/25 12:05:51 adamdunkels Exp $
+ * $Id: mesh.h,v 1.7 2007/03/29 23:18:48 adamdunkels Exp $
  */
 
 /**
@@ -115,6 +115,7 @@ void mesh_close(struct mesh_conn *c);
 /**
  * \brief      Send a mesh packet
  * \param c    The mesh connection on which the packet should be sent
+ * \param dest The address of the final destination of the packet
  * \retval     Non-zero if the packet could be queued for sending, zero otherwise
  *
  *             This function sends a mesh packet. The packet must be

core/net/rime/queuebuf.c

@@ -28,12 +28,12 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: queuebuf.c,v 1.6 2007/03/29 22:22:20 adamdunkels Exp $
+ * $Id: queuebuf.c,v 1.7 2007/03/29 23:18:48 adamdunkels Exp $
  */
 
 /**
  * \file
- *         A brief description of what this file is.
+ *         Implementation of the Rime queue buffers
  * \author
  *         Adam Dunkels <adam@sics.se>
  */

core/net/rime/queuebuf.h

@@ -4,7 +4,7 @@
  */
 
 /**
- * \defgroup rime-queuebuf Rime queue buffer management
+ * \defgroup rimequeuebuf Rime queue buffer management
  * @{
  *
  * The Rime queue buffer management handles buffers that are queued.
@@ -41,7 +41,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: queuebuf.h,v 1.3 2007/03/25 12:07:10 adamdunkels Exp $
+ * $Id: queuebuf.h,v 1.4 2007/03/29 23:18:48 adamdunkels Exp $
  */
 
 /**
@@ -69,3 +69,6 @@ int queuebuf_datalen(struct queuebuf *b);
 
 
 #endif /* __QUEUEBUF_H__ */
+
+/** @} */
+/** @} */

core/net/rime/sabc.h

@@ -4,7 +4,7 @@
 */
 
 /**
- * \defgroup rime-sabc Stubborn Anonymous best-effort local area BroadCast
+ * \defgroup rimesabc Stubborn Anonymous best-effort local area BroadCast
  * @{
  *
  * The sabc module provides stubborn anonymous best-effort local area
@@ -44,7 +44,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: sabc.h,v 1.5 2007/03/20 12:26:57 adamdunkels Exp $
+ * $Id: sabc.h,v 1.6 2007/03/29 23:18:48 adamdunkels Exp $
  */
 
 /**
@@ -146,3 +146,4 @@ void sabc_set_timer(struct sabc_conn *c, clock_time_t t);
 #endif /* __SABC_H__ */
 
 /** @} */
+/** @} */

doc/Doxyfile

@@ -189,6 +189,7 @@ INPUT                  = contiki-mainpage.txt net.txt dev.txt \
                          ../core/lib/me.c \
                          ../core/lib/crc16.h \
                          ../core/lib/crc16.c \
+			 ../platform/sky/doc/sky.txt \
 			 ../platform/esb/doc/esb.txt \
 			 ../platform/esb/doc/slipintro.txt \
 			 ../platform/esb/dev/beep.h \

doc/contiki-mainpage.txt

@@ -2,41 +2,61 @@
 
 \mainpage The Contiki Operating System 2.x
 
-\author Adam Dunkels <adam@dunkels.com>
+\author Adam Dunkels <adam@sics.se>
 
-The Contiki operating system is a highly portable, minimalistic
+Contiki is an open source, highly portable, multi-tasking operating
-operating system for a variety of constrained systems ranging from
+system for memory-constrained networked embedded systems written by
-modern 8-bit microcontrollers for embedded systems to old 8-bit
+Adam Dunkels at the Networked Embedded Systems group at the Swedish
-homecomputers. Contiki provides a simple event driven kernel with
+Institute of Computer Science.
-optional preemptive multithreading, interprocess communication using
+
-message passing signals, a dynamic process structure and support for
+Contiki is designed for embedded systems with small amounts of
-loading and unloading programs, native TCP/IP support using the uIP
+memory. A typical Contiki configuration is 2 kilobytes of RAM and 40
-TCP/IP stack, and a graphical subsystem with either direct graphic
+kilobytes of ROM. Contiki consists of an event-driven kernel on top of
-support for directly connected terminals or networked virtual display
+which application programs are dynamically loaded and unloaded at
-with VNC or Telnet.
+runtime. Contiki processes use light-weight protothreads that provide
+a linear, thread-like programming style on top of the event-driven
+kernel. Contiki also supports per-process optional preemptive
+multi-threading, interprocess communication using message passing
+through events, as well as an optional GUI subsystem with either
+direct graphic support for locally connected terminals or networked
+virtual display with VNC or over Telnet.
+
+Contiki contains two communication stacks: uIP and Rime. uIP is a
+small RFC-compliant TCP/IP stack that makes it possible for Contiki to
+communicate over the Internet. Rime is a lightweight communication
+stack designed for low-power radios. Rime provides a wide range of
+communication primitives, from best-effort local area broadcast, to
+reliable multi-hop bulk data flooding.
+
+Contiki runs on a variety of platform ranging from embedded
+microcontrollers such as the MSP430 and the AVR to old
+homecomputers. Code footprint is on the order of kilobytes and memory
+usage can be configured to be as low as tens of bytes.
 
 Contiki is written in the C programming language and is freely
 available as open source under a BSD-style license. More information
 about Contiki can be found at the Contiki home page:
-http://www.sics.se/~adam/contiki/
+http://www.sics.se/contiki/
 
-\section contiki-mainpage-getting-started Getting started with Contiki
 
-Contiki is designed to run on many different \ref platform "platforms". It is also
+\section contiki-mainpage-tcpip TCP/IP
-possible to compile and build both the Contiki system and Contiki
-applications on many different development platforms. 
 
-See \ref esb-getting-started "Getting started with Contiki for the ESB platform
+Contiki includes the uIP TCP/IP stack (http://www.sics.se/~adam/uip/)
+that provides Contiki with TCP/IP networking support. uIP provides the
+protocols TCP, UDP, IP, and ARP.
 
-\section contiki-mainpage-building Building the Contiki system and its applications
+\sa \ref uip "The uIP TCP/IP stack documentation"
+\sa \ref tcpip "The Contiki/uIP interface"
+\sa \ref psock "Protosockets library"
 
- The Contiki build system is designed to make it easy to compile
+\section contiki-mainpage-rime Rime
- Contiki applications for either to a hardware platform or into a
- simulation platform by simply supplying different parameters to the
- <tt>make</tt> command, without having to edit makefiles or modify
- the application code.
 
-See \ref buildsystem 
+Rime is a lightweight communication stacks designed for low-power
+radios. Rime provides a wide range of communication primitives
+suitable for implementing communication-bound applications or network
+protocols.
+
+\sa \ref rime "The Rime Communication Stack"
 
 \section contiki-mainpage-threads Multi-threading and protothreads
 
@@ -58,15 +78,23 @@ and linked list operations.
 \sa \ref memb "Memory block management"
 \sa \ref list "Linked list library"
 
-\section contiki-mainpage-tcpip TCP/IP support
+\section contiki-mainpage-getting-started Getting started with Contiki
 
-Contiki includes the uIP TCP/IP stack (http://www.sics.se/~adam/uip/)
+Contiki is designed to run on many different \ref platform "platforms". It is also
-that provides Contiki with TCP/IP networking support. uIP provides the
+possible to compile and build both the Contiki system and Contiki
-protocols TCP, UDP, IP, and ARP.
+applications on many different development platforms. 
 
-\sa \ref uip "The uIP TCP/IP stack documentation"
+See \ref esb-getting-started "Getting started with Contiki for the ESB platform
-\sa \ref tcpip "The Contiki/uIP interface"
+
-\sa \ref psock "Protosockets library"
+\section contiki-mainpage-building Building the Contiki system and its applications
+
+ The Contiki build system is designed to make it easy to compile
+ Contiki applications for either to a hardware platform or into a
+ simulation platform by simply supplying different parameters to the
+ <tt>make</tt> command, without having to edit makefiles or modify
+ the application code.
+
+See \ref buildsystem 
 
 
 */

doc/rime-doc.txt

@@ -1,19 +1,17 @@
 /**
-\addtogroup net
+ * \addtogroup net
-@{
+ * @{
-*/
+ */
 
 /**
-\defgroup rime The Rime communication stack
+ * \defgroup rime The Rime communication stack
-@{
+ * @{
-
+ *
-The Rime communication stack provides a set of lightweight
+ * The Rime communication stack provides a set of lightweight
-communication primitives ranging from best-effort anonymous local area
+ * communication primitives ranging from best-effort anonymous local area
-broadcast to reliable network flooding.
+ * broadcast to reliable network flooding.
-
+ *
-*/
+ */
-
 
 /** @} */
 /** @} */
-