kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 15:45:18 +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 Friendly Automation
parent 2478bfcff9
commit 24a04054ad
8 changed files with 78 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
apps/app_mp3.c
View File

@@ -65,9 +65,11 @@
<description>
<para>Executes mpg123 to play the given location, which typically would be a mp3 filename
or m3u playlist filename or a URL. Please read http://en.wikipedia.org/wiki/M3U
to see how M3U playlist file format is like, Example usage would be
to see what the M3U playlist file format is like.</para>
<para>User can exit by pressing any key on the dialpad, or by hanging up.</para>
<example title="Play an MP3 playlist">
exten => 1234,1,MP3Player(/var/lib/asterisk/playlist.m3u)
User can exit by pressing any key on the dialpad, or by hanging up.</para>
</example>
<para>This application does not automatically answer and should be preceeded by an
application such as Answer() or Progress().</para>
</description>