Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
tools:currydoc [2013-02-26 11:13] – mh | tools:currydoc [2020-12-22 23:18] (current) – mh | ||
---|---|---|---|
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 | ||
Line 42: | Line 58: | ||
In addition to Markdown or HTML markups, | In addition to Markdown or HTML markups, | ||
one can also mark **references to names** of operations or data types | one can also mark **references to names** of operations or data types | ||
- | in Curry programs | + | in Curry programs. These are translated into links inside |
- | the generated HTML documentation. Such references have to be | + | the generated HTML documentation |
- | enclosed in single quotes. | + | in other module documentations if they are qualified with a module name. |
+ | Such references have to be enclosed in single quotes. | ||
The following example shows a Curry program with some | The following example shows a Curry program with some | ||
Line 59: | Line 76: | ||
| | ||
--- The function `conc` concatenates two lists. | --- The function `conc` concatenates two lists. | ||
+ | --- It is also predefined as ' | ||
--- @param xs - the first list | --- @param xs - the first list | ||
--- @param ys - the second list | --- @param ys - the second list |