From: Naveen Albert <asterisk@phreaknet.org>
Date: Mon, 29 Sep 2025 16:15:39 +0000 (-0400)
Subject: func_scramble: Add example to XML documentation.
X-Git-Tag: 22.7.0-rc1~35
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ff8e8f3092eb3600361af723cb74058358a16f98;p=thirdparty%2Fasterisk.git

func_scramble: Add example to XML documentation.

The previous lack of an example made it ambiguous if the arguments went
inside the function arguments or were part of the right-hand value.

Resolves: #1485
---

diff --git a/funcs/func_scramble.c b/funcs/func_scramble.c
index d05ede6b01..f760e2efde 100644
--- a/funcs/func_scramble.c
+++ b/funcs/func_scramble.c
@@ -52,6 +52,9 @@
 			This is not intended to be used for securely scrambling
 			audio. It merely renders obfuscates audio on a channel
 			to render it unintelligible, as a privacy enhancement.</para>
+			<example title="Scramble speech in both directions">
+			same => n,Set(SCRAMBLE()=both)
+			</example>
 		</description>
 		<see-also>
 			<ref type="application">ChanSpy</ref>