1
2 Documentation work plan
3 -----------------------
4
5 Ready for 2nd Pass
6 ------------------
7 -- place entries here when the 'first pass' is complete, describe
8 how to find them
9
10 emview (emview/include/emview.h)
11
12
13
14 Documentation Tasks
15 -------------------
16 -- this is a list of tools, libraries (APIs), and modules to document
17
18
19
20
21
22
23
24 If you receive only a single copy of theis message it means you need to
25 subscribe to emstar-design@cens.ucla.edu (via CENS internal page) Pls do so
26 now. For the rest of you pls excuse the duplicate
27
28 Lew is setting up a file to track new documents. Pls update the master doc
29 and send email to Emstar-design as you complete a pass.
30 Lew, will also put this email list in the same place (and send me a url for
31 both files)
32
33 Pls look thru this list and send comments
34
35 Also ple note where you have been assigned a task and do your best to take
36 the first pass knowing that otherw sill chime in to complete it.
37
38 ***FIRST TARGET is to finish a first pass at your task by Aug 13th.
39 Actually richard and I will both be out of town so Thanos and Lew will run
40 thatmeeting just as a checkin time and reorganising, answreing questions. I
41 might be there/call in if I can.
42
43 ***Then we will meet again Sept 3 at noon and hope to really have the first
44 pass at all of these things done by then with lots of email during this
45 month to refine the process and tasks.
46
47
48
49 (1) doxygen//documentation
50 ** takes comments from within code to generate documentation. Put .h or .c
51 file put comment before function declaration...name, creator, arguments,
52 summary. Similar to javadoc. Within code embed comments if you do code
53 listing extraction. Text tutorials are done separately but nice to put side
54 by side with heavily documented code.
55 ** chris/Naim will get doxygen up after systems in csl are stable
56 ** chris could then start on reformatting existing documentation to
57 incorporate
58
59 **documentation needed (both doygenize comments and separate ascii doc when
60 needed) (name in parenthesis indicates first pass and then others will
61 augment)
62 ** update tutorials (take old ones offline) (Roy)
63 ** device patterns/interfaces
64 ** link device and stats (Alberto)
65 ** sensor device (Hanbiao as user/Nithya internals (naim can help))
66 ** query device (yan)
67 ** status and packet device (Andrew)
68 ** event system document (complete Lews document)
69 ** glib/dev (Martin) glib_dev.h first pass complete
70 ** lib/misc contains reusable modules (novices can do: Hanbiao, Roy, Tom,
71 Sam, Rahul, Andrew)
72 *** sample/template (Alberto)
73 *** queue macros done
74 *** parser (yan)
75 *** command line options parsing code
76 *** time conversion (Sam)
77 *** file.c
78 ***
79 ** tools
80 *** emrun (ning)
81 *** emcee (thanos)
82 *** emview (henri) first pass complete
83 ** ascii doc documenting components telling how to instantiate with existing
84 macros, specify parameters and examples
85 *** network stack (Rahul)
86 *** sensor drivers (Tom)
87 *** dse on microserver (Tom)
88 ** mote directory
89 *** emTOS (martin 1st pass; thanos 2nd (ben/Rahul could help too))
90 *** motenic (Thanos)
91
92 (3) sample apps (skeletons directory): develp short examples of how to do
93 simple things that can then be built upon
94 ** eugene ??
95 ** thanos example that uses network stack
96
97 (4) bugzilla
98 ** Naim setup
99 ** karen manage it (manual entry for tracking)
100
101 (5) Installation
102 ** autoconf (Ben)
103
104 (6) Testbed
105 ** Usage (Ning)
106
107 Deborah Estrin
108 Director, Center for Embedded Networked Sensing (CENS)
109 Professor, Computer Science Department
110 UCLA
111 3531H Boelter Hall, (310) 206-3923
112 Los Angeles, CA 90095-1596
113 http://cens.ucla.edu
114 http://lecs.cs.ucla.edu/estrin
115
116
117
118 _______________________________________________
119 emstar-design mailing list
120 emstar-design@cens.ucla.edu
121 http://www.cens.ucla.edu/mailman/listinfo/emstar-design
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.