Return to DOC_PLAN CVS log

Jump to this file's LXR Page

Up to [CENS] / emstar

doxygenise emview - first pass

Documentation work plan
-----------------------

Ready for 2nd Pass
------------------
 -- place entries here when the 'first pass' is complete, describe
    how to find them

    emview (emview/include/emview.h)



Documentation Tasks
-------------------
 -- this is a list of tools, libraries (APIs), and modules to document







If you receive only a single copy of theis message it means you need to
subscribe to emstar-design@cens.ucla.edu (via CENS internal page) Pls do so
now. For the rest of you pls excuse the duplicate

Lew is setting up a file to track new documents. Pls update the master doc
and send email to Emstar-design as you complete a pass.
Lew, will also put this email list in the same place (and send me a url for
both files)

Pls look thru this list and send comments

Also ple note where you have been assigned a task and do your best to take
the first pass knowing that otherw sill chime in to complete it.

***FIRST TARGET is to finish a first pass  at your task by Aug 13th.
Actually richard and I will both be out of town so Thanos and Lew will run
thatmeeting just as a checkin time and reorganising, answreing questions. I
might be there/call in if I can.

***Then we will meet again Sept 3 at noon and hope to really have the first
pass at all of these things done by then with lots of email during this
month to refine the process and tasks.



(1) doxygen//documentation
** takes comments from within code to generate documentation. Put .h or .c
file put comment before function declaration...name, creator, arguments,
summary. Similar to javadoc. Within code embed comments if you do code
listing extraction. Text tutorials are done separately but nice to put side
by side with heavily documented code.
** chris/Naim will get doxygen up after systems in csl are stable
** chris could then start on reformatting existing documentation to
incorporate

**documentation needed (both doygenize comments and separate ascii doc when
needed) (name in parenthesis indicates first pass and then others will
augment)
** update tutorials (take old ones offline) (Roy)
** device patterns/interfaces
    ** link device and stats (Alberto)
    ** sensor device (Hanbiao as user/Nithya internals (naim can help))
    ** query device (yan)
    ** status and  packet device (Andrew)
** event system document (complete Lews document)
    ** glib/dev (Martin) glib_dev.h first pass complete
** lib/misc contains reusable modules (novices can do: Hanbiao, Roy, Tom,
Sam, Rahul, Andrew)
    *** sample/template (Alberto)
    *** queue macros done
    *** parser (yan)
    *** command line options parsing code
    *** time conversion (Sam)
    *** file.c
    ***
** tools
    *** emrun (ning)
    *** emcee (thanos)
    *** emview (henri) first pass complete
** ascii doc documenting components telling how to instantiate with existing
macros, specify parameters and examples
    *** network stack (Rahul)
    *** sensor drivers (Tom)
        *** dse on microserver (Tom)
** mote directory
    *** emTOS (martin 1st pass; thanos 2nd (ben/Rahul could help too))
    *** motenic (Thanos)

(3) sample apps (skeletons directory): develp short examples of how to do
simple things that can then be built upon
** eugene ??
** thanos example that uses network stack

(4) bugzilla 
** Naim setup
** karen manage it (manual entry for tracking)

(5) Installation
** autoconf (Ben)

(6) Testbed 
** Usage (Ning)

Deborah Estrin
Director, Center for Embedded Networked Sensing (CENS)
Professor, Computer Science Department
UCLA
3531H Boelter Hall, (310) 206-3923
Los Angeles, CA 90095-1596
http://cens.ucla.edu
http://lecs.cs.ucla.edu/estrin



_______________________________________________
emstar-design mailing list
emstar-design@cens.ucla.edu
http://www.cens.ucla.edu/mailman/listinfo/emstar-design