summaryrefslogtreecommitdiff
path: root/apps
diff options
context:
space:
mode:
authorEliel C. Sardanons <eliels@gmail.com>2008-11-05 14:37:07 +0000
committerEliel C. Sardanons <eliels@gmail.com>2008-11-05 14:37:07 +0000
commit990a6bebe8a69146b4c7fe8c522d45790190d4e0 (patch)
tree97eea242d5a6caaf848079444598c7800255fdd0 /apps
parentf3d95a2131346e946185734b2743be0afdb519e3 (diff)
Add more SeeAlso references based on TFOT.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@154647 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps')
-rw-r--r--apps/app_alarmreceiver.c14
-rw-r--r--apps/app_amd.c4
-rw-r--r--apps/app_morsecode.c6
-rw-r--r--apps/app_privacy.c3
-rw-r--r--apps/app_sayunixtime.c5
5 files changed, 27 insertions, 5 deletions
diff --git a/apps/app_alarmreceiver.c b/apps/app_alarmreceiver.c
index 12ae49d65..6b34dfb54 100644
--- a/apps/app_alarmreceiver.c
+++ b/apps/app_alarmreceiver.c
@@ -66,16 +66,22 @@ static char *app = "AlarmReceiver";
/*** DOCUMENTATION
<application name="AlarmReceiver" language="en_US">
<synopsis>
- Provide support for receiving alarm reports from a burglar or fire alarm panel
+ Provide support for receiving alarm reports from a burglar or fire alarm panel.
</synopsis>
<syntax />
<description>
<para>This application should be called whenever there is an alarm panel calling in to dump its events.
- The application will handshake with the alarm panel, and receive events, validate them, handshake them, and store them until the panel hangs up.
- Once the panel hangs up, the application will run the system command specified by the eventcmd setting in <filename>alarmreceiver.conf</filename> and pipe the events to the standard input of the application.
- The configuration file also contains settings for DTMF timing, and for the loudness of the acknowledgement tones.</para>
+ The application will handshake with the alarm panel, and receive events, validate them, handshake them,
+ and store them until the panel hangs up. Once the panel hangs up, the application will run the system
+ command specified by the eventcmd setting in <filename>alarmreceiver.conf</filename> and pipe the
+ events to the standard input of the application.
+ The configuration file also contains settings for DTMF timing, and for the loudness of the
+ acknowledgement tones.</para>
<note><para>Only 1 signalling format is supported at this time: Ademco Contact ID.</para></note>
</description>
+ <see-also>
+ <ref type="filename">alarmreceiver.conf</ref>
+ </see-also>
</application>
***/
diff --git a/apps/app_amd.c b/apps/app_amd.c
index bf3603b3e..56fa10fd2 100644
--- a/apps/app_amd.c
+++ b/apps/app_amd.c
@@ -116,6 +116,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variable>
</variablelist>
</description>
+ <see-also>
+ <ref type="application">WaitForSilence</ref>
+ <ref type="application">WaitForNoise</ref>
+ </see-also>
</application>
***/
diff --git a/apps/app_morsecode.c b/apps/app_morsecode.c
index f9005296a..25b5c49e3 100644
--- a/apps/app_morsecode.c
+++ b/apps/app_morsecode.c
@@ -37,7 +37,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
/*** DOCUMENTATION
<application name="Morsecode" language="en_US">
<synopsis>
- Plays morse code
+ Plays morse code.
</synopsis>
<syntax>
<parameter name="string" required="true">
@@ -57,6 +57,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variable>
</variablelist>
</description>
+ <see-also>
+ <ref type="application">SayAlpha</ref>
+ <ref type="application">SayPhonetic</ref>
+ </see-also>
</application>
***/
static char *app_morsecode = "Morsecode";
diff --git a/apps/app_privacy.c b/apps/app_privacy.c
index 71811de1c..a2e7152b7 100644
--- a/apps/app_privacy.c
+++ b/apps/app_privacy.c
@@ -71,6 +71,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variable>
</variablelist>
</description>
+ <see-also>
+ <ref type="application">Zapateller</ref>
+ </see-also>
</application>
***/
diff --git a/apps/app_sayunixtime.c b/apps/app_sayunixtime.c
index f6122e40d..a4dc0afdc 100644
--- a/apps/app_sayunixtime.c
+++ b/apps/app_sayunixtime.c
@@ -57,6 +57,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Uses some of the sound files stored in <directory>/var/lib/asterisk/sounds</directory> to construct a phrase
saying the specified date and/or time in the specified format. </para>
</description>
+ <see-also>
+ <ref type="function">STRFTIME</ref>
+ <ref type="function">STRPTIME</ref>
+ <ref type="function">IFTIME</ref>
+ </see-also>
</application>
<application name="DateTime" language="en_US">
<synopsis>