Update of /usr/cvsroot/asterisk/channels
In directory mongoose.digium.com:/tmp/cvs-serv2786/channels

Modified Files:
        chan_agent.c chan_alsa.c chan_features.c chan_h323.c 
        chan_iax2.c chan_local.c chan_mgcp.c chan_misdn.c 
        chan_misdn_config.c chan_modem.c chan_modem_aopen.c 
        chan_modem_bestdata.c chan_modem_i4l.c chan_nbs.c chan_oss.c 
        chan_oss_old.c chan_phone.c chan_skinny.c chan_vpb.c 
        chan_zap.c 
Log Message:
issue #5605


Index: chan_agent.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_agent.c,v
retrieving revision 1.165
retrieving revision 1.166
diff -u -d -r1.165 -r1.166
--- chan_agent.c        3 Nov 2005 21:19:10 -0000       1.165
+++ chan_agent.c        6 Nov 2005 15:09:46 -0000       1.166
@@ -18,10 +18,14 @@
 
 
 /*! \file
- * \brief Implementation of Agents
+ * \brief Implementation of Agents (proxy channel)
  *
  * This file is the implementation of Agents modules.
- * It is a dynamic module that is loaded by Asterisk. At load time, 
load_module is run.
+ * It is a dynamic module that is loaded by Asterisk. 
+ * \par See also
+ * \arg \ref Config_agent
+ *
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_alsa.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_alsa.c,v
retrieving revision 1.51
retrieving revision 1.52
diff -u -d -r1.51 -r1.52
--- chan_alsa.c 27 Oct 2005 02:19:37 -0000      1.51
+++ chan_alsa.c 6 Nov 2005 15:09:46 -0000       1.52
@@ -18,6 +18,11 @@
 
 /*! \file 
  * \brief ALSA sound card channel driver 
+ *
+ * \par See also
+ * \arg Config_alsa
+ *
+ * \ingroup channel_drivers
  */
 
 

Index: chan_features.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_features.c,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19
--- chan_features.c     24 Oct 2005 20:12:05 -0000      1.18
+++ chan_features.c     6 Nov 2005 15:09:46 -0000       1.19
@@ -22,6 +22,7 @@
  * 
  * \note *** Experimental code ****
  * 
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_h323.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_h323.c,v
retrieving revision 1.132
retrieving revision 1.133
diff -u -d -r1.132 -r1.133
--- chan_h323.c 27 Oct 2005 02:19:37 -0000      1.132
+++ chan_h323.c 6 Nov 2005 15:09:46 -0000       1.133
@@ -25,6 +25,10 @@
  *
  * \brief This file is part of the chan_h323 driver for Asterisk
  *
+ * \par See also
+ * \arg Config_h323
+ *
+ * \ingroup channel_drivers
  */
 
 #include <sys/socket.h>

Index: chan_iax2.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_iax2.c,v
retrieving revision 1.370
retrieving revision 1.371
diff -u -d -r1.370 -r1.371
--- chan_iax2.c 6 Nov 2005 05:52:26 -0000       1.370
+++ chan_iax2.c 6 Nov 2005 15:09:46 -0000       1.371
@@ -20,6 +20,10 @@
  *
  * \brief Implementation of Inter-Asterisk eXchange Version 2
  *
+ * \par See also
+ * \arg \ref Config_iax
+ *
+ * \ingroup channel_drivers
  */
 
 #include "asterisk.h"
@@ -7694,6 +7698,9 @@
 "the calling entity is in fact an IAXy) with the given template or\n"
 "default if one is not specified.  Returns -1 on error or 0 on success.\n";
 
