From e01ea0a32bd1fff28d4d6b6e7c15e6bc0137b55d Mon Sep 17 00:00:00 2001 From: adamdunkels Date: Sun, 25 Mar 2007 12:01:54 +0000 Subject: [PATCH] Added Rime to doxygen documentation generation --- doc/Doxyfile | 49 +++++++++++++++++++++++++++++++++++++++++++++++- doc/rime-doc.txt | 19 +++++++++++++++++++ 2 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 doc/rime-doc.txt diff --git a/doc/Doxyfile b/doc/Doxyfile index 8466aa185..badbb6b1e 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -76,7 +76,7 @@ INPUT = contiki-mainpage.txt net.txt dev.txt \ lib.txt \ platform.txt \ uip-doc.txt \ - ../apps/rime/rime-doc.txt \ + rime-doc.txt \ code-style.txt \ examples.txt \ uip-doc.txt build-system.txt \ @@ -129,6 +129,53 @@ INPUT = contiki-mainpage.txt net.txt dev.txt \ ../core/net/psock.c \ ../core/net/tcpip.h \ ../core/net/tcpip.c \ + ../core/net/rime.h \ + ../core/net/rime/abc.h \ + ../core/net/rime/abc.c \ + ../core/net/rime/ctimer.h \ + ../core/net/rime/ctimer.c \ + ../core/net/rime/ibc.h \ + ../core/net/rime/ibc.c \ + ../core/net/rime/mesh.h \ + ../core/net/rime/mesh.c \ + ../core/net/rime/mh.h \ + ../core/net/rime/mh.c \ + ../core/net/rime/neighbor.h \ + ../core/net/rime/neighbor.c \ + ../core/net/rime/nf.h \ + ../core/net/rime/nf.c \ + ../core/net/rime/queuebuf.h \ + ../core/net/rime/queuebuf.c \ + ../core/net/rime/rimeaddr.h \ + ../core/net/rime/rimeaddr.c \ + ../core/net/rime/rimebuf.h \ + ../core/net/rime/rimebuf.c \ + ../core/net/rime/route-discovery.h \ + ../core/net/rime/route-discovery.c \ + ../core/net/rime/route.h \ + ../core/net/rime/route.c \ + ../core/net/rime/ruc.h \ + ../core/net/rime/ruc.c \ + ../core/net/rime/sabc.h \ + ../core/net/rime/sabc.c \ + ../core/net/rime/sibc.h \ + ../core/net/rime/sibc.c \ + ../core/net/rime/suc.h \ + ../core/net/rime/suc.c \ + ../core/net/rime/tree.h \ + ../core/net/rime/tree.c \ + ../core/net/rime/trickle.h \ + ../core/net/rime/trickle.c \ + ../core/net/rime/uabc.h \ + ../core/net/rime/uabc.c \ + ../core/net/rime/uc.h \ + ../core/net/rime/uc.c \ + ../core/net/rime/uibc.h \ + ../core/net/rime/uibc.c \ + ../core/net/rime/rudolph0.h \ + ../core/net/rime/rudolph0.c \ + ../core/net/rime/rudolph1.h \ + ../core/net/rime/rudolph1.c \ ../core/lib/petsciiconv.h \ ../core/lib/ctk-textedit.h \ ../core/lib/ctk-textedit.c \ diff --git a/doc/rime-doc.txt b/doc/rime-doc.txt new file mode 100644 index 000000000..44076c36c --- /dev/null +++ b/doc/rime-doc.txt @@ -0,0 +1,19 @@ +/** +\addtogroup net +@{ +*/ + +/** +\defgroup rime The Rime communication stack +@{ + +The Rime communication stack provides a set of lightweight +communication primitives ranging from best-effort anonymous local area +broadcast to reliable network flooding. + +*/ + + +/** @} */ +/** @} */ +