Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
tools:currydoc [2013-02-26 11:13] mh |
tools:currydoc [2014-06-13 12:35] 127.0.0.1 external edit |
||
---|---|---|---|
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). | + | @author comment |
- | * ''@version comment'': Specifies the version of a module (only reasonable in module comments). | + | |
- | * ''@cons id comment'': A comment for the constructor ''id'' of a datatype (only reasonable in datatype comments). | + | Specifies the author of a module (only reasonable in module comments). |
- | * ''@param id comment'': A comment for function parameter ''id'' (only reasonable in function comments). Due to pattern matching, this need not be the name of a parameter given in the declaration of the function but all parameters for this functions must be commented in left-to-right order. | + | |
- | * ''@return comment'': A comment for the return value of a function (only reasonable in function comments). | + | @version comment |
+ | |||
+ | Specifies the version of a module (only reasonable in module comments). | ||
+ | |||
+ | @cons id comment | ||
+ | |||
+ | A comment for the constructor ''id'' of a datatype (only reasonable in datatype comments). | ||
+ | |||
+ | @param id comment | ||
+ | |||
+ | A comment for function parameter ''id'' (only reasonable in function comments). Due to pattern matching, this need not be the name of a parameter given in the declaration of the function but all parameters for this functions must be commented in left-to-right order. | ||
+ | |||
+ | @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 |