[Tinyos Core WG] appdoc target in make system
David Gay
dgay42 at gmail.com
Mon Jun 4 14:08:21 PDT 2007
I've added an "appdoc" target to the make system which, in combination
with an update to nesdoc, generates per-app documentation. For
instance,
barnowl:~/motes/2.x/apps/Blink owl$ make mica2 appdoc
Making application documentation for BlinkAppC on mica2
...
This creates:
- a wiring graph for the current application (the whole app, not just
the top-level configuration) along with a clickable html file
- regular nesdoc stuff for all the components and interfaces used by
the app in build/<platform> (i.e. not in a central place)
The idea here is to make it easy to create a browsable version of the
current app, as opposed to our current nesdoc stuff which is more
intended for creating an API reference.
With this, you can actually browse your app in two ways:
- open <maincomponent>.html to get a rather overwhelming whole-app
graph (see attached Blink1.png)
- open build/<platform>/<maincomponent>.html to get a hierarchical
graph (i.e. it only has the top-level wiring) (see attached
Blink2.png)
We might want to make this second graph more available by moving it
out of build/<platform>... (though that will involve fixing some
links).
This is all made possible by the update to nesdoc that adds a "-app"
option to generate whole-app graphs.
David
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Blink1.png
Type: image/png
Size: 826535 bytes
Desc: not available
Url : http://mail.millennium.berkeley.edu/pipermail/tinyos-2.0wg/attachments/20070604/50810251/Blink1-0001.png
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Blink2.png
Type: image/png
Size: 20503 bytes
Desc: not available
Url : http://mail.millennium.berkeley.edu/pipermail/tinyos-2.0wg/attachments/20070604/50810251/Blink2-0001.png
More information about the Tinyos-2.0wg
mailing list