From 07e2ca92874c04befc599faea7f6251334fd4bb3 Mon Sep 17 00:00:00 2001
From: adamdunkels <adamdunkels>
Date: Sun, 16 Dec 2007 14:33:32 +0000
Subject: [PATCH] Documentation updates

---
 core/net/rime/neighbor-discovery.h | 23 ++++++++++++++++++++++-
 core/net/rime/ruc.c                |  9 ++++++++-
 core/net/rime/ruc.h                | 21 ++++++++++++++++++++-
 doc/Doxyfile                       |  6 ++++--
 doc/Makefile                       |  2 +-
 doc/contiki-mainpage.txt           |  2 --
 6 files changed, 55 insertions(+), 8 deletions(-)

diff --git a/core/net/rime/neighbor-discovery.h b/core/net/rime/neighbor-discovery.h
index c10818320..48c23e08a 100644
--- a/core/net/rime/neighbor-discovery.h
+++ b/core/net/rime/neighbor-discovery.h
@@ -1,3 +1,22 @@
+/**
+ * \addtogroup rime
+ * @{
+ */
+
+/**
+ * \defgroup rimeneighbordiscovery Neighbor discovery
+ * @{
+ *
+ * The neighbor-discovery module implements a periodic neighbor
+ * discovery mechanism. A callback is invoked for every incoming
+ * neighbor discovery message.
+ *
+ * \section channels Channels
+ *
+ * The neighbor-discovery module uses 1 channel.
+ *
+ */
+
 /*
  * Copyright (c) 2006, Swedish Institute of Computer Science.
  * All rights reserved.
@@ -28,7 +47,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: neighbor-discovery.h,v 1.1 2007/12/09 15:40:43 adamdunkels Exp $
+ * $Id: neighbor-discovery.h,v 1.2 2007/12/16 14:33:32 adamdunkels Exp $
  */
 
 /**
@@ -64,3 +83,5 @@ void neighbor_discovery_close(struct neighbor_discovery_conn *c);
 void neighbor_discovery_start(struct neighbor_discovery_conn *c, uint16_t val);
 
 #endif /* __NEIGHBOR_DISCOVERY_H__ */
+/** @} */
+/** @} */
diff --git a/core/net/rime/ruc.c b/core/net/rime/ruc.c
index ac2ef3b84..8cd5d6594 100644
--- a/core/net/rime/ruc.c
+++ b/core/net/rime/ruc.c
@@ -1,3 +1,9 @@
+/**
+ * \addtogroup rimeruc
+ * @{
+ */
+
+
 /*
  * Copyright (c) 2006, Swedish Institute of Computer Science.
  * All rights reserved.
@@ -28,7 +34,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: ruc.c,v 1.14 2007/11/13 20:58:46 adamdunkels Exp $
+ * $Id: ruc.c,v 1.15 2007/12/16 14:33:32 adamdunkels Exp $
  */
 
 /**
@@ -201,3 +207,4 @@ ruc_send(struct ruc_conn *c, rimeaddr_t *receiver, u8_t max_retransmissions)
   return 0;
 }
 /*---------------------------------------------------------------------------*/
+/** @} */
diff --git a/core/net/rime/ruc.h b/core/net/rime/ruc.h
index c62d9d84d..7597c5ae3 100644
--- a/core/net/rime/ruc.h
+++ b/core/net/rime/ruc.h
@@ -1,3 +1,20 @@
+/**
+ * \addtogroup rime
+ * @{
+ */
+
+/**
+ * \defgroup rimeruc Single-hop reliable unicast
+ * @{
+ *
+ * The ruc module implements a single-hop reliable unicast mechanism.
+ *
+ * \section channels Channels
+ *
+ * The ruc module uses 1 channel.
+ *
+ */
+
 /*
  * Copyright (c) 2006, Swedish Institute of Computer Science.
  * All rights reserved.
@@ -28,7 +45,7 @@
  *
  * This file is part of the Contiki operating system.
  *
- * $Id: ruc.h,v 1.10 2007/11/27 23:32:34 adamdunkels Exp $
+ * $Id: ruc.h,v 1.11 2007/12/16 14:33:32 adamdunkels Exp $
  */
 
 /**
@@ -66,3 +83,5 @@ void ruc_close(struct ruc_conn *c);
 int ruc_send(struct ruc_conn *c, rimeaddr_t *receiver, u8_t max_retransmissions);
 
 #endif /* __RUC_H__ */
+/** @} */
+/** @} */
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 962dab70c..f3a34942d 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -110,6 +110,8 @@ INPUT                  = contiki-mainpage.txt net.txt dev.txt \
                          ../core/ctk/ctk-draw.h \
                          ../core/sys/timer.h \
                          ../core/sys/timer.c \
+                         ../core/sys/timesynch.h \
+                         ../core/sys/timesynch.c \
                          ../core/net/uip.h \
                          ../core/net/uip.c \
                          ../core/net/uipopt.h \
@@ -145,8 +147,8 @@ INPUT                  = contiki-mainpage.txt net.txt dev.txt \
                          ../core/net/rime/mesh.c \
                          ../core/net/rime/mh.h \
                          ../core/net/rime/mh.c \
-                         ../core/net/rime/nbh.h \
-                         ../core/net/rime/nbh.c \
+                         ../core/net/rime/neighbor-discovery.h \
+                         ../core/net/rime/neighbor-discovery.c \
                          ../core/net/rime/neighbor.h \
                          ../core/net/rime/neighbor.c \
                          ../core/net/rime/nf.h \
diff --git a/doc/Makefile b/doc/Makefile
index af3dfb85c..895bcf707 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -9,4 +9,4 @@ pdf:
 upload: dox  #pdf
 #	scp -C latex/refman.pdf adamdunkels@shell.sourceforge.net:/home/groups/c/co/contiki/htdocs/
 #	tar czfv - html | ssh adamdunkels@shell.sourceforge.net "cd /home/groups/c/co/contiki/htdocs/; tar xfz -"
-	(cd html; rsync -rv . r2d2.sics.se:/home/adam/public_html/contiki/docs)
+	(cd html; rsync -rv . kloster.sics.se:/home/adam/public_html/contiki/docs)
diff --git a/doc/contiki-mainpage.txt b/doc/contiki-mainpage.txt
index 82e099974..ddc0c3746 100644
--- a/doc/contiki-mainpage.txt
+++ b/doc/contiki-mainpage.txt
@@ -2,8 +2,6 @@
 
 \mainpage The Contiki Operating System 2.1
 
-\author Adam Dunkels <adam@sics.se>
-
 Contiki is an open source, highly portable, multi-tasking operating
 system for memory-constrained networked embedded systems written by
 Adam Dunkels at the Networked Embedded Systems group at the Swedish