Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
tools:currydoc [2013-02-26 11:13] – mh | tools:currydoc [2014-06-13 12:35] – external edit 127.0.0.1 | ||
---|---|---|---|
Line 15: | Line 15: | ||
- | ==== Short Summary | + | |
+ | |||
+ | ==== Short Description | ||
A **documentation comment** starts at the beginning of a line | A **documentation comment** starts at the beginning of a line | ||
Line 28: | Line 30: | ||
end of the comment. The following tags are recognized: | end of the comment. The following tags are recognized: | ||
- | | + | @author comment |
- | | + | |
- | | + | Specifies the author of a module (only reasonable in module comments). |
- | | + | |
- | | + | @version comment |
+ | |||
+ | Specifies the version of a module (only reasonable in module comments). | ||
+ | |||
+ | @cons id comment | ||
+ | |||
+ | A comment for the constructor '' | ||
+ | |||
+ | @param id comment | ||
+ | |||
+ | A comment for function parameter '' | ||
+ | |||
+ | @return comment | ||
+ | |||
+ | A comment for the return value of a function (only reasonable in function comments). | ||
The comment of a documented entity can be any string in | The comment of a documented entity can be any string in |