Differences

This shows you the differences between two versions of the page.

--- tools:currydoc [2013-02-26 11:14]
mh
+++ tools:currydoc [2013-02-26 11:16]
mh
@@ Line 13: / Line 13: @@
 overlapping definitions) are provided and combined with
 documentation comments provided by the programmer.
@@ Line 29: / Line 30: @@
 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

/srv/dokuwiki/currywiki/data/pages/tools/currydoc.txt · Last modified: 2020-12-22 23:18 by mh

Back to top