diff options
author | Sverker Eriksson <[email protected]> | 2016-10-05 16:11:31 +0200 |
---|---|---|
committer | Sverker Eriksson <[email protected]> | 2016-10-05 16:11:31 +0200 |
commit | 502ed5fd6bd36328d6be63c68ee2a56738ced058 (patch) | |
tree | 80cfb83dd63ffa876541740cc067ea05bb39118d /lib/edoc/doc/overview.edoc | |
parent | cf102c1b1225450e7918a6119b7d949eb7e575c4 (diff) | |
parent | 0bac72a18e8a5f6a46baae9c9ac73bde32948ff6 (diff) | |
download | otp-502ed5fd6bd36328d6be63c68ee2a56738ced058.tar.gz otp-502ed5fd6bd36328d6be63c68ee2a56738ced058.tar.bz2 otp-502ed5fd6bd36328d6be63c68ee2a56738ced058.zip |
Merge branch 'master' into sverker/master/load_nif-print-init-error
Diffstat (limited to 'lib/edoc/doc/overview.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}.) |