+/*! iax2provision
+\ingroup applications
+*/
 static int iax2_prov_app(struct ast_channel *chan, void *data)
 {
        int res;

Index: chan_local.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_local.c,v
retrieving revision 1.55
retrieving revision 1.56
diff -u -d -r1.55 -r1.56
--- chan_local.c        24 Oct 2005 20:12:05 -0000      1.55
+++ chan_local.c        6 Nov 2005 15:09:46 -0000       1.56
@@ -20,6 +20,7 @@
  *
  * \brief Local Proxy Channel
  * 
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_mgcp.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_mgcp.c,v
retrieving revision 1.132
retrieving revision 1.133
diff -u -d -r1.132 -r1.133
--- chan_mgcp.c 27 Oct 2005 02:19:37 -0000      1.132
+++ chan_mgcp.c 6 Nov 2005 15:09:46 -0000       1.133
@@ -20,6 +20,10 @@
  *
  * \brief Implementation of Media Gateway Control Protocol
  * 
+ * \par See also
+ * \arg \ref Config_mgcp
+ *
+ * \ingroup channel_drivers
  */
 
 /* FO: Changes

Index: chan_misdn.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_misdn.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- chan_misdn.c        1 Nov 2005 22:04:14 -0000       1.2
+++ chan_misdn.c        6 Nov 2005 15:09:46 -0000       1.3
@@ -1,14 +1,29 @@
 /*
- * Chan_Misdn -- Channel Driver for Asterisk
- *
- * Interface to Asterisk
- *
+ * Asterisk -- An open source telephony toolkit.
+ * 
  * Copyright (C) 2004, Christian Richter
  *
  * Christian Richter <[EMAIL PROTECTED]>
  *
+ * 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
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ *
+ */
+
+/*!
+ * \file
+ *
+ * \brief the chan_misdn channel driver for Asterisk
+ * \author Christian Richter <[EMAIL PROTECTED]>
+ *
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>
@@ -56,23 +71,23 @@
 /* BEGIN: chan_misdn.h */
 
 enum misdn_chan_state {
-       MISDN_NOTHING, /* at beginning */
-       MISDN_WAITING4DIGS, /*  when waiting for infos */
-       MISDN_EXTCANTMATCH, /*  when asterisk couldnt match our ext */
-       MISDN_DIALING, /*  when pbx_start */
-       MISDN_PROGRESS, /*  we got a progress */
-       MISDN_CALLING, /*  when misdn_call is called */
-       MISDN_CALLING_ACKNOWLEDGE, /*  when we get SETUP_ACK */
-       MISDN_ALERTING, /*  when Alerting */
-       MISDN_BUSY, /*  when BUSY */
-       MISDN_CONNECTED, /*  when connected */
-       MISDN_BRIDGED, /*  when bridged */
-       MISDN_CLEANING, /* when hangup from * but we were connected before */
-       MISDN_HUNGUP_FROM_MISDN, /* when DISCONNECT/RELEASE/REL_COMP  cam from 
misdn */
-       MISDN_HUNGUP_FROM_AST, /* when DISCONNECT/RELEASE/REL_COMP came out of 
*/
+       MISDN_NOTHING,          /*!< at beginning */
+       MISDN_WAITING4DIGS, /*!<  when waiting for infos */
+       MISDN_EXTCANTMATCH, /*!<  when asterisk couldnt match our ext */
+       MISDN_DIALING, /*!<  when pbx_start */
+       MISDN_PROGRESS, /*!<  we got a progress */
+       MISDN_CALLING, /*!<  when misdn_call is called */
+       MISDN_CALLING_ACKNOWLEDGE, /*!<  when we get SETUP_ACK */
+       MISDN_ALERTING, /*!<  when Alerting */
+       MISDN_BUSY, /*!<  when BUSY */
+       MISDN_CONNECTED, /*!<  when connected */
+       MISDN_BRIDGED, /*!<  when bridged */
+       MISDN_CLEANING, /*!< when hangup from * but we were connected before */
+       MISDN_HUNGUP_FROM_MISDN, /*!< when DISCONNECT/RELEASE/REL_COMP  cam 
from misdn */
+       MISDN_HUNGUP_FROM_AST, /*!< when DISCONNECT/RELEASE/REL_COMP came out 
of */
        /* misdn_hangup */
-       MISDN_HOLDED, /* if this chan is holded */
-       MISDN_HOLD_DISCONNECT /* if this chan is holded */
+       MISDN_HOLDED, /*!< if this chan is holded */
+       MISDN_HOLD_DISCONNECT /*!< if this chan is holded */
   
 };
 

Index: chan_misdn_config.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_misdn_config.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- chan_misdn_config.c 31 Oct 2005 22:51:12 -0000      1.1
+++ chan_misdn_config.c 6 Nov 2005 15:09:46 -0000       1.2
@@ -1,14 +1,29 @@
 /*
- * Chan_Misdn -- Channel Driver for Asterisk
- *
- * Interface to Asterisk
- *
+ * Asterisk -- An open source telephony toolkit.
+ * 
  * Copyright (C) 2005, Christian Richter
  *
  * Christian Richter <[EMAIL PROTECTED]>
  *
+ * 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
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ *
+ */
+
+/*!
+ * \file
+ *
+ * \brief chan_misdn configuration management
+ * \author Christian Richter <[EMAIL PROTECTED]>
+ *
+ * \ingroup channel_drivers
  */
 
 

Index: chan_modem.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_modem.c,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -d -r1.48 -r1.49
--- chan_modem.c        27 Oct 2005 02:19:37 -0000      1.48
+++ chan_modem.c        6 Nov 2005 15:09:46 -0000       1.49
@@ -20,6 +20,7 @@
  *
  * \brief A/Open ITU-56/2 Voice Modem Driver (Rockwell, IS-101, and others)
  * 
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_modem_aopen.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_modem_aopen.c,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19
--- chan_modem_aopen.c  14 Sep 2005 20:46:49 -0000      1.18
+++ chan_modem_aopen.c  6 Nov 2005 15:09:46 -0000       1.19
@@ -20,6 +20,7 @@
  *
  * A/Open ITU-56/2 Voice Modem Driver (Rockwell, IS-101, and others)
  * 
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_modem_bestdata.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_modem_bestdata.c,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -d -r1.19 -r1.20
--- chan_modem_bestdata.c       14 Sep 2005 20:46:49 -0000      1.19
+++ chan_modem_bestdata.c       6 Nov 2005 15:09:46 -0000       1.20
@@ -21,6 +21,7 @@
  *
  * BestData 56SX-92 Voice Modem Driver (Conexant)
  * 
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_modem_i4l.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_modem_i4l.c,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -d -r1.33 -r1.34
--- chan_modem_i4l.c    27 Oct 2005 02:19:37 -0000      1.33
+++ chan_modem_i4l.c    6 Nov 2005 15:09:46 -0000       1.34
@@ -20,6 +20,7 @@
  *
  * \brief ISDN4Linux TTY Driver
  * 
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_nbs.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_nbs.c,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -d -r1.20 -r1.21
--- chan_nbs.c  27 Oct 2005 02:19:37 -0000      1.20
+++ chan_nbs.c  6 Nov 2005 15:09:46 -0000       1.21
@@ -18,8 +18,11 @@
 
 /*! \file
  *
- * \brief Generic Linux Telephony Interface driver
+ * \brief Network broadcast sound support channel driver
  * 
+ * \author Mark Spencer <[EMAIL PROTECTED]>
+ *
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_oss.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_oss.c,v
retrieving revision 1.61
retrieving revision 1.62
diff -u -d -r1.61 -r1.62
--- chan_oss.c  6 Nov 2005 04:44:19 -0000       1.61
+++ chan_oss.c  6 Nov 2005 15:09:46 -0000       1.62
@@ -23,6 +23,10 @@
  *
  * \brief Channel driver for OSS sound cards
  *
+ * \par See also
+ * \arg \ref Config_oss
+ *
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_oss_old.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_oss_old.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- chan_oss_old.c      27 Oct 2005 02:19:37 -0000      1.3
+++ chan_oss_old.c      6 Nov 2005 15:09:46 -0000       1.4
@@ -23,6 +23,7 @@
  * VERY BADLY WRITTEN DRIVER so please don't use it as a model for
  * writing a driver.
  *
+ * \ingroup channel_drivers
  */
 
 #include <unistd.h>

Index: chan_phone.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_phone.c,v
retrieving revision 1.58
retrieving revision 1.59
diff -u -d -r1.58 -r1.59
--- chan_phone.c        27 Oct 2005 02:19:37 -0000      1.58
+++ chan_phone.c        6 Nov 2005 15:09:46 -0000       1.59
@@ -20,6 +20,7 @@
  *
  * \brief Generic Linux Telephony Interface driver
  * 
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>

Index: chan_skinny.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_skinny.c,v
retrieving revision 1.92
retrieving revision 1.93
diff -u -d -r1.92 -r1.93
--- chan_skinny.c       24 Oct 2005 20:12:05 -0000      1.92
+++ chan_skinny.c       6 Nov 2005 15:09:46 -0000       1.93
@@ -20,6 +20,8 @@
  *
  * \brief Implementation of the Skinny protocol
  * 
+ * \author Jeremy McNamara & Florian Overkamp
+ * \ingroup channel_drivers
  */
 
 

Index: chan_vpb.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_vpb.c,v
retrieving revision 1.103
retrieving revision 1.104
diff -u -d -r1.103 -r1.104
--- chan_vpb.c  3 Nov 2005 21:49:20 -0000       1.103
+++ chan_vpb.c  6 Nov 2005 15:09:46 -0000       1.104
@@ -26,6 +26,7 @@
  *
  * \brief VoiceTronix Interface driver
  * 
+ * \ingroup channel_drivers
  */
 
 

Index: chan_zap.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channels/chan_zap.c,v
retrieving revision 1.538
retrieving revision 1.539
diff -u -d -r1.538 -r1.539
--- chan_zap.c  6 Nov 2005 04:38:39 -0000       1.538
+++ chan_zap.c  6 Nov 2005 15:09:46 -0000       1.539
@@ -20,6 +20,17 @@
  *
  * \brief Zaptel Pseudo TDM interface 
  * 
+ * Connects to the zaptel telephony library as well as 
+ * libpri. Libpri is optional and needed only if you are
+ * going to use ISDN connections.
+ *
+ * You need to install libraries before you attempt to compile
+ * and install the zaptel channel.
+ *
+ * \par See also
+ * \arg \ref Config_zap
+ *
+ * \ingroup channel_drivers
  */
 
 #include <stdio.h>
@@ -96,8 +107,8 @@
 #define ZT_EVENT_DTMFUP 0
 #endif
 
-/*
- * Define ZHONE_HACK to cause us to go off hook and then back on hook when
+/*! 
+ * \note Define ZHONE_HACK to cause us to go off hook and then back on hook 
when
  * the user hangs up to reset the state machine so ring works properly.
  * This is used to be able to support kewlstart by putting the zhone in
  * groundstart mode since their forward disconnect supervision is entirely
@@ -105,24 +116,23 @@
  * is entirely unwilling to provide any assistance with their channel banks
  * even though their web site says they support their products for life.
  */
-
 /* #define ZHONE_HACK */
 
-/*
+/*! \note
  * Define if you want to check the hook state for an FXO (FXS signalled) 
interface
  * before dialing on it.  Certain FXO interfaces always think they're out of
  * service with this method however.
  */
 /* #define ZAP_CHECK_HOOKSTATE */
 
-/* Typically, how many rings before we should send Caller*ID */
+/*! \brief Typically, how many rings before we should send Caller*ID */
 #define DEFAULT_CIDRINGS 1
 
 #define CHANNEL_PSEUDO -12
 
 #define AST_LAW(p) (((p)->law == ZT_LAW_ALAW) ? AST_FORMAT_ALAW : 
AST_FORMAT_ULAW)
 
-/* Signaling types that need to use MF detection should be placed in this 
macro */
+/*! \brief Signaling types that need to use MF detection should be placed in 
this macro */
 #define NEED_MFDETECT(p) (((p)->sig == SIG_FEATDMF) || ((p)->sig == 
SIG_FEATDMF_TA) || ((p)->sig == SIG_E911) || ((p)->sig == SIG_FEATB)) 
 
 static const char desc[] = "Zapata Telephony"
@@ -171,8 +181,8 @@
 #define SIG_GR303FXSKS (0x0100000 | ZT_SIG_FXSKS)
 
 #define NUM_SPANS              32
-#define NUM_DCHANS             4               /* No more than 4 d-channels */
-#define MAX_CHANNELS   672             /* No more than a DS3 per trunk group */
+#define NUM_DCHANS             4       /*!< No more than 4 d-channels */
+#define MAX_CHANNELS   672             /*!< No more than a DS3 per trunk group 
*/
 
 #define CHAN_PSEUDO    -2
 
@@ -287,7 +297,7 @@
 static char localprefix[20] = "";
 static char privateprefix[20] = "";
 static char unknownprefix[20] = "";
-static long resetinterval = 3600;                      /* How often (in 
seconds) to reset unused channels. Default 1 hour. */
+static long resetinterval = 3600;      /*!< How often (in seconds) to reset 
unused channels. Default 1 hour. */
 static struct ast_channel inuse = { "GR-303InUse" };
 #ifdef PRI_GETSET_TIMERS
 static int pritimers[PRI_MAX_TIMERS];
@@ -296,19 +306,19 @@
 static char pridebugfilename[1024]="";
 #endif
 
-/* Wait up to 16 seconds for first digit (FXO logic) */
+/*! \brief Wait up to 16 seconds for first digit (FXO logic) */
 static int firstdigittimeout = 16000;
 
-/* How long to wait for following digits (FXO logic) */
+/*! \brief How long to wait for following digits (FXO logic) */
 static int gendigittimeout = 8000;
 
-/* How long to wait for an extra digit, if there is an ambiguous match */
+/*! \brief How long to wait for an extra digit, if there is an ambiguous match 
*/
 static int matchdigittimeout = 3000;
 
 static int usecnt =0;
 AST_MUTEX_DEFINE_STATIC(usecnt_lock);
 
-/* Protect the interface list (of zt_pvt's) */
+/*! \brief Protect the interface list (of zt_pvt's) */
 AST_MUTEX_DEFINE_STATIC(iflock);
 
 
@@ -318,23 +328,23 @@
 AST_MUTEX_DEFINE_STATIC(pridebugfdlock);
 #endif
 
-/* Whether we answer on a Polarity Switch event */
+/*! \brief Whether we answer on a Polarity Switch event */
 static int answeronpolarityswitch = 0;
 
-/* Whether we hang up on a Polarity Switch event */
+/*! \brief Whether we hang up on a Polarity Switch event */
 static int hanguponpolarityswitch = 0;
 
-/* How long (ms) to ignore Polarity Switch events after we answer a call */
+/*! \brief How long (ms) to ignore Polarity Switch events after we answer a 
call */
 static int polarityonanswerdelay = 600;
 
-/* When to send the CallerID signals (rings) */
+/*! \brief When to send the CallerID signals (rings) */
 static int sendcalleridafter = DEFAULT_CIDRINGS;
 
-/* Protect the monitoring thread, so only one process can kill or start it, 
and not
+/*! \brief Protect the monitoring thread, so only one process can kill or 
start it, and not
    when it's doing something critical. */
 AST_MUTEX_DEFINE_STATIC(monlock);
 
-/* This is the thread for the monitor which checks for input on the channels
+/*! \brief This is the thread for the monitor which checks for input on the 
channels
    which are not currently in use.  */
 static pthread_t monitor_thread = AST_PTHREADT_NULL;
 
@@ -344,17 +354,17 @@
 
 static int zt_sendtext(struct ast_channel *c, const char *text);
 
+/*! \brief Avoid the silly zt_getevent which ignores a bunch of events */
 static inline int zt_get_event(int fd)
 {
-       /* Avoid the silly zt_getevent which ignores a bunch of events */
        int j;
        if (ioctl(fd, ZT_GETEVENT, &j) == -1) return -1;
        return j;
 }
 
+/*! \brief Avoid the silly zt_waitevent which ignores a bunch of events */
 static inline int zt_wait_event(int fd)
 {
-       /* Avoid the silly zt_waitevent which ignores a bunch of events */
        int i,j=0;
        i = ZT_IOMUX_SIGEVENT;
        if (ioctl(fd, ZT_IOMUX, &i) == -1) return -1;
@@ -362,16 +372,16 @@
        return j;
 }
 
-/* Chunk size to read -- we use 20ms chunks to make things happy.  */   
+/*! Chunk size to read -- we use 20ms chunks to make things happy.  */   
 #define READ_SIZE 160
 
-#define MASK_AVAIL             (1 << 0)                /* Channel available 
for PRI use */
-#define MASK_INUSE             (1 << 1)                /* Channel currently in 
use */
+#define MASK_AVAIL             (1 << 0)        /*!< Channel available for PRI 
use */
+#define MASK_INUSE             (1 << 1)        /*!< Channel currently in use */
 
-#define CALLWAITING_SILENT_SAMPLES     ( (300 * 8) / READ_SIZE) /* 300 ms */
-#define CALLWAITING_REPEAT_SAMPLES     ( (10000 * 8) / READ_SIZE) /* 300 ms */
-#define CIDCW_EXPIRE_SAMPLES           ( (500 * 8) / READ_SIZE) /* 500 ms */
-#define MIN_MS_SINCE_FLASH                     ( (2000) )      /* 2000 ms */
+#define CALLWAITING_SILENT_SAMPLES     ( (300 * 8) / READ_SIZE) /*!< 300 ms */
+#define CALLWAITING_REPEAT_SAMPLES     ( (10000 * 8) / READ_SIZE) /*!< 300 ms 
*/
+#define CIDCW_EXPIRE_SAMPLES           ( (500 * 8) / READ_SIZE) /*!< 500 ms */
+#define MIN_MS_SINCE_FLASH                     ( (2000) )      /*!< 2000 ms */
 #define DEFAULT_RINGT                          ( (8000 * 8) / READ_SIZE)
 
 struct zt_pvt;
@@ -391,44 +401,44 @@
 #define PRI_EXPLICIT(p) (((p) >> 16) & 0x01)
 
 struct zt_pri {
-       pthread_t master;                                               /* 
Thread of master */
-       ast_mutex_t lock;                                               /* 
Mutex */
-       char idleext[AST_MAX_EXTENSION];                                /* 
Where to idle extra calls */
-       char idlecontext[AST_MAX_CONTEXT];                              /* What 
context to use for idle */
-       char idledial[AST_MAX_EXTENSION];                               /* What 
to dial before dumping */
-       int minunused;                                                  /* Min 
# of channels to keep empty */
-       int minidle;                                                    /* Min 
# of "idling" calls to keep active */
-       int nodetype;                                                   /* Node 
type */
-       int switchtype;                                                 /* Type 
of switch to emulate */
-       int nsf;                                                        /* 
Network-Specific Facilities */
-       int dialplan;                                                   /* 
Dialing plan */
-       int localdialplan;                                              /* 
Local dialing plan */
-       char internationalprefix[10];                                   /* 
country access code ('00' for european dialplans) */
-       char nationalprefix[10];                                        /* area 
access code ('0' for european dialplans) */
-       char localprefix[20];                                           /* area 
access code + area code ('0'+area code for european dialplans) */
-       char privateprefix[20];                                         /* for 
private dialplans */
-       char unknownprefix[20];                                         /* for 
unknown dialplans */
-       int dchannels[NUM_DCHANS];                                      /* What 
channel are the dchannels on */
-       int trunkgroup;                                                 /* What 
our trunkgroup is */
-       int mastertrunkgroup;                                           /* What 
trunk group is our master */
-       int prilogicalspan;                                             /* 
Logical span number within trunk group */
-       int numchans;                                                   /* Num 
of channels we represent */
-       int overlapdial;                                                /* In 
overlap dialing mode */
-       int facilityenable;                                             /* 
Enable facility IEs */
-       struct pri *dchans[NUM_DCHANS];                                 /* 
Actual d-channels */
-       int dchanavail[NUM_DCHANS];                                     /* 
Whether each channel is available */
-       struct pri *pri;                                                /* 
Currently active D-channel */
+       pthread_t master;                                               /*!< 
Thread of master */
+       ast_mutex_t lock;                                               /*!< 
Mutex */
+       char idleext[AST_MAX_EXTENSION];                                /*!< 
Where to idle extra calls */
+       char idlecontext[AST_MAX_CONTEXT];                              /*!< 
What context to use for idle */
+       char idledial[AST_MAX_EXTENSION];                               /*!< 
What to dial before dumping */
+       int minunused;                                                  /*!< 
Min # of channels to keep empty */
+       int minidle;                                                    /*!< 
Min # of "idling" calls to keep active */
+       int nodetype;                                                   /*!< 
Node type */
+       int switchtype;                                                 /*!< 
Type of switch to emulate */
+       int nsf;                                                        /*!< 
Network-Specific Facilities */
+       int dialplan;                                                   /*!< 
Dialing plan */
+       int localdialplan;                                              /*!< 
Local dialing plan */
+       char internationalprefix[10];                                   /*!< 
country access code ('00' for european dialplans) */
+       char nationalprefix[10];                                        /*!< 
area access code ('0' for european dialplans) */
+       char localprefix[20];                                           /*!< 
area access code + area code ('0'+area code for european dialplans) */
+       char privateprefix[20];                                         /*!< 
for private dialplans */
+       char unknownprefix[20];                                         /*!< 
for unknown dialplans */
+       int dchannels[NUM_DCHANS];                                      /*!< 
What channel are the dchannels on */
+       int trunkgroup;                                                 /*!< 
What our trunkgroup is */
+       int mastertrunkgroup;                                           /*!< 
What trunk group is our master */
+       int prilogicalspan;                                             /*!< 
Logical span number within trunk group */
+       int numchans;                                                   /*!< 
Num of channels we represent */
+       int overlapdial;                                                /*!< In 
overlap dialing mode */
+       int facilityenable;                                             /*!< 
Enable facility IEs */
+       struct pri *dchans[NUM_DCHANS];                                 /*!< 
Actual d-channels */
+       int dchanavail[NUM_DCHANS];                                     /*!< 
Whether each channel is available */
+       struct pri *pri;                                                /*!< 
Currently active D-channel */
        int debug;
-       int fds[NUM_DCHANS];                                            /* FD's 
for d-channels */
+       int fds[NUM_DCHANS];                                            /*!< 
FD's for d-channels */
        int offset;
        int span;
        int resetting;
        int resetpos;
-       time_t lastreset;                                               /* time 
when unused channels were last reset */
-       long resetinterval;                                             /* 
Interval (in seconds) for resetting unused channels */
-       struct zt_pvt *pvts[MAX_CHANNELS];                              /* 
Member channel pvt structs */
-       struct zt_pvt *crvs;                                            /* 
Member CRV structs */
-       struct zt_pvt *crvend;                                          /* 
Pointer to end of CRV structs */
+       time_t lastreset;                                               /*!< 
time when unused channels were last reset */
+       long resetinterval;                                             /*!< 
Interval (in seconds) for resetting unused channels */
+       struct zt_pvt *pvts[MAX_CHANNELS];                              /*!< 
Member channel pvt structs */
+       struct zt_pvt *crvs;                                            /*!< 
Member CRV structs */
+       struct zt_pvt *crvend;                                          /*!< 
Pointer to end of CRV structs */
 };
 
 
@@ -453,13 +463,13 @@
 static int localdialplan = PRI_NATIONAL_ISDN + 1;
 
 #else
-/* Shut up the compiler */
+/*! Shut up the compiler */
 struct zt_pri;
 #endif
 
-#define SUB_REAL               0                       /* Active call */
-#define SUB_CALLWAIT   1                       /* Call-Waiting call on hold */
-#define SUB_THREEWAY   2                       /* Three-way call */
+#define SUB_REAL       0                       /*!< Active call */
+#define SUB_CALLWAIT   1                       /*!< Call-Waiting call on hold 
*/
+#define SUB_THREEWAY   2                       /*!< Three-way call */
 
 /* Polarity states */
 #define POLARITY_IDLE   0
@@ -490,7 +500,7 @@
        struct ast_channel *owner;
        int chan;
        short buffer[AST_FRIENDLY_OFFSET/2 + READ_SIZE];
-       struct ast_frame f;             /* One frame for each channel.  How did 
this ever work before? */
+       struct ast_frame f;             /*!< One frame for each channel.  How 
did this ever work before? */
        unsigned int needringing:1;
        unsigned int needbusy:1;
        unsigned int needcongestion:1;
@@ -509,24 +519,24 @@
 
 static struct zt_pvt {
        ast_mutex_t lock;
-       struct ast_channel *owner;                      /* Our current active 
owner (if applicable) */
-                                                       /* Up to three channels 
can be associated with this call */
+       struct ast_channel *owner;                      /*!< Our current active 
owner (if applicable) */
+                                                       /*!< Up to three 
channels can be associated with this call */
                
-       struct zt_subchannel sub_unused;                /* Just a safety 
precaution */
-       struct zt_subchannel subs[3];                   /* Sub-channels */
-       struct zt_confinfo saveconf;                    /* Saved conference 
info */
+       struct zt_subchannel sub_unused;                /*!< Just a safety 
precaution */
+       struct zt_subchannel subs[3];                   /*!< Sub-channels */
+       struct zt_confinfo saveconf;                    /*!< Saved conference 
info */
 
-       struct zt_pvt *slaves[MAX_SLAVES];              /* Slave to us (follows 
our conferencing) */
-       struct zt_pvt *master;                          /* Master to us (we 
follow their conferencing) */
-       int inconference;                               /* If our real should 
be in the conference */
+       struct zt_pvt *slaves[MAX_SLAVES];              /*!< Slave to us 
(follows our conferencing) */
+       struct zt_pvt *master;                          /*!< Master to us (we 
follow their conferencing) */
+       int inconference;                               /*!< If our real should 
be in the conference */
        
-       int sig;                                        /* Signalling style */
-       int radio;                                      /* radio type */
+       int sig;                                        /*!< Signalling style */
+       int radio;                                      /*!< radio type */
        float rxgain;
        float txgain;
-       int tonezone;                                   /* tone zone for this 
chan, or -1 for default */
-       struct zt_pvt *next;                            /* Next channel in list 
*/
-       struct zt_pvt *prev;                            /* Prev channel in list 
*/
+       int tonezone;                                   /*!< tone zone for this 
chan, or -1 for default */
+       struct zt_pvt *next;                            /*!< Next channel in 
list */
+       struct zt_pvt *prev;                            /*!< Prev channel in 
list */
 
        /* flags */
        unsigned int adsi:1;
@@ -537,9 +547,9 @@
        unsigned int callwaitingcallerid:1;
        unsigned int cancallforward:1;
        unsigned int canpark:1;
-       unsigned int confirmanswer:1;                   /* Wait for '#' to 
confirm answer */
+       unsigned int confirmanswer:1;                   /*!< Wait for '#' to 
confirm answer */
        unsigned int destroy:1;
-       unsigned int didtdd:1;                          /* flag to say its done 
it once */
+       unsigned int didtdd:1;                          /*!< flag to say its 
done it once */
        unsigned int dialednone:1;
        unsigned int dialing:1;
        unsigned int digital:1;
@@ -547,31 +557,31 @@
        unsigned int echobreak:1;
        unsigned int echocanbridged:1;
        unsigned int echocanon:1;
-       unsigned int faxhandled:1;                      /* Has a fax tone 
already been handled? */
+       unsigned int faxhandled:1;                      /*!< Has a fax tone 
already been handled? */
        unsigned int firstradio:1;
        unsigned int hanguponpolarityswitch:1;
        unsigned int hardwaredtmf:1;
        unsigned int hidecallerid;
        unsigned int ignoredtmf:1;
-       unsigned int immediate:1;                       /* Answer before 
getting digits? */
+       unsigned int immediate:1;                       /*!< Answer before 
getting digits? */
        unsigned int inalarm:1;
-       unsigned int mate:1;                            /* flag to say its in 
MATE mode */
+       unsigned int mate:1;                            /*!< flag to say its in 
MATE mode */
        unsigned int outgoing:1;
        unsigned int overlapdial:1;
        unsigned int permcallwaiting:1;
-       unsigned int permhidecallerid:1;                /* Whether to hide our 
outgoing caller ID or not */
+       unsigned int permhidecallerid:1;                /*!< Whether to hide 
our outgoing caller ID or not */
        unsigned int priindication_oob:1;
        unsigned int priexclusive:1;
        unsigned int pulse:1;
-       unsigned int pulsedial:1;                       /* whether a pulse dial 
phone is detected */
-       unsigned int restrictcid:1;                     /* Whether restrict the 
callerid -> only send ANI */
+       unsigned int pulsedial:1;                       /*!< whether a pulse 
dial phone is detected */
+       unsigned int restrictcid:1;                     /*!< Whether restrict 
the callerid -> only send ANI */
        unsigned int threewaycalling:1;
        unsigned int transfer:1;
-       unsigned int use_callerid:1;                    /* Whether or not to 
use caller id on this channel */
-       unsigned int use_callingpres:1;                 /* Whether to use the 
callingpres the calling switch sends */
+       unsigned int use_callerid:1;                    /*!< Whether or not to 
use caller id on this channel */
+       unsigned int use_callingpres:1;                 /*!< Whether to use the 
callingpres the calling switch sends */
        unsigned int usedistinctiveringdetection:1;
-       unsigned int zaptrcallerid:1;                   /* should we use the 
callerid from incoming call on zap transfer or not */
-       unsigned int transfertobusy:1;                  /* allow 
flash-transfers to busy channels */
+       unsigned int zaptrcallerid:1;                   /*!< should we use the 
callerid from incoming call on zap transfer or not */
+       unsigned int transfertobusy:1;                  /*!< allow 
flash-transfers to busy channels */
 #if defined(ZAPATA_PRI)
        unsigned int alerting:1;
        unsigned int alreadyhungup:1;
@@ -598,31 +608,31 @@
        char cid_ani[AST_MAX_EXTENSION];
 #endif
        char cid_num[AST_MAX_EXTENSION];
-       int cid_ton;                                    /* Type Of Number (TON) 
*/
+       int cid_ton;                                    /*!< Type Of Number 
(TON) */
        char cid_name[AST_MAX_EXTENSION];
        char lastcid_num[AST_MAX_EXTENSION];
        char lastcid_name[AST_MAX_EXTENSION];
-       char *origcid_num;                              /* malloced original 
callerid */
-       char *origcid_name;                             /* malloced original 
callerid */
+       char *origcid_num;                              /*!< malloced original 
callerid */
+       char *origcid_name;                             /*!< malloced original 
callerid */
        char callwait_num[AST_MAX_EXTENSION];
        char callwait_name[AST_MAX_EXTENSION];
        char rdnis[AST_MAX_EXTENSION];
        char dnid[AST_MAX_EXTENSION];
        unsigned int group;
        int law;
-       int confno;                                     /* Our conference */
-       int confusers;                                  /* Who is using our 
conference */
-       int propconfno;                                 /* Propagated 
conference number */
+       int confno;                                     /*!< Our conference */
+       int confusers;                                  /*!< Who is using our 
conference */
+       int propconfno;                                 /*!< Propagated 
conference number */
        ast_group_t callgroup;
        ast_group_t pickupgroup;
-       int channel;                                    /* Channel Number or 
CRV */
-       int span;                                       /* Span number */
-       time_t guardtime;                               /* Must wait this much 
time before using for new call */
-       int cid_signalling;                             /* CID signalling type 
bell202 or v23 */
-       int cid_start;                                  /* CID start indicator, 
polarity or ring */
-       int callingpres;                                /* The value of 
callling presentation that we're going to use when placing a PRI call */
-       int callwaitingrepeat;                          /* How many samples to 
wait before repeating call waiting */
-       int cidcwexpire;                                /* When to expire our 
muting for CID/CW */
+       int channel;                                    /*!< Channel Number or 
CRV */
+       int span;                                       /*!< Span number */
+       time_t guardtime;                               /*!< Must wait this 
much time before using for new call */
+       int cid_signalling;                             /*!< CID signalling 
type bell202 or v23 */
+       int cid_start;                                  /*!< CID start 
indicator, polarity or ring */
+       int callingpres;                                /*!< The value of 
callling presentation that we're going to use when placing a PRI call */
+       int callwaitingrepeat;                          /*!< How many samples 
to wait before repeating call waiting */
+       int cidcwexpire;                                /*!< When to expire our 
muting for CID/CW */
        unsigned char *cidspill;
        int cidpos;
        int cidlen;
@@ -638,23 +648,23 @@
        int busy_tonelength;
        int busy_quietlength;
        int callprogress;
-       struct timeval flashtime;                       /* Last flash-hook time 
*/
+       struct timeval flashtime;                       /*!< Last flash-hook 
time */
        struct ast_dsp *dsp;
-       int cref;                                       /* Call reference 
number */
+       int cref;                                       /*!< Call reference 
number */
        ZT_DIAL_OPERATION dop;
-       int whichwink;                                  /* SIG_FEATDMF_TA Which 
wink are we on? */
+       int whichwink;                                  /*!< SIG_FEATDMF_TA 
Which wink are we on? */
        char finaldial[64];
-       char accountcode[AST_MAX_ACCOUNT_CODE];         /* Account code */
-       int amaflags;                                   /* AMA Flags */
-       struct tdd_state *tdd;                          /* TDD flag */
+       char accountcode[AST_MAX_ACCOUNT_CODE];         /*!< Account code */
+       int amaflags;                                   /*!< AMA Flags */
+       struct tdd_state *tdd;                          /*!< TDD flag */
        char call_forward[AST_MAX_EXTENSION];
        char mailbox[AST_MAX_EXTENSION];
        char dialdest[256];
        int onhooktime;
        int msgstate;
-       int distinctivering;                            /* Which 
distinctivering to use */
-       int cidrings;                                   /* Which ring to 
deliver CID on */
-       int dtmfrelax;                                  /* whether to run in 
relaxed DTMF mode */
+       int distinctivering;                            /*!< Which 
distinctivering to use */
+       int cidrings;                                   /*!< Which ring to 
deliver CID on */
+       int dtmfrelax;                                  /*!< whether to run in 
relaxed DTMF mode */
        int fake_event;
        int polarityonanswerdelay;
        struct timeval polaritydelaytv;
@@ -741,23 +751,23 @@
 static int user_has_defined_cadences = 0;
 
 static struct zt_ring_cadence cadences[NUM_CADENCE_MAX] = {
-       { { 125, 125, 2000, 4000 } },                   /* Quick chirp followed 
by normal ring */
-       { { 250, 250, 500, 1000, 250, 250, 500, 4000 } }, /* British style ring 
*/
-       { { 125, 125, 125, 125, 125, 4000 } },  /* Three short bursts */
-       { { 1000, 500, 2500, 5000 } },  /* Long ring */
+       { { 125, 125, 2000, 4000 } },                   /*!< Quick chirp 
followed by normal ring */
+       { { 250, 250, 500, 1000, 250, 250, 500, 4000 } }, /*!< British style 
ring */
+       { { 125, 125, 125, 125, 125, 4000 } },  /*!< Three short bursts */
+       { { 1000, 500, 2500, 5000 } },  /*!< Long ring */
 };
 
-int receivedRingT; /* Used to find out what ringtone we are on */
+int receivedRingT; /*!< Used to find out what ringtone we are on */
 
-/* cidrings says in which pause to transmit the cid information, where the 
first pause
+/*! \brief cidrings says in which pause to transmit the cid information, where 
the first pause
  * is 1, the second pause is 2 and so on.
  */
 
 static int cidrings[NUM_CADENCE_MAX] = {
-       2,                                                                      
        /* Right after first long ring */
-       4,                                                                      
        /* Right after long part */
-       3,                                                                      
        /* After third chirp */
-       2,                                                                      
        /* Second spell */
+       2,                                                                      
        /*!< Right after first long ring */
+       4,                                                                      
        /*!< Right after long part */
+       3,                                                                      
        /*!< After third chirp */
+       2,                                                                      
        /*!< Second spell */
 };
 
 #define ISTRUNK(p) ((p->sig == SIG_FXSLS) || (p->sig == SIG_FXSKS) || \

_______________________________________________
Asterisk-Cvs mailing list
[email protected]
http://lists.digium.com/mailman/listinfo/asterisk-cvs

Reply via email to