Difference between revisions of "Nesdoc"
| Line 5: | Line 5: | ||
To generate documentation of code you have to type: | To generate documentation of code you have to type: | ||
make platform docs | 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. | An example of documentation generated by nesdoc is the [[Source Code Documentation]] of TinyOS. | ||
== External links == | == External links == | ||
Latest revision as of 04:00, 26 February 2010
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.
