Nesdoc

From TinyOS Wiki
(Redirected from NesDoc)
Jump to: navigation, search

Nesdoc is a tool to generate documentation from Nesc source code.

Usage

Nesdoc interprets all comments of the source which begin by /**. To generate documentation of code you have to type:

make platform docs

It can also be invoked alone. The command:

nesdoc -o doc -target=platform Interface.nc

creates all the XML files required. And then the command:

nesdoc -o doc -target=platform Interface.nc -html

creates the html files.

An example of documentation generated by nesdoc is the Source Code Documentation of TinyOS.

External links