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
This commit is contained in:
Naveen Albert
2025-09-29 12:15:39 -04:00
parent 683e2b435a
commit c92041f176

View File

@@ -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>