From 73321a9a56e3772852c3254cc1936cb17d0a635d Mon Sep 17 00:00:00 2001
From: Daniel-Constantin Mierla <miconda@gmail.com>
Date: Fri, 18 Feb 2022 09:01:56 +0100
Subject: [PATCH] async: docs for return parameter

---
 src/modules/async/doc/async_admin.xml | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/src/modules/async/doc/async_admin.xml b/src/modules/async/doc/async_admin.xml
index b0e5ec45bd2..4955f000360 100644
--- a/src/modules/async/doc/async_admin.xml
+++ b/src/modules/async/doc/async_admin.xml
@@ -108,6 +108,29 @@ modparam("async", "workers", 2)
 ...
 modparam("async", "ms_timer", 10)
 ...
+</programlisting>
+		</example>
+	</section>
+	<section>
+	<title>Parameters</title>
+	<section id="async.p.return">
+		<title><varname>return</varname> (int)</title>
+		<para>
+			The value to be returned by async functions on success. It does
+			not apply for async data functions, only for those that suspend
+			the SIP transaction.
+		</para>
+		<para>
+		<emphasis>
+			Default value is 0.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>workers</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("async", "return", 1)
+...
 </programlisting>
 		</example>
 	</section>