From d40ef30901022c14228e2cd65b5f8cfbdbebd197 Mon Sep 17 00:00:00 2001
From: Lutz Behnke <lutz.behnke@gmx.de>
Date: Wed, 21 Sep 2016 20:24:55 +0200
Subject: add info for param and returns tags

---
 lib/edoc/doc/overview.edoc | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'lib/edoc')

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}.)
-- 
cgit v1.2.3