[Tinyos-help] appdoc target with TinyOS 2.0.2

[David Gay]

[This got left out of the TinyOS 2.0.2 release information]

TinyOS 2.0.2, in conjunction with tinyos-tools 1.2.4, adds an "appdoc"
target to the make system which 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 the previous nesdoc support which was 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>/chtml/<maincomponent>.html to get a
hierarchical graph (i.e. it only has the top-level wiring) (see
attached Blink2.png)

This is all made possible by an update to nesdoc that adds a "-app"
option to generate whole-app graphs.

David Gay
-------------- 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-help/attachments/20070814/80914d2f/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-help/attachments/20070814/80914d2f/Blink2-0001.png