diff options
| author | Hans Bolinder <[email protected]> | 2016-10-05 08:31:09 +0200 |
|---|---|---|
| committer | Hans Bolinder <[email protected]> | 2016-10-05 08:31:09 +0200 |
| commit | 00a8242f61468bf3603623fce4781b2f1ab22513 (patch) | |
| tree | 6a534cdcd7838555ab44e48ebe9de162f5b3ac18 | |
| parent | fad45d54881152eea14e84a88eb7fbaa0ba0329b (diff) | |
| parent | 680945a01be052f1c68750ff1d386185bfad0788 (diff) | |
| download | otp-00a8242f61468bf3603623fce4781b2f1ab22513.tar.gz otp-00a8242f61468bf3603623fce4781b2f1ab22513.tar.bz2 otp-00a8242f61468bf3603623fce4781b2f1ab22513.zip | |
Merge branch 'maint'
* maint:
add info for param and returns tags
| -rw-r--r-- | lib/edoc/doc/overview.edoc | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/edoc/doc/overview.edoc b/lib/edoc/doc/overview.edoc index d2bba9d744..3a2118928a 100644 --- a/lib/edoc/doc/overview.edoc +++ b/lib/edoc/doc/overview.edoc @@ -377,6 +377,12 @@ The following tags can be used before a function definition: Useful for debug/test functions, etc. The content can be used as a comment; it is ignored by EDoc.</dd> + <dt><a name="ftag-param">`@param'</a></dt> + <dd>Provide more information on a single parameter of the + enclosing function. The content consists of a parameter name, + followed by one or more whitespace characters, and XHTML text. + </dd> + <dt><a name="ftag-private">`@private'</a></dt> <dd>Marks the function as private (i.e., not part of the public interface), so that it will not appear in the normal @@ -386,6 +392,10 @@ The following tags can be used before a function definition: always "private".) The content can be used as a comment; it is ignored by EDoc.</dd> + <dt><a name="ftag-returns">`@returns'</a></dt> + <dd>Specify additional information about the value returned by + the function. Content consists of XHTML text.</dd> + <dt><a name="ftag-see">`@see'</a></dt> <dd>Make a reference to a module, function, datatype, or application. (See {@section References}.) |