diff options
Diffstat (limited to 'apps')
84 files changed, 250 insertions, 146 deletions
diff --git a/apps/app_adsiprog.c b/apps/app_adsiprog.c index d3e525460..21eed0991 100755 --- a/apps/app_adsiprog.c +++ b/apps/app_adsiprog.c @@ -19,6 +19,7 @@ /*! \file * \brief Program Asterisk ADSI Scripts into phone * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_alarmreceiver.c b/apps/app_alarmreceiver.c index 0d00d1d34..51419c806 100755 --- a/apps/app_alarmreceiver.c +++ b/apps/app_alarmreceiver.c @@ -18,6 +18,7 @@ /*! \file * \brief Central Station Alarm receiver for Ademco Contact ID + * \author Steve Rodgers <hwstar@rodgers.sdcoxmail.com> * * *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** * @@ -25,6 +26,7 @@ * * *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_authenticate.c b/apps/app_authenticate.c index 42309b2db..244f5b4ad 100755 --- a/apps/app_authenticate.c +++ b/apps/app_authenticate.c @@ -19,6 +19,7 @@ /*! \file * \brief Execute arbitrary authenticate commands * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_cdr.c b/apps/app_cdr.c index d8e8ecb58..4f87898d1 100755 --- a/apps/app_cdr.c +++ b/apps/app_cdr.c @@ -19,6 +19,7 @@ /*! \file * \brief Applications connected with CDR engine * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_chanisavail.c b/apps/app_chanisavail.c index 0f51481a9..be18f1a43 100755 --- a/apps/app_chanisavail.c +++ b/apps/app_chanisavail.c @@ -1,25 +1,26 @@ /* - * Asterisk -- An open source telephony toolkit. - * - * Copyright (C) 1999 - 2005, Digium, Inc. - * - * Mark Spencer <markster@digium.com> - * James Golovich <james@gnuinter.net> - * - * See http://www.asterisk.org for more information about - * the Asterisk project. Please do not directly contact - * any of the maintainers of this project for assistance; - * the project provides a web site, mailing lists and IRC - * channels for your use. - * - * This program is free software, distributed under the terms of - * the GNU General Public License Version 2. See the LICENSE file - * at the top of the source tree. - */ +* Asterisk -- An open source telephony toolkit. +* +* Copyright (C) 1999 - 2005, Digium, Inc. +* +* Mark Spencer <markster@digium.com> +* James Golovich <james@gnuinter.net> +* +* See http://www.asterisk.org for more information about +* the Asterisk project. Please do not directly contact +* any of the maintainers of this project for assistance; +* the project provides a web site, mailing lists and IRC +* channels for your use. +* +* This program is free software, distributed under the terms of +* the GNU General Public License Version 2. See the LICENSE file +* at the top of the source tree. +*/ /*! \file - * \brief Check if Channel is Available - * +* \brief Check if Channel is Available +* + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_chanspy.c b/apps/app_chanspy.c index d9dbd7cba..07b8d8d60 100755 --- a/apps/app_chanspy.c +++ b/apps/app_chanspy.c @@ -19,6 +19,7 @@ /*! \file * \brief ChanSpy: Listen in on any channel. * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_controlplayback.c b/apps/app_controlplayback.c index 5fabc51f4..41e060642 100755 --- a/apps/app_controlplayback.c +++ b/apps/app_controlplayback.c @@ -19,6 +19,7 @@ /*! \file * \brief Trivial application to control playback of a sound file * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_curl.c b/apps/app_curl.c index aa7f73731..7b2a962af 100755 --- a/apps/app_curl.c +++ b/apps/app_curl.c @@ -20,6 +20,7 @@ /*! \file * \brief Curl - App to load a URL * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_cut.c b/apps/app_cut.c index ab41d3437..7d210df28 100755 --- a/apps/app_cut.c +++ b/apps/app_cut.c @@ -18,6 +18,7 @@ /*! \file * \brief Cut application * + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_datetime.c b/apps/app_datetime.c index 7bae2fcbc..c384e3c88 100755 --- a/apps/app_datetime.c +++ b/apps/app_datetime.c @@ -19,6 +19,7 @@ /*! \file * \brief Time of day - Report the time of day * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_db.c b/apps/app_db.c index 0cc0344d5..cf62e378a 100755 --- a/apps/app_db.c +++ b/apps/app_db.c @@ -22,6 +22,7 @@ * * \brief Database access functions * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_dial.c b/apps/app_dial.c index 5b6192835..f0e399ec9 100755 --- a/apps/app_dial.c +++ b/apps/app_dial.c @@ -20,6 +20,7 @@ * * \brief dial() & retrydial() - Trivial application to dial a channel and send an URL on answer * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_dictate.c b/apps/app_dictate.c index 71c7fb863..0feee10b8 100755 --- a/apps/app_dictate.c +++ b/apps/app_dictate.c @@ -22,6 +22,7 @@ * * \brief Virtual Dictation Machine Application For Asterisk * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_directed_pickup.c b/apps/app_directed_pickup.c index 84f350746..400ee0728 100755 --- a/apps/app_directed_pickup.c +++ b/apps/app_directed_pickup.c @@ -20,6 +20,7 @@ * * \brief Directed Call Pickup Support * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_directory.c b/apps/app_directory.c index 8c54d74cc..75b724e6c 100755 --- a/apps/app_directory.c +++ b/apps/app_directory.c @@ -20,6 +20,7 @@ * * \brief Provide a directory of extensions * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_disa.c b/apps/app_disa.c index 842b8aaf0..5038e907a 100755 --- a/apps/app_disa.c +++ b/apps/app_disa.c @@ -3,7 +3,6 @@ * * Copyright (C) 1999 - 2005, Digium, Inc. * - * Jim Dixon <jim@lambdatel.com> * * Made only slightly more sane by Mark Spencer <markster@digium.com> * @@ -21,7 +20,10 @@ /*! \file * * \brief DISA -- Direct Inward System Access Application + * + * \author Jim Dixon <jim@lambdatel.com> * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_dumpchan.c b/apps/app_dumpchan.c index 2375f2261..3bdce81f7 100755 --- a/apps/app_dumpchan.c +++ b/apps/app_dumpchan.c @@ -22,6 +22,7 @@ * * \brief Application to dump channel variables * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_echo.c b/apps/app_echo.c index baf957780..2674d717b 100755 --- a/apps/app_echo.c +++ b/apps/app_echo.c @@ -20,6 +20,7 @@ * * \brief Echo application -- play back what you hear to evaluate latency * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_enumlookup.c b/apps/app_enumlookup.c index 0c3fca6de..41536b32f 100755 --- a/apps/app_enumlookup.c +++ b/apps/app_enumlookup.c @@ -20,6 +20,7 @@ * * \brief Enumlookup - lookup entry in ENUM * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_eval.c b/apps/app_eval.c index 3d6ab38d3..13ab0ddbc 100755 --- a/apps/app_eval.c +++ b/apps/app_eval.c @@ -19,6 +19,8 @@ * \brief Eval application * * \author Tilghman Lesher <app_eval__v001@the-tilghman.com> + * + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_exec.c b/apps/app_exec.c index 50a8a270e..9759455ac 100755 --- a/apps/app_exec.c +++ b/apps/app_exec.c @@ -20,6 +20,8 @@ * \brief Exec application * * \author Tilghman Lesher <app_exec__v001@the-tilghman.com> + * + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_externalivr.c b/apps/app_externalivr.c index 7a34acf67..c3e3c5627 100755 --- a/apps/app_externalivr.c +++ b/apps/app_externalivr.c @@ -23,6 +23,7 @@ * * \brief External IVR application interface * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_festival.c b/apps/app_festival.c index 539d245bb..03753642c 100755 --- a/apps/app_festival.c +++ b/apps/app_festival.c @@ -20,6 +20,7 @@ * * \brief Connect to festival * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_flash.c b/apps/app_flash.c index ee72e0f38..8ffe8497a 100755 --- a/apps/app_flash.c +++ b/apps/app_flash.c @@ -20,6 +20,7 @@ * * \brief App to flash a zap trunk * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_forkcdr.c b/apps/app_forkcdr.c index 6ccaab415..0019ec1a4 100755 --- a/apps/app_forkcdr.c +++ b/apps/app_forkcdr.c @@ -19,6 +19,7 @@ * * \brief Fork CDR application * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_getcpeid.c b/apps/app_getcpeid.c index 6a0467044..8ab85241e 100755 --- a/apps/app_getcpeid.c +++ b/apps/app_getcpeid.c @@ -18,8 +18,9 @@ /*! \file * - * \brief Execute arbitrary system commands + * \brief Get ADSI CPE ID * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_groupcount.c b/apps/app_groupcount.c index 8d7479c15..f47468acd 100755 --- a/apps/app_groupcount.c +++ b/apps/app_groupcount.c @@ -20,6 +20,7 @@ * * \brief Group Manipulation Applications * + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_hasnewvoicemail.c b/apps/app_hasnewvoicemail.c index bdf3014cb..6a96b58da 100755 --- a/apps/app_hasnewvoicemail.c +++ b/apps/app_hasnewvoicemail.c @@ -24,6 +24,7 @@ * * \brief HasVoicemail application * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_ices.c b/apps/app_ices.c index 1bc4b8ced..61fc18156 100755 --- a/apps/app_ices.c +++ b/apps/app_ices.c @@ -20,6 +20,7 @@ * * \brief Stream to an icecast server via ICES (see contrib/asterisk-ices.xml) * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_image.c b/apps/app_image.c index 0e43e2a3e..492bbab22 100755 --- a/apps/app_image.c +++ b/apps/app_image.c @@ -20,6 +20,7 @@ * * \brief App to transmit an image * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_intercom.c b/apps/app_intercom.c index 68409f9f8..ac2e897b4 100755 --- a/apps/app_intercom.c +++ b/apps/app_intercom.c @@ -20,6 +20,7 @@ * * \brief Use /dev/dsp as an intercom. * + * \ingroup applications */ #include <unistd.h> diff --git a/apps/app_ivrdemo.c b/apps/app_ivrdemo.c index 16cf45718..03c963e34 100755 --- a/apps/app_ivrdemo.c +++ b/apps/app_ivrdemo.c @@ -20,6 +20,7 @@ * * \brief IVR Demo application * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_lookupblacklist.c b/apps/app_lookupblacklist.c index 8285fd812..aafa81336 100755 --- a/apps/app_lookupblacklist.c +++ b/apps/app_lookupblacklist.c @@ -19,6 +19,8 @@ /*! \file * * \brief App to lookup the callerid number, and see if it is blacklisted + * + * \ingroup applications * */ diff --git a/apps/app_lookupcidname.c b/apps/app_lookupcidname.c index cf7d0496d..ca6d3e896 100755 --- a/apps/app_lookupcidname.c +++ b/apps/app_lookupcidname.c @@ -20,6 +20,7 @@ * * \brief App to set callerid name from database, based on directory number * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_macro.c b/apps/app_macro.c index 42e0c7801..ac9355473 100755 --- a/apps/app_macro.c +++ b/apps/app_macro.c @@ -20,6 +20,7 @@ * * \brief Dial plan macro Implementation * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_math.c b/apps/app_math.c index f74e1efee..e79219cee 100755 --- a/apps/app_math.c +++ b/apps/app_math.c @@ -20,6 +20,7 @@ * * \brief A simple math application * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_md5.c b/apps/app_md5.c index d30f3c216..27ec6eead 100755 --- a/apps/app_md5.c +++ b/apps/app_md5.c @@ -20,6 +20,7 @@ * \brief MD5 checksum application * * \todo Remove this deprecated application in 1.3dev + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_meetme.c b/apps/app_meetme.c index e5e02975b..5af4f7cbd 100755 --- a/apps/app_meetme.c +++ b/apps/app_meetme.c @@ -20,6 +20,7 @@ * * \brief Meet me conference bridge * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_milliwatt.c b/apps/app_milliwatt.c index d3a28039c..446fd150a 100755 --- a/apps/app_milliwatt.c +++ b/apps/app_milliwatt.c @@ -20,6 +20,7 @@ * * \brief Digital Milliwatt Test * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_mixmonitor.c b/apps/app_mixmonitor.c index 4391cfb18..ddf8f5248 100755 --- a/apps/app_mixmonitor.c +++ b/apps/app_mixmonitor.c @@ -23,6 +23,7 @@ /*! \file * \brief MixMonitor() - Record a call and mix the audio during the recording + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_mp3.c b/apps/app_mp3.c index 51844fa25..3a44067e0 100755 --- a/apps/app_mp3.c +++ b/apps/app_mp3.c @@ -20,6 +20,7 @@ * * \brief Silly application to play an MP3 file -- uses mpg123 * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_nbscat.c b/apps/app_nbscat.c index dbbc2b523..97af96755 100755 --- a/apps/app_nbscat.c +++ b/apps/app_nbscat.c @@ -20,6 +20,7 @@ * * \brief Silly application to play an NBScat file -- uses nbscat8k * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_osplookup.c b/apps/app_osplookup.c index 4cb8f2b04..79648f327 100755 --- a/apps/app_osplookup.c +++ b/apps/app_osplookup.c @@ -20,6 +20,7 @@ * * \brief Open Settlement Protocol Lookup * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_page.c b/apps/app_page.c index d2a65f4e8..218c9b2a5 100755 --- a/apps/app_page.c +++ b/apps/app_page.c @@ -20,6 +20,7 @@ * * \brief page() - Paging application * + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_parkandannounce.c b/apps/app_parkandannounce.c index 1db9101a5..a40c2efd7 100755 --- a/apps/app_parkandannounce.c +++ b/apps/app_parkandannounce.c @@ -23,6 +23,7 @@ * * \brief ParkAndAnnounce application for Asterisk * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_playback.c b/apps/app_playback.c index 5808197c4..2f280c950 100755 --- a/apps/app_playback.c +++ b/apps/app_playback.c @@ -20,6 +20,7 @@ * * \brief Trivial application to playback a sound file * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_privacy.c b/apps/app_privacy.c index d0b2e44cd..e41178950 100755 --- a/apps/app_privacy.c +++ b/apps/app_privacy.c @@ -20,6 +20,7 @@ * * \brief Block all calls without Caller*ID, require phone # to be entered * + * \ingroup applications */ #include <string.h> @@ -71,8 +72,7 @@ LOCAL_USER_DECL; -static int -privacy_exec (struct ast_channel *chan, void *data) +static int privacy_exec (struct ast_channel *chan, void *data) { int res=0; int retries; diff --git a/apps/app_queue.c b/apps/app_queue.c index 207cb5ee1..1047d21e3 100755 --- a/apps/app_queue.c +++ b/apps/app_queue.c @@ -19,8 +19,10 @@ /*! \file * * \brief True call queues with optional send URL on answer - * * + * \arg Config in \ref Config_qu queues.conf + * + * \par Development notes * \note 2004-11-25: Persistent Dynamic Members added by: * NetNation Communications (www.netnation.com) * Kevin Lindsay <kevinl@netnation.com> @@ -49,6 +51,7 @@ * Fixed to work with CVS as of 2004-02-25 and released as 1.07a * by Matthew Enger <m.enger@xi.com.au> * + * \ingroup applications */ #include <stdlib.h> @@ -192,15 +195,15 @@ static char *app_upqm_descrip = "same way, except it unpauses instead of pausing the given interface.\n" "Example: UnpauseQueueMember(|SIP/3000)\n"; -/* Persistent Members astdb family */ +/*! \brief Persistent Members astdb family */ static const char *pm_family = "/Queue/PersistentMembers"; /* The maximum lengh of each persistent member queue database entry */ #define PM_MAX_LEN 2048 -/* queues.conf [general] option */ +/*! \brief queues.conf [general] option */ static int queue_persistent_members = 0; -/* queues.conf per-queue weight option */ +/*! \brief queues.conf per-queue weight option */ static int use_weight = 0; enum queue_result { @@ -226,7 +229,7 @@ const struct { { QUEUE_FULL, "FULL" }, }; -/* We define a custom "local user" structure because we +/*! \brief We define a custom "local user" structure because we use it not only for keeping track of what is in use but also for keeping track of who we're dialing. */ @@ -244,34 +247,34 @@ struct localuser { LOCAL_USER_DECL; struct queue_ent { - struct ast_call_queue *parent; /* What queue is our parent */ - char moh[80]; /* Name of musiconhold to be used */ - char announce[80]; /* Announcement to play for member when call is answered */ - char context[AST_MAX_CONTEXT]; /* Context when user exits queue */ - char digits[AST_MAX_EXTENSION]; /* Digits entered while in queue */ - int pos; /* Where we are in the queue */ - int prio; /* Our priority */ - int last_pos_said; /* Last position we told the user */ - time_t last_periodic_announce_time; /* The last time we played a periodic anouncement */ - time_t last_pos; /* Last time we told the user their position */ - int opos; /* Where we started in the queue */ - int handled; /* Whether our call was handled */ - time_t start; /* When we started holding */ - time_t expire; /* When this entry should expire (time out of queue) */ - struct ast_channel *chan; /* Our channel */ - struct queue_ent *next; /* The next queue entry */ + struct ast_call_queue *parent; /*!< What queue is our parent */ + char moh[80]; /*!< Name of musiconhold to be used */ + char announce[80]; /*!< Announcement to play for member when call is answered */ + char context[AST_MAX_CONTEXT]; /*!< Context when user exits queue */ + char digits[AST_MAX_EXTENSION]; /*!< Digits entered while in queue */ + int pos; /*!< Where we are in the queue */ + int prio; /*!< Our priority */ + int last_pos_said; /*!< Last position we told the user */ + time_t last_periodic_announce_time; /*!< The last time we played a periodic anouncement */ + time_t last_pos; /*!< Last time we told the user their position */ + int opos; /*!< Where we started in the queue */ + int handled; /*!< Whether our call was handled */ + time_t start; /*!< When we started holding */ + time_t expire; /*!< When this entry should expire (time out of queue) */ + struct ast_channel *chan; /*!< Our channel */ + struct queue_ent *next; /*!< The next queue entry */ }; struct member { - char interface[80]; /* Technology/Location */ - int penalty; /* Are we a last resort? */ - int calls; /* Number of calls serviced by this member */ - int dynamic; /* Are we dynamically added? */ - int status; /* Status of queue member */ - int paused; /* Are we paused (not accepting calls)? */ - time_t lastcall; /* When last successful call was hungup */ - int dead; /* Used to detect members deleted in realtime */ - struct member *next; /* Next member */ + char interface[80]; /*!< Technology/Location */ + int penalty; /*!< Are we a last resort? */ + int calls; /*!< Number of calls serviced by this member */ + int dynamic; /*!< Are we dynamically added? */ + int status; /*!< Status of queue member */ + int paused; /*!< Are we paused (not accepting calls)? */ + time_t lastcall; /*!< When last successful call was hungup */ + int dead; /*!< Used to detect members deleted in realtime */ + struct member *next; /*!< Next member */ }; /* values used in multi-bit flags in ast_call_queue */ @@ -282,10 +285,10 @@ struct member { struct ast_call_queue { ast_mutex_t lock; - char name[80]; /* Name */ - char moh[80]; /* Music On Hold class to be used */ - char announce[80]; /* Announcement to play when call is answered */ - char context[AST_MAX_CONTEXT]; /* Exit context */ + char name[80]; /*!< Name */ + char moh[80]; /*!< Music On Hold class to be used */ + char announce[80]; /*!< Announcement to play when call is answered */ + char context[AST_MAX_CONTEXT]; /*!< Exit context */ unsigned int monjoin:1; unsigned int dead:1; unsigned int joinempty:2; @@ -298,41 +301,41 @@ struct ast_call_queue { unsigned int strategy:3; unsigned int maskmemberstatus:1; unsigned int realtime:1; - int announcefrequency; /* How often to announce their position */ - int periodicannouncefrequency; /* How often to play periodic announcement */ - int roundingseconds; /* How many seconds do we round to? */ - int holdtime; /* Current avg holdtime, based on recursive boxcar filter */ - int callscompleted; /* Number of queue calls completed */ - int callsabandoned; /* Number of queue calls abandoned */ - int servicelevel; /* seconds setting for servicelevel*/ - int callscompletedinsl; /* Number of calls answered with servicelevel*/ - char monfmt[8]; /* Format to use when recording calls */ - char sound_next[80]; /* Sound file: "Your call is now first in line" (def. queue-youarenext) */ - char sound_thereare[80]; /* Sound file: "There are currently" (def. queue-thereare) */ - char sound_calls[80]; /* Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting)*/ - char sound_holdtime[80]; /* Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */ - char sound_minutes[80]; /* Sound file: "minutes." (def. queue-minutes) */ - char sound_lessthan[80]; /* Sound file: "less-than" (def. queue-lessthan) */ - char sound_seconds[80]; /* Sound file: "seconds." (def. queue-seconds) */ - char sound_thanks[80]; /* Sound file: "Thank you for your patience." (def. queue-thankyou) */ - char sound_reporthold[80]; /* Sound file: "Hold time" (def. queue-reporthold) */ - char sound_periodicannounce[80];/* Sound file: Custom announce, no default */ - - int count; /* How many entries */ - int maxlen; /* Max number of entries */ - int wrapuptime; /* Wrapup Time */ - - int retry; /* Retry calling everyone after this amount of time */ - int timeout; /* How long to wait for an answer */ - int weight; /* Respective weight */ + int announcefrequency; /*!< How often to announce their position */ + int periodicannouncefrequency; /*!< How often to play periodic announcement */ + int roundingseconds; /*!< How many seconds do we round to? */ + int holdtime; /*!< Current avg holdtime, based on recursive boxcar filter */ + int callscompleted; /*!< Number of queue calls completed */ + int callsabandoned; /*!< Number of queue calls abandoned */ + int servicelevel; /*!< seconds setting for servicelevel*/ + int callscompletedinsl; /*!< Number of calls answered with servicelevel*/ + char monfmt[8]; /*!< Format to use when recording calls */ + char sound_next[80]; /*!< Sound file: "Your call is now first in line" (def. queue-youarenext) */ + char sound_thereare[80]; /*!< Sound file: "There are currently" (def. queue-thereare) */ + char sound_calls[80]; /*!< Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting)*/ + char sound_holdtime[80]; /*!< Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */ + char sound_minutes[80]; /*!< Sound file: "minutes." (def. queue-minutes) */ + char sound_lessthan[80]; /*!< Sound file: "less-than" (def. queue-lessthan) */ + char sound_seconds[80]; /*!< Sound file: "seconds." (def. queue-seconds) */ + char sound_thanks[80]; /*!< Sound file: "Thank you for your patience." (def. queue-thankyou) */ + char sound_reporthold[80]; /*!< Sound file: "Hold time" (def. queue-reporthold) */ + char sound_periodicannounce[80];/*!< Sound file: Custom announce, no default */ + + int count; /*!< How many entries */ + int maxlen; /*!< Max number of entries */ + int wrapuptime; /*!< Wrapup Time */ + + int retry; /*!< Retry calling everyone after this amount of time */ + int timeout; /*!< How long to wait for an answer */ + int weight; /*!< Respective weight */ /* Queue strategy things */ - int rrpos; /* Round Robin - position */ - int memberdelay; /* Seconds to delay connecting member to caller */ + int rrpos; /*!< Round Robin - position */ + int memberdelay; /*!< Seconds to delay connecting member to caller */ - struct member *members; /* Head of the list of members */ - struct queue_ent *head; /* Head of the list of callers */ - struct ast_call_queue *next; /* Next call queue */ + struct member *members; /*!< Head of the list of members */ + struct queue_ent *head; /*!< Head of the list of callers */ + struct ast_call_queue *next; /*!< Next call queue */ }; static struct ast_call_queue *queues = NULL; @@ -370,7 +373,7 @@ static int strat2int(const char *strategy) return -1; } -/* Insert the 'new' entry after the 'prev' entry of queue 'q' */ +/*! \brief Insert the 'new' entry after the 'prev' entry of queue 'q' */ static inline void insert_entry(struct ast_call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos) { struct queue_ent *cur; @@ -565,7 +568,8 @@ static void clear_queue(struct ast_call_queue *q) q->wrapuptime = 0; } -/* Configure a queue parameter. +/*! \brief Configure a queue parameter. +\par For error reporting, line number is passed for .conf static configuration. For Realtime queues, linenum is -1. The failunknown flag is set for config files (and static realtime) to show @@ -727,8 +731,9 @@ static void rt_handle_member_record(struct ast_call_queue *q, char *interface, c } -/* Reload a single queue via realtime. Return the queue, or NULL if it doesn't exist. - Should be called with the global qlock locked. +/*!\brief Reload a single queue via realtime. + \return Return the queue, or NULL if it doesn't exist. + \note Should be called with the global qlock locked. When found, the queue is returned with q->lock locked. */ static struct ast_call_queue *reload_queue_rt(const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config) { @@ -769,7 +774,7 @@ static struct ast_call_queue *reload_queue_rt(const char *queuename, struct ast_ if (!queue_vars) { /* Delete queue from in-core list if it has been deleted in realtime. */ if (q) { - /* Hmm, can't seem to distinguish a DB failure from a not + /*! \note Hmm, can't seem to distinguish a DB failure from a not found condition... So we might delete an in-core queue in case of DB failure. */ ast_log(LOG_DEBUG, "Queue %s not found in realtime.\n", queuename); @@ -865,7 +870,7 @@ static int join_queue(char *queuename, struct queue_ent *qe, enum queue_result * int inserted = 0; enum queue_member_status stat; - /* Load from realtime before taking the global qlock, to avoid blocking all + /*! \note Load from realtime before taking the global qlock, to avoid blocking all queue operations while waiting for the DB. This will be two separate database transactions, so we might @@ -3314,7 +3319,9 @@ static char *complete_queue(char *line, char *word, int pos, int state) return q ? strdup(q->name) : NULL; } -/* JDG: callback to display queues status in manager */ +/*!\brief callback to display queues status in manager + \addtogroup Group_AMI + */ static int manager_queues_show( struct mansession *s, struct message *m ) { char *a[] = { "show", "queues" }; diff --git a/apps/app_random.c b/apps/app_random.c index 08e1d188a..57ef4dd32 100755 --- a/apps/app_random.c +++ b/apps/app_random.c @@ -20,6 +20,7 @@ * \brief Random application * * \author Tilghman Lesher <asterisk__app_random__200508@the-tilghman.com> + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_read.c b/apps/app_read.c index ed4272da6..bae0440f8 100755 --- a/apps/app_read.c +++ b/apps/app_read.c @@ -20,6 +20,7 @@ * * \brief Trivial application to read a variable * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_readfile.c b/apps/app_readfile.c index 4012bc6a2..3340964b7 100755 --- a/apps/app_readfile.c +++ b/apps/app_readfile.c @@ -20,6 +20,7 @@ * * \brief ReadFile application -- Reads in a File for you. * + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_realtime.c b/apps/app_realtime.c index b0a810a8a..80f092528 100755 --- a/apps/app_realtime.c +++ b/apps/app_realtime.c @@ -21,6 +21,7 @@ * * \brief RealTime App * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_record.c b/apps/app_record.c index 150aac216..c856f344b 100755 --- a/apps/app_record.c +++ b/apps/app_record.c @@ -20,6 +20,7 @@ * * \brief Trivial application to record a sound file * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_sayunixtime.c b/apps/app_sayunixtime.c index 9c126a167..1f9244607 100755 --- a/apps/app_sayunixtime.c +++ b/apps/app_sayunixtime.c @@ -19,6 +19,7 @@ * * \brief SayUnixTime application * + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_senddtmf.c b/apps/app_senddtmf.c index f9493f716..b0c9dc07a 100755 --- a/apps/app_senddtmf.c +++ b/apps/app_senddtmf.c @@ -20,6 +20,7 @@ * * \brief App to send DTMF digits * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_sendtext.c b/apps/app_sendtext.c index 7bdf1d265..252c95747 100755 --- a/apps/app_sendtext.c +++ b/apps/app_sendtext.c @@ -20,6 +20,9 @@ * * \brief App to transmit a text message * + * Requires support of sending text messages from channel driver + * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_setcallerid.c b/apps/app_setcallerid.c index 18343b786..272d18926 100755 --- a/apps/app_setcallerid.c +++ b/apps/app_setcallerid.c @@ -20,6 +20,7 @@ * * \brief App to set callerid * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_setcdruserfield.c b/apps/app_setcdruserfield.c index 28e1846f0..460bbc33e 100755 --- a/apps/app_setcdruserfield.c +++ b/apps/app_setcdruserfield.c @@ -20,6 +20,7 @@ * * \brief Applictions connected with CDR engine * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_setcidname.c b/apps/app_setcidname.c index 2dab53812..41dfda706 100755 --- a/apps/app_setcidname.c +++ b/apps/app_setcidname.c @@ -20,6 +20,7 @@ * * \brief App to set callerid * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_setcidnum.c b/apps/app_setcidnum.c index a4405fdf4..d3129441f 100755 --- a/apps/app_setcidnum.c +++ b/apps/app_setcidnum.c @@ -21,6 +21,7 @@ * * \brief App to set callerid number * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_setrdnis.c b/apps/app_setrdnis.c index ff477baa8..992732bf7 100755 --- a/apps/app_setrdnis.c +++ b/apps/app_setrdnis.c @@ -21,6 +21,7 @@ * * \brief App to set rdnis * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_settransfercapability.c b/apps/app_settransfercapability.c index 95f28f124..5ee1ab831 100755 --- a/apps/app_settransfercapability.c +++ b/apps/app_settransfercapability.c @@ -20,6 +20,7 @@ * * \brief App to set the ISDN Transfer Capability * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_skel.c b/apps/app_skel.c index f391cb64b..88a9a280b 100755 --- a/apps/app_skel.c +++ b/apps/app_skel.c @@ -20,6 +20,8 @@ * * \brief Skeleton application * + * This is a skeleton for development of an Asterisk application */ + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_sms.c b/apps/app_sms.c index dd553a195..c6d44941b 100755 --- a/apps/app_sms.c +++ b/apps/app_sms.c @@ -17,6 +17,7 @@ /*! \file * * \brief SMS application - ETSI ES 201 912 protocol 1 implimentation + * \ingroup applications * */ diff --git a/apps/app_softhangup.c b/apps/app_softhangup.c index 66c7c412b..d8eb6f3b4 100755 --- a/apps/app_softhangup.c +++ b/apps/app_softhangup.c @@ -20,6 +20,7 @@ * * \brief SoftHangup application * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_sql_postgres.c b/apps/app_sql_postgres.c index 65a0f14d2..d9ba1bfb7 100755 --- a/apps/app_sql_postgres.c +++ b/apps/app_sql_postgres.c @@ -20,6 +20,7 @@ * * \brief Connect to PostgreSQL * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_striplsd.c b/apps/app_striplsd.c index 597bca9d9..88810576d 100755 --- a/apps/app_striplsd.c +++ b/apps/app_striplsd.c @@ -20,6 +20,7 @@ * * \brief striplsd: Strip trailing digits app * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_substring.c b/apps/app_substring.c index 4f9a16066..dbaafd849 100755 --- a/apps/app_substring.c +++ b/apps/app_substring.c @@ -20,6 +20,7 @@ * * \brief substr * + * \ingroup applications * \todo Deprecate this application in 1.3dev */ diff --git a/apps/app_system.c b/apps/app_system.c index 76593f60f..c21c0ed9b 100755 --- a/apps/app_system.c +++ b/apps/app_system.c @@ -20,6 +20,7 @@ * * \brief Execute arbitrary system commands * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_talkdetect.c b/apps/app_talkdetect.c index 207d46e55..7f197ce88 100755 --- a/apps/app_talkdetect.c +++ b/apps/app_talkdetect.c @@ -20,6 +20,7 @@ * * \brief Playback a file with audio detect * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_test.c b/apps/app_test.c index 8a3c8c22a..56b5bf2b9 100755 --- a/apps/app_test.c +++ b/apps/app_test.c @@ -21,6 +21,7 @@ * * \brief Applications to test connection and produce report in text file * + * \ingroup applications */ #include <sys/types.h> diff --git a/apps/app_transfer.c b/apps/app_transfer.c index 4b4fb1c5d..b6ba16faa 100755 --- a/apps/app_transfer.c +++ b/apps/app_transfer.c @@ -20,6 +20,9 @@ * * \brief Transfer a caller * + * Requires transfer support from channel driver + * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_txtcidname.c b/apps/app_txtcidname.c index 18aa0cba9..dcede42ed 100755 --- a/apps/app_txtcidname.c +++ b/apps/app_txtcidname.c @@ -20,6 +20,7 @@ * * \brief Caller*id name lookup - Look up the caller's name via DNS * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_url.c b/apps/app_url.c index d9451dba5..b44fb218b 100755 --- a/apps/app_url.c +++ b/apps/app_url.c @@ -19,6 +19,7 @@ /*! \file * \brief App to transmit a URL * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_userevent.c b/apps/app_userevent.c index 8fc8fcdba..74fa58f2a 100755 --- a/apps/app_userevent.c +++ b/apps/app_userevent.c @@ -18,6 +18,7 @@ * * \brief UserEvent application -- send manager event * + * \ingroup applications */ diff --git a/apps/app_verbose.c b/apps/app_verbose.c index 28ccfa867..f8532ff24 100755 --- a/apps/app_verbose.c +++ b/apps/app_verbose.c @@ -19,6 +19,7 @@ * * \brief Verbose logging application * + * \ingroup applications */ #include <stdio.h> diff --git a/apps/app_voicemail.c b/apps/app_voicemail.c index 03448726f..975ffe58e 100755 --- a/apps/app_voicemail.c +++ b/apps/app_voicemail.c @@ -29,6 +29,9 @@ * * \brief Comedian Mail - Voicemail System * + * \par See also + * \arg \ref Config_vm + * \ingroup applications */ #include <stdlib.h> @@ -130,59 +133,62 @@ AST_APP_OPTIONS(vm_app_options, { static int load_config(void); -/* Syntaxes supported, not really language codes. - en - English - de - German - es - Spanish - fr - French - it = Italian - nl - Dutch - pt - Portuguese - gr - Greek - no - Norwegian - se - Swedish +/*! \page vmlang Voicemail Language Syntaxes Supported + + \par Syntaxes supported, not really language codes. + \arg \b en - English + \arg \b de - German + \arg \b es - Spanish + \arg \b fr - French + \arg \b it = Italian + \arg \b nl - Dutch + \arg \b pt - Portuguese + \arg \b gr - Greek + \arg \b no - Norwegian + \arg \b se - Swedish German requires the following additional soundfile: -1F einE (feminine) +\arg \b 1F einE (feminine) Spanish requires the following additional soundfile: -1M un (masculine) +\arg \b 1M un (masculine) Dutch, Portuguese & Spanish require the following additional soundfiles: -vm-INBOXs singular of 'new' -vm-Olds singular of 'old/heard/read' +\arg \b vm-INBOXs singular of 'new' +\arg \b vm-Olds singular of 'old/heard/read' NB these are plural: -vm-INBOX nieuwe (nl) -vm-Old oude (nl) +\arg \b vm-INBOX nieuwe (nl) +\arg \b vm-Old oude (nl) Swedish uses: -vm-nytt singular of 'new' -vm-nya plural of 'new' -vm-gammalt singular of 'old' -vm-gamla plural of 'old' -digits/ett 'one', not always same as 'digits/1' +\arg \b vm-nytt singular of 'new' +\arg \b vm-nya plural of 'new' +\arg \b vm-gammalt singular of 'old' +\arg \b vm-gamla plural of 'old' +\arg \b digits/ett 'one', not always same as 'digits/1' Norwegian uses: -vm-ny singular of 'new' -vm-nye plural of 'new' -vm-gammel singular of 'old' -vm-gamle plural of 'old' +\arg \b vm-ny singular of 'new' +\arg \b vm-nye plural of 'new' +\arg \b vm-gammel singular of 'old' +\arg \b vm-gamle plural of 'old' Dutch also uses: -nl-om 'at'? +\arg \b nl-om 'at'? Spanish also uses: -vm-youhaveno +\arg \b vm-youhaveno Italian requires the following additional soundfile: For vm_intro_it: -vm-nuovo new -vm-nuovi new plural -vm-vecchio old -vm-vecchi old plural -Don't use vm-INBOX or vm-Old, because they are the name of the INBOX and Old folders, +\arg \b vm-nuovo new +\arg \b vm-nuovi new plural +\arg \b vm-vecchio old +\arg \b vm-vecchi old plural + +\note Don't use vm-INBOX or vm-Old, because they are the name of the INBOX and Old folders, spelled among others when you have to change folder. For the above reasons, vm-INBOX and vm-Old are spelled plural, to make them sound more as folder name than an adjective. @@ -196,25 +202,25 @@ struct baseio { unsigned char iobuf[BASEMAXINLINE]; }; -/* Structure for linked list of users */ +/*! Structure for linked list of users */ struct ast_vm_user { - char context[AST_MAX_CONTEXT]; /* Voicemail context */ - char mailbox[AST_MAX_EXTENSION];/* Mailbox id, unique within vm context */ - char password[80]; /* Secret pin code, numbers only */ - char fullname[80]; /* Full name, for directory app */ - char email[80]; /* E-mail address */ - char pager[80]; /* E-mail address to pager (no attachment) */ - char serveremail[80]; /* From: Mail address */ - char mailcmd[160]; /* Configurable mail command */ - char language[MAX_LANGUAGE]; /* Config: Language setting */ - char zonetag[80]; /* Time zone */ + char context[AST_MAX_CONTEXT]; /*!< Voicemail context */ + char mailbox[AST_MAX_EXTENSION];/*!< Mailbox id, unique within vm context */ + char password[80]; /*!< Secret pin code, numbers only */ + char fullname[80]; /*!< Full name, for directory app */ + char email[80]; /*!< E-mail address */ + char pager[80]; /*!< E-mail address to pager (no attachment) */ + char serveremail[80]; /*!< From: Mail address */ + char mailcmd[160]; /*!< Configurable mail command */ + char language[MAX_LANGUAGE]; /*!< Config: Language setting */ + char zonetag[80]; /*!< Time zone */ char callback[80]; char dialout[80]; - char uniqueid[20]; /* Unique integer identifier */ + char uniqueid[20]; /*!< Unique integer identifier */ char exit[80]; - unsigned int flags; /* VM_ flags */ + unsigned int flags; /*!< VM_ flags */ int saydurationm; - int maxmsg; /* Maximum number of msgs per folder for this mailbox */ + int maxmsg; /*!< Maximum number of msgs per folder for this mailbox */ struct ast_vm_user *next; }; diff --git a/apps/app_waitforring.c b/apps/app_waitforring.c index 07e85f2d2..0de20560f 100755 --- a/apps/app_waitforring.c +++ b/apps/app_waitforring.c @@ -20,6 +20,7 @@ * * \brief Wait for Ring Application * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_waitforsilence.c b/apps/app_waitforsilence.c index d9274b441..79d2b2274 100755 --- a/apps/app_waitforsilence.c +++ b/apps/app_waitforsilence.c @@ -22,10 +22,11 @@ /*! \file * * \brief Wait for Silence - * - Waits for up to 'x' milliseconds of silence, 'y' times - * - WaitForSilence(500,2) will wait for 1/2 second of silence, twice - * - WaitForSilence(1000,1) will wait for 1 second of silence, once + * - Waits for up to 'x' milliseconds of silence, 'y' times \n + * - WaitForSilence(500,2) will wait for 1/2 second of silence, twice \n + * - WaitForSilence(1000,1) will wait for 1 second of silence, once \n * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_while.c b/apps/app_while.c index 5436cd3c9..757171ad1 100755 --- a/apps/app_while.c +++ b/apps/app_while.c @@ -20,6 +20,7 @@ * * \brief While Loop and ExecIf Implementations * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_zapateller.c b/apps/app_zapateller.c index 9d3ab1209..e3d55c056 100755 --- a/apps/app_zapateller.c +++ b/apps/app_zapateller.c @@ -20,6 +20,7 @@ * * \brief Playback the special information tone to get rid of telemarketers * + * \ingroup applications */ #include <string.h> diff --git a/apps/app_zapbarge.c b/apps/app_zapbarge.c index d9404a4a8..9511c4f6b 100755 --- a/apps/app_zapbarge.c +++ b/apps/app_zapbarge.c @@ -23,6 +23,7 @@ * * \brief Zap Barge support * + * \ingroup applications */ #include <stdlib.h> diff --git a/apps/app_zapras.c b/apps/app_zapras.c index 9edb56d0b..a36191455 100755 --- a/apps/app_zapras.c +++ b/apps/app_zapras.c @@ -20,6 +20,7 @@ * * \brief Execute an ISDN RAS * + * \ingroup applications */ #include <sys/ioctl.h> diff --git a/apps/app_zapscan.c b/apps/app_zapscan.c index df215b45a..f016cb514 100755 --- a/apps/app_zapscan.c +++ b/apps/app_zapscan.c @@ -25,6 +25,7 @@ * * \brief Zap Scanner * + * \ingroup applications */ #include <stdlib.h> |