diff options
| author | Sverker Eriksson <[email protected]> | 2016-10-26 17:37:35 +0200 |
|---|---|---|
| committer | Sverker Eriksson <[email protected]> | 2016-10-26 17:37:35 +0200 |
| commit | 42b9881d075344344a8c78026e282b40fa707a0c (patch) | |
| tree | d9755627cee82a99eff6755c8f092ed45dd7a71e /lib/edoc | |
| parent | 6408400fc1ca9609169f6a0450f1c4671aced91c (diff) | |
| parent | 1302b09c4aa0f944bdc0e3beeebb2cf84cc06c89 (diff) | |
| download | otp-42b9881d075344344a8c78026e282b40fa707a0c.tar.gz otp-42b9881d075344344a8c78026e282b40fa707a0c.tar.bz2 otp-42b9881d075344344a8c78026e282b40fa707a0c.zip | |
Merge branch 'master' into sverker/hipe-fun-purge
Diffstat (limited to 'lib/edoc')
| -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}.) |