Difference between revisions of "Nesdoc"
(New page: '''Nesdoc''' is a tool to generate documentation from Nesc source code. == Usage == To generate documentation of code you have to type: make platform docs == External links == *[http://...) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
== Usage == | == Usage == | ||
| + | Nesdoc interprets all comments of the source which begin by ''/**''. | ||
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. | ||
== External links == | == External links == | ||
*[http://webs.cs.berkeley.edu/tos/tinyos-1.x/doc/nesdoc Nesdoc docummentation] | *[http://webs.cs.berkeley.edu/tos/tinyos-1.x/doc/nesdoc Nesdoc docummentation] | ||
Latest revision as of 05: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.
