📄 nesdoc.html
字号:
<html><head><title>nesC Source Documentation</title></head><body><h1 align="center">nesC Source Documentation</h1><h3>Overview</h3> The nesC compiler includes a facility forautomatically generating documentation from nesC source code. Thebasic structure of the generated documentation is taken from thesource code, with one HTML file produced from each nesC source file.Documentation is not produced for items in included C files, or headerfiles.<p>Program authors can augment the automatically generated documentationby including specially formatted comments in their source code. Theformatting of these comments is patterned after the <ahref="http://java.sun.com/docs/books/jls/first_edition/html/18.doc.html">javadocdocumentation specification</a> from SUN's <a href="http://java.sun.com/docs/books/jls/first_edition/html/">Java language specification</a>.<p><h3>Documentation Comment Style</h3>Documentation comments in nesC must begin with the characters<code>/**</code>. (Note the additional <code>*</code> character,beyond the requirement for a normal comment.) These special commentsmay be placed in the following locations:<ul><li>At the beginning of a nesC source file.<li>Before command and event declarations in interfaces <li>Before command, event, or task definitions in component implementations<li>Before the declaration of component-global variables in component implementations<li>(hopefully soon) Before message struct declarations</ul><p>Within these comments, the first full sentance (ie, everything beforethe first '.' character) is used as a short description of the item,in various summary lists. The full text (including the firstsentance) is used for longer descriptions. <p>The documentation parser recognizes the following commands withindocumentation-style comments:<menu><dl><dt><b>@param</b> <font color="red">paramname</font> <fontcolor="blue">text text text</font><dd>Describes a parameter to a function<dt><b>@return</b> <font color="blue">text text text</font><dd>Describes the return value of a function<dt><b>@author</b> <font color="blue">text text text</font><dd>Lists an author of the file; multiple @author strings are allowed.<dt><b>@modified</b> <font color="blue">text text text</font><dd>Lists a modification.</dl></menu><p>Additionally, HTML tags can be embedded in documentation-stylecomments. This is useful for adding better formatting for things suchas bulleted lists, etc.<p><h3>Example</h3>The following source snippet illustrates the use ofdocumentation-style comments.<menu><code><pre>/** * One-line component description. * * More text goes here, to give more details to the description. * * @author Alice * @author Bob * @modified 3/3/2003 Added meaningful documentation. * **/module Foo { provides { interface SomeInteface; } uses { interface OtherInterface; }}implementation { /** * A state variable. Why not? **/ bool state; /** * Do some stuff. Doing some stuff is better than doing no stuff, * although not as good as doing all stuff. * * @param count The number of things to do. * @param size The size of each thing. * * @return Always returns <code>SUCCESS</code> **/ command result_t SomeInterface.doStuff(int count, int size) { OtherInterface.reallyDoStuff(count,size); return SUCCESS; } /** * Handle the response event generated by the * OtherInterface.reallyDoStuff() call. This event handler * currently does nothing. * * @return Always returns <code>SUCCESS</code> **/ event result_t OtherInterface.stuffDone() { return SUCCESS; }}</pre></code></menu><h3>Generating documentation</h3>Documentation generation is enabled by passing appropriate argumentsto the <code>nesdoc</code> program. It has similar syntax to the<code>ncc</code> compiler. For descriptions of these arguments, pleasesee the <a href="ncc.html">ncc man page</a>. To generatedocumentation, passing the same arguments to <code>nesdoc</code> asone passes to <code>ncc</code> to compile generally works. <h3>Installing Graphviz</h3>Basic HTML documentation can be generated with no specialinstallation. For nicer display of component graphs, however, werecommend that you install the graphviz package from AT&T. <p>Using graphviz requires that you have the freefont2 librariesinstalled. Although there are undoubtedly other ways to get thingsworking, the following steps are known to work on both linux andcygwin:<ol><li>Install freetype2, libjpeg, libpng, and libz. Links to these canbe found on the <a href="http://www.graphviz.org/">graphviz webpage</a>. <li>Install the latest version of graphviz from <a href="http://www.graphviz.org/">www.graphviz.org</a>. You willneed at least version 1.8.8. We have verified that things work withboth 1.8.8 and 1.8.9.</ol></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -