giomba/nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation updates

Browse Source
This commit is contained in:
adamdunkels 2007-12-16 14:33:32 +00:00
parent 5c5775e93b
commit 07e2ca9287
6 changed files with 55 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
core/net/rime/neighbor-discovery.h
View File

@ -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__ */
/** @} */
/** @} */

9
core/net/rime/ruc.c
View File

@ -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;
}
/*---------------------------------------------------------------------------*/
/** @} */

21
core/net/rime/ruc.h
View File

@ -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__ */
/** @} */
/** @} */

6
doc/Doxyfile
View File

@ -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 \

2
doc/Makefile
View File

@ -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)

2
doc/contiki-mainpage.txt
View File

@ -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