diff options
| author | Lutz Behnke <[email protected]> | 2016-09-21 20:24:55 +0200 |
|---|---|---|
| committer | Lutz Behnke <[email protected]> | 2016-10-04 08:07:38 +0200 |
| commit | d40ef30901022c14228e2cd65b5f8cfbdbebd197 (patch) | |
| tree | 8e30062256ca3cdfe2d96b8ee13f54c3828dd084 /lib/edoc/doc | |
| parent | a0abdb8631d7bd7a154023950ccdcbf09c85b92d (diff) | |
| download | otp-d40ef30901022c14228e2cd65b5f8cfbdbebd197.tar.gz otp-d40ef30901022c14228e2cd65b5f8cfbdbebd197.tar.bz2 otp-d40ef30901022c14228e2cd65b5f8cfbdbebd197.zip | |
add info for param and returns tags
Diffstat (limited to 'lib/edoc/doc')
| -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}.) |