diff options
author | Russell Bryant <russell@russellbryant.com> | 2007-08-07 23:04:01 +0000 |
---|---|---|
committer | Russell Bryant <russell@russellbryant.com> | 2007-08-07 23:04:01 +0000 |
commit | 668a334f85dc1df89ff77511890b247196550983 (patch) | |
tree | 0c7204d7e3713b731a0855eca39d8930798cdc6c /utils/smsq.c | |
parent | 218241f174a531e77f99697e7d521f56783c03fc (diff) |
Add another big set of doxygen documentation improvements from snuffy.
(closes issue #9892)
(closes issue #10395)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@78541 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'utils/smsq.c')
-rw-r--r-- | utils/smsq.c | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/utils/smsq.c b/utils/smsq.c index 7439504fc..f6baf0ad1 100644 --- a/utils/smsq.c +++ b/utils/smsq.c @@ -38,9 +38,11 @@ #endif -/* reads next USC character from null terminated UTF-8 string and advanced pointer */ -/* for non valid UTF-8 sequences, returns character as is */ -/* Does not advance pointer for null termination */ +/*! + * \brief reads next USC character from null terminated UTF-8 string and advanced pointer + * for non valid UTF-8 sequences. + * \return character as is Does \b NOT advance pointer for null termination +*/ static int utf8decode (unsigned char **pp) { unsigned char *p = *pp; @@ -90,8 +92,13 @@ static int utf8decode (unsigned char **pp) return *p; /* not sensible */ } -/* check for any queued messages in specific queue (queue="" means any queue) */ -/* returns 0 if nothing queued, 1 if queued and outgoing set up OK, 2 of outgoing exists */ +/*! + * \brief check for any queued messages in specific queue (queue="" means any queue) + * \param dir,queue,subaddress,channel,callerid,wait,delay,retries,concurrent + * \retval 0 if nothing queued + * \retval 1 if queued and outgoing set up OK + * \retval 2 of outgoing exists +*/ static char txqcheck (char *dir, char *queue, char subaddress, char *channel, char *callerid, int wait, int delay, int retries, int concurrent) { char ogname[100], @@ -186,7 +193,10 @@ static char txqcheck (char *dir, char *queue, char subaddress, char *channel, ch return 2; } -/* Process received queue entries and run through a process, setting environment variables */ +/*! + * \brief Process received queue entries + * Run through a process, setting environment variables +*/ static void rxqcheck (char *dir, char *queue, char *process) { char *p; |