From 8a02ac6f79bc387a0c0e51c1387604593a015f1e Mon Sep 17 00:00:00 2001 From: Steve Murphy Date: Thu, 27 Mar 2008 13:03:28 +0000 Subject: [PATCH] These small documentation updates made in response to a query in asterisk-users, where a user was using Playback, but needed the features of Background, and had no idea that Background existed, or that it might provide the features he needed. I thought the best way to avert these kinds of queries was to provide "See Also" references in all three of "Background", "Playback", "WaitExten". Perhaps a project to do this with all related apps is in order. git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.4@111391 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- apps/app_playback.c | 2 ++ main/pbx.c | 3 +++ 2 files changed, 5 insertions(+) diff --git a/apps/app_playback.c b/apps/app_playback.c index ae06b59a80..d02a146c5c 100644 --- a/apps/app_playback.c +++ b/apps/app_playback.c @@ -65,6 +65,8 @@ static char *descrip = "This application sets the following channel variable upon completion:\n" " PLAYBACKSTATUS The status of the playback attempt as a text string, one of\n" " SUCCESS | FAILED\n" +"See Also: Background (application) -- for playing soundfiles that are interruptible\n" +" WaitExten (application) -- wait for digits from caller, optionally play music on hold\n" ; diff --git a/main/pbx.c b/main/pbx.c index 8d2aa108da..41027c35a1 100644 --- a/main/pbx.c +++ b/main/pbx.c @@ -288,6 +288,8 @@ static struct pbx_builtin { " n - Don't answer the channel before playing the files.\n" " m - Only break if a digit hit matches a one digit\n" " extension in the destination context.\n" + "See Also: Playback (application) -- Play sound file(s) to the channel,\n" + " that cannot be interrupted\n" }, { "Busy", pbx_builtin_busy, @@ -485,6 +487,7 @@ static struct pbx_builtin { " Options:\n" " m[(x)] - Provide music on hold to the caller while waiting for an extension.\n" " Optionally, specify the class for music on hold within parenthesis.\n" + "See Also: Playback(application), Background(application).\n" }, };