Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
tools:currydoc [2013-02-26 11:14] mh |
tools:currydoc [2020-12-22 23:18] mh |
||
|---|---|---|---|
| Line 13: | Line 13: | ||
| overlapping definitions) are provided and combined with | overlapping definitions) are provided and combined with | ||
| documentation comments provided by the programmer. | documentation comments provided by the programmer. | ||
| + | |||
| Line 29: | 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 | ||
| Line 43: | 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 which are translated into links inside | + | in Curry programs. These are translated into links inside |
| - | the generated HTML documentation. Such references have to be | + | the generated HTML documentation (if they are unqualified) or into links |
| - | 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 60: | Line 76: | ||
| | | ||
| --- The function `conc` concatenates two lists. | --- The function `conc` concatenates two lists. | ||
| + | --- It is also predefined as 'Prelude.++'. | ||
| --- @param xs - the first list | --- @param xs - the first list | ||
| --- @param ys - the second list | --- @param ys - the second list | ||
