kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 11:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Standardize examples

Browse Source 
Most examples in the XML documentation use the
example tag to demonstrate examples, which gets
parsed specially in the Wiki to make it easier
to follow for users.

This fixes a few modules to use the example
tag instead of vanilla para tags to bring them
in line with the standard syntax.

ASTERISK-29777 #close

Change-Id: I9acb6cc5faf1d220e73c6dd28592371d768d279b
This commit is contained in:
Naveen Albert
2021-11-25 18:41:18 +00:00
committed by N A
parent 1dce155f07
commit 6296f645a2
8 changed files with 78 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
res/res_xmpp.c
View File

@@ -84,9 +84,12 @@
<para>Sends the content of <replaceable>message</replaceable> as text message
from the given <replaceable>account</replaceable> to the buddy identified by
<replaceable>jid</replaceable></para>
<para>Example: JabberSend(asterisk,bob@domain.com,Hello world) sends "Hello world"
to <replaceable>bob@domain.com</replaceable> as an XMPP message from the account
<para>The example below sends "Hello world" to
<replaceable>bob@domain.com</replaceable> as an XMPP message from the account
<replaceable>asterisk</replaceable>, configured in xmpp.conf.</para>
<example title="Send 'Hello world' to Bob">
same => n,JabberSend(asterisk,bob@domain.com,Hello world)
</example>
</description>
<see-also>
<ref type="function" module="res_xmpp">JABBER_STATUS</ref>
@@ -113,9 +116,12 @@
<description>
<para>Receives a text message on the given <replaceable>account</replaceable>
from the buddy identified by <replaceable>jid</replaceable> and returns the contents.</para>
<para>Example: ${JABBER_RECEIVE(asterisk,bob@domain.com)} returns an XMPP message
sent from <replaceable>bob@domain.com</replaceable> (or nothing in case of a time out), to
<para>The example below returns an XMPP message sent from
<replaceable>bob@domain.com</replaceable> (or nothing in case of a time out), to
the <replaceable>asterisk</replaceable> XMPP account configured in xmpp.conf.</para>
<example title="Receive a message">
same => n,Set(msg=${JABBER_RECEIVE(asterisk,bob@domain.com)})
</example>
</description>
<see-also>
<ref type="function" module="res_xmpp">JABBER_STATUS</ref>