More doxygen updates
authorOlle Johansson <oej@edvina.net>
Fri, 20 Jan 2006 00:18:42 +0000 (00:18 +0000)
committerOlle Johansson <oej@edvina.net>
Fri, 20 Jan 2006 00:18:42 +0000 (00:18 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@8315 65c4cc65-6c06-0410-ace0-fbb531ad65f3

apps/app_meetme.c
apps/app_sms.c
channels/chan_agent.c
channels/chan_local.c
config.c
devicestate.c
enum.c
logger.c

index d9eebad..c3068ce 100644 (file)
@@ -1817,7 +1817,7 @@ static struct ast_conference *find_conf(struct ast_channel *chan, char *confno,
        return cnf;
 }
 
-/*--- count_exec: The MeetmeCount application */
+/*! \brief The MeetmeCount application */
 static int count_exec(struct ast_channel *chan, void *data)
 {
        struct localuser *u;
@@ -1867,7 +1867,7 @@ static int count_exec(struct ast_channel *chan, void *data)
        return res;
 }
 
-/*--- conf_exec: The meetme() application */
+/*! \brief The meetme() application */
 static int conf_exec(struct ast_channel *chan, void *data)
 {
        int res=-1;
@@ -2137,7 +2137,7 @@ static struct ast_conf_user* find_user(struct ast_conference *conf, char *caller
        return NULL;
 }
 
-/*--- admin_exec: The MeetMeadmin application */
+/*! \brief The MeetMeadmin application */
 /* MeetMeAdmin(confno, command, caller) */
 static int admin_exec(struct ast_channel *chan, void *data) {
        char *params;
index 1d9ea3f..c80c0a1 100644 (file)
@@ -198,7 +198,7 @@ static void sms_release (struct ast_channel *chan, void *data)
 
 static void sms_messagetx (sms_t * h);
 
-/*--- numcpy: copy number, skipping non digits apart from leading + */
+/*! \brief copy number, skipping non digits apart from leading + */
 static void numcpy (char *d, char *s)
 {
        if (*s == '+')
@@ -211,7 +211,7 @@ static void numcpy (char *d, char *s)
        *d = 0;
 }
 
-/*--- isodate: static, return a date/time in ISO format */
+/*! \brief static, return a date/time in ISO format */
 static char * isodate (time_t t)
 {
        static char date[20];
@@ -219,7 +219,7 @@ static char * isodate (time_t t)
        return date;
 }
 
-/*--- utf8decode: reads next UCS character from null terminated UTF-8 string and advanced pointer */
+/*! \brief reads next UCS 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 */
 static long utf8decode (unsigned char **pp)
@@ -265,7 +265,7 @@ static long utf8decode (unsigned char **pp)
        return *p;                   /* not sensible */
 }
 
-/*--- packsms7: takes a binary header (udhl bytes at udh) and UCS-2 message (udl characters at ud) and packs in to o using SMS 7 bit character codes */
+/*! \brief takes a binary header (udhl bytes at udh) and UCS-2 message (udl characters at ud) and packs in to o using SMS 7 bit character codes */
 /* The return value is the number of septets packed in to o, which is internally limited to SMSLEN */
 /* o can be null, in which case this is used to validate or count only */
 /* if the input contains invalid characters then the return value is -1 */
@@ -335,7 +335,7 @@ static int packsms7 (unsigned char *o, int udhl, unsigned char *udh, int udl, un
        return n;
 }
 
-/*--- packsms8: takes a binary header (udhl bytes at udh) and UCS-2 message (udl characters at ud) and packs in to o using 8 bit character codes */
+/*! \brief takes a binary header (udhl bytes at udh) and UCS-2 message (udl characters at ud) and packs in to o using 8 bit character codes */
 /* The return value is the number of bytes packed in to o, which is internally limited to 140 */
 /* o can be null, in which case this is used to validate or count only */
 /* if the input contains invalid characters then the return value is -1 */
@@ -367,7 +367,7 @@ static int packsms8 (unsigned char *o, int udhl, unsigned char *udh, int udl, un
        return p;
 }
 
-/*--- packsms16: takes a binary header (udhl bytes at udh) and UCS-2 
+/*! \brief takes a binary header (udhl bytes at udh) and UCS-2 
        message (udl characters at ud) and packs in to o using 16 bit 
        UCS-2 character codes 
        The return value is the number of bytes packed in to o, which is 
@@ -404,7 +404,7 @@ static int packsms16 (unsigned char *o, int udhl, unsigned char *udh, int udl, u
        return p;
 }
 
-/*--- packsms: general pack, with length and data, 
+/*! \brief general pack, with length and data, 
        returns number of bytes of target used */
 static int packsms (unsigned char dcs, unsigned char *base, unsigned int udhl, unsigned char *udh, int udl, unsigned short *ud)
 {
@@ -436,7 +436,7 @@ static int packsms (unsigned char dcs, unsigned char *base, unsigned int udhl, u
 }
 
 
-/*--- packdate: pack a date and return */
+/*! \brief pack a date and return */
 static void packdate (unsigned char *o, time_t w)
 {
        struct tm *t = localtime (&w);
@@ -457,7 +457,7 @@ static void packdate (unsigned char *o, time_t w)
                *o++ = ((z % 10) << 4) + z / 10;
 }
 
-/*--- unpackdate: unpack a date and return */
+/*! \brief unpack a date and return */
 static time_t unpackdate (unsigned char *i)
 {
        struct tm t;
@@ -475,7 +475,7 @@ static time_t unpackdate (unsigned char *i)
        return mktime (&t);
 }
 
-/*--- unpacksms7: unpacks bytes (7 bit encoding) at i, len l septets, 
+/*! \brief unpacks bytes (7 bit encoding) at i, len l septets, 
        and places in udh and ud setting udhl and udl. udh not used 
        if udhi not set */
 static void unpacksms7 (unsigned char *i, unsigned char l, unsigned char *udh, int *udhl, unsigned short *ud, int *udl, char udhi)
@@ -526,7 +526,7 @@ static void unpacksms7 (unsigned char *i, unsigned char l, unsigned char *udh, i
        *udl = (o - ud);
 }
 
-/*--- unpacksms8: unpacks bytes (8 bit encoding) at i, len l septets, 
+/*! \brief unpacks bytes (8 bit encoding) at i, len l septets, 
       and places in udh and ud setting udhl and udl. udh not used 
       if udhi not set */
 static void unpacksms8 (unsigned char *i, unsigned char l, unsigned char *udh, int *udhl, unsigned short *ud, int *udl, char udhi)
@@ -551,7 +551,7 @@ static void unpacksms8 (unsigned char *i, unsigned char l, unsigned char *udh, i
        *udl = (o - ud);
 }
 
-/*--- unpacksms16: unpacks bytes (16 bit encoding) at i, len l septets,
+/*! \brief unpacks bytes (16 bit encoding) at i, len l septets,
         and places in udh and ud setting udhl and udl. 
        udh not used if udhi not set */
 static void unpacksms16 (unsigned char *i, unsigned char l, unsigned char *udh, int *udhl, unsigned short *ud, int *udl, char udhi)
@@ -580,7 +580,7 @@ static void unpacksms16 (unsigned char *i, unsigned char l, unsigned char *udh,
        *udl = (o - ud);
 }
 
-/*--- unpacksms: general unpack - starts with length byte (octet or septet) and returns number of bytes used, inc length */
+/*! \brief general unpack - starts with length byte (octet or septet) and returns number of bytes used, inc length */
 static int unpacksms (unsigned char dcs, unsigned char *i, unsigned char *udh, int *udhl, unsigned short *ud, int *udl, char udhi)
 {
        int l = *i++;
@@ -594,7 +594,7 @@ static int unpacksms (unsigned char dcs, unsigned char *i, unsigned char *udh, i
        return l + 1;
 }
 
-/*--- unpackaddress: unpack an address from i, return byte length, unpack to o */
+/*! \brief unpack an address from i, return byte length, unpack to o */
 static unsigned char unpackaddress (char *o, unsigned char *i)
 {
        unsigned char l = i[0],
@@ -611,7 +611,7 @@ static unsigned char unpackaddress (char *o, unsigned char *i)
        return (l + 5) / 2;
 }
 
-/*--- packaddress: store an address at o, and return number of bytes used */
+/*! \brief store an address at o, and return number of bytes used */
 static unsigned char packaddress (unsigned char *o, char *i)
 {
        unsigned char p = 2;
@@ -636,7 +636,7 @@ static unsigned char packaddress (unsigned char *o, char *i)
        return p;
 }
 
-/*--- sms_log: Log the output, and remove file */
+/*! \brief Log the output, and remove file */
 static void sms_log (sms_t * h, char status)
 {
        if (*h->oa || *h->da) {
@@ -674,7 +674,7 @@ static void sms_log (sms_t * h, char status)
        }
 }
 
-/*--- sms_readfile: parse and delete a file */
+/*! \brief parse and delete a file */
 static void sms_readfile (sms_t * h, char *fn)
 {
        char line[1000];
@@ -856,7 +856,7 @@ static void sms_readfile (sms_t * h, char *fn)
        }
 }
 
-/*--- sms_writefile: white a received text message to a file */
+/*! \brief white a received text message to a file */
 static void sms_writefile (sms_t * h)
 {
        char fn[200] = "", fn2[200] = "";
@@ -943,7 +943,7 @@ static void sms_writefile (sms_t * h)
        }
 }
 
-/*--- readdirqueue: read dir skipping dot files... */
+/*! \brief read dir skipping dot files... */
 static struct dirent *readdirqueue (DIR * d, char *queue)
 {
    struct dirent *f;
@@ -953,7 +953,7 @@ static struct dirent *readdirqueue (DIR * d, char *queue)
    return f;
 }
 
-/*--- sms_handleincoming: handle the incoming message */
+/*! \brief handle the incoming message */
 static unsigned char sms_handleincoming (sms_t * h)
 {
        unsigned char p = 3;
@@ -1024,8 +1024,7 @@ static unsigned char sms_handleincoming (sms_t * h)
 #define NAME_MAX 1024
 #endif
 
-/*--- sms_nextoutgoing: find and fill in next message, 
-       or send a REL if none waiting */
+/*! \brief find and fill in next message, or send a REL if none waiting */
 static void sms_nextoutgoing (sms_t * h)
 {          
        char fn[100 + NAME_MAX] = "";
index 4905f40..68652b1 100644 (file)
@@ -940,7 +940,7 @@ static struct ast_channel *agent_bridgedchannel(struct ast_channel *chan, struct
        return ret;
 }
 
-/*--- agent_new: Create new agent channel ---*/
+/*! \brief Create new agent channel ---*/
 static struct ast_channel *agent_new(struct agent_pvt *p, int state)
 {
        struct ast_channel *tmp;
@@ -1305,7 +1305,7 @@ static int allow_multiple_login(char *chan,char *context)
        return -1;
 }
 
-/*--- agent_request: Part of the Asterisk PBX interface ---*/
+/*! \brief Part of the Asterisk PBX interface ---*/
 static struct ast_channel *agent_request(const char *type, int format, void *data, int *cause)
 {
        struct agent_pvt *p;
@@ -2434,7 +2434,7 @@ static void reload_agents(void)
        }
 }
 
-/*--- agent_devicestate: Part of PBX channel interface ---*/
+/*! \brief Part of PBX channel interface ---*/
 static int agent_devicestate(void *data)
 {
        struct agent_pvt *p;
index d8838d4..98103d4 100644 (file)
@@ -316,8 +316,8 @@ static int local_sendhtml(struct ast_channel *ast, int subclass, const char *dat
        return res;
 }
 
-/*--- local_call: Initiate new call, part of PBX interface */
-/*     dest is the dial string */
+/*! \brief Initiate new call, part of PBX interface 
+ *     dest is the dial string */
 static int local_call(struct ast_channel *ast, char *dest, int timeout)
 {
        struct local_pvt *p = ast->tech_pvt;
@@ -381,7 +381,7 @@ static void local_destroy(struct local_pvt *p)
 }
 #endif
 
-/*--- local_hangup: Hangup a call through the local proxy channel */
+/*! \brief Hangup a call through the local proxy channel */
 static int local_hangup(struct ast_channel *ast)
 {
        struct local_pvt *p = ast->tech_pvt;
@@ -452,7 +452,7 @@ static int local_hangup(struct ast_channel *ast)
        return 0;
 }
 
-/*--- local_alloc: Create a call structure */
+/*! \brief Create a call structure */
 static struct local_pvt *local_alloc(char *data, int format)
 {
        struct local_pvt *tmp;
@@ -495,7 +495,7 @@ static struct local_pvt *local_alloc(char *data, int format)
        return tmp;
 }
 
-/*--- local_new: Start new local channel */
+/*! \brief Start new local channel */
 static struct ast_channel *local_new(struct local_pvt *p, int state)
 {
        struct ast_channel *tmp, *tmp2;
@@ -548,7 +548,7 @@ static struct ast_channel *local_new(struct local_pvt *p, int state)
 }
 
 
-/*--- local_request: Part of PBX interface */
+/*! \brief Part of PBX interface */
 static struct ast_channel *local_request(const char *type, int format, void *data, int *cause)
 {
        struct local_pvt *p;
@@ -560,7 +560,7 @@ static struct ast_channel *local_request(const char *type, int format, void *dat
        return chan;
 }
 
-/*--- locals_show: CLI command "local show channels" */
+/*! \brief CLI command "local show channels" */
 static int locals_show(int fd, int argc, char **argv)
 {
        struct local_pvt *p;
@@ -589,7 +589,7 @@ static struct ast_cli_entry cli_show_locals = {
        { "local", "show", "channels", NULL }, locals_show, 
        "Show status of local channels", show_locals_usage, NULL };
 
-/*--- load_module: Load module into PBX, register channel */
+/*! \brief Load module into PBX, register channel */
 int load_module()
 {
        /* Make sure we can register our channel type */
@@ -601,13 +601,13 @@ int load_module()
        return 0;
 }
 
-/*--- reload: Reload module */
+/*! \brief Reload module */
 int reload()
 {
        return 0;
 }
 
-/*--- unload_module: Unload the local proxy channel from Asterisk */
+/*! \brief Unload the local proxy channel from Asterisk */
 int unload_module()
 {
        struct local_pvt *p;
index 5840e30..697577e 100644 (file)
--- a/config.c
+++ b/config.c
@@ -898,7 +898,7 @@ int ast_config_engine_deregister(struct ast_config_engine *del)
        return 0;
 }
 
-/*--- find_engine: Find realtime engine for realtime family */
+/*! \brief Find realtime engine for realtime family */
 static struct ast_config_engine *find_engine(const char *family, char *database, int dbsiz, char *table, int tabsiz) 
 {
        struct ast_config_engine *eng, *ret = NULL;
@@ -1008,7 +1008,7 @@ struct ast_variable *ast_load_realtime(const char *family, ...)
        return res;
 }
 
-/*--- ast_check_realtime: Check if realtime engine is configured for family */
+/*! \brief Check if realtime engine is configured for family */
 int ast_check_realtime(const char *family)
 {
        struct ast_config_engine *eng;
index 6cd1d3e..d7f3961 100644 (file)
@@ -71,13 +71,13 @@ static AST_LIST_HEAD_STATIC(state_changes, state_change);
 static pthread_t change_thread = AST_PTHREADT_NULL;
 static ast_cond_t change_pending;
 
-/*--- devstate2str: Find devicestate as text message for output */
+/*! \brief Find devicestate as text message for output */
 const char *devstate2str(int devstate) 
 {
        return devstatestring[devstate];
 }
 
-/*--- ast_parse_device_state: Find out if device is active in a call or not */
+/*! \brief Find out if device is active in a call or not */
 int ast_parse_device_state(const char *device)
 {
        struct ast_channel *chan;
@@ -101,7 +101,7 @@ int ast_parse_device_state(const char *device)
        return res;
 }
 
-/*--- ast_device_state: Check device state through channel specific function or generic function */
+/*! \brief Check device state through channel specific function or generic function */
 int ast_device_state(const char *device)
 {
        char *buf;
@@ -138,7 +138,7 @@ int ast_device_state(const char *device)
        }
 }
 
-/*--- ast_devstate_add: Add device state watcher */
+/*! \brief Add device state watcher */
 int ast_devstate_add(ast_devstate_cb_type callback, void *data)
 {
        struct devstate_cb *devcb;
@@ -160,7 +160,7 @@ int ast_devstate_add(ast_devstate_cb_type callback, void *data)
        return 0;
 }
 
-/*--- ast_devstate_del: Remove device state watcher */
+/*! \brief Remove device state watcher */
 void ast_devstate_del(ast_devstate_cb_type callback, void *data)
 {
        struct devstate_cb *devcb;
@@ -177,7 +177,7 @@ void ast_devstate_del(ast_devstate_cb_type callback, void *data)
        AST_LIST_UNLOCK(&devstate_cbs);
 }
 
-/*--- do_state_change: Notify callback watchers of change, and notify PBX core for hint updates */
+/*! \brief Notify callback watchers of change, and notify PBX core for hint updates */
 static void do_state_change(const char *device)
 {
        int state;
@@ -232,7 +232,7 @@ int ast_device_state_changed_literal(const char *dev)
        return __ast_device_state_changed_literal(buf);
 }
 
-/*--- ast_device_state_changed: Accept change notification, add it to change queue */
+/*! \brief Accept change notification, add it to change queue */
 int ast_device_state_changed(const char *fmt, ...) 
 {
        char buf[AST_MAX_EXTENSION];
@@ -244,7 +244,7 @@ int ast_device_state_changed(const char *fmt, ...)
        return __ast_device_state_changed_literal(buf);
 }
 
-/*--- do_devstate_changes: Go through the dev state change queue and update changes in the dev state thread */
+/*! \brief Go through the dev state change queue and update changes in the dev state thread */
 static void *do_devstate_changes(void *data)
 {
        struct state_change *cur;
@@ -269,7 +269,7 @@ static void *do_devstate_changes(void *data)
        return NULL;
 }
 
-/*--- ast_device_state_engine_init: Initialize the device state engine in separate thread */
+/*! \brief Initialize the device state engine in separate thread */
 int ast_device_state_engine_init(void)
 {
        pthread_attr_t attr;
diff --git a/enum.c b/enum.c
index b977f21..a49e308 100644 (file)
--- a/enum.c
+++ b/enum.c
@@ -82,7 +82,7 @@ struct naptr {
        unsigned short pref;
 } __attribute__ ((__packed__));
 
-/*--- parse_ie: Parse NAPTR record information elements */
+/*! \brief Parse NAPTR record information elements */
 static int parse_ie(char *data, int maxdatalen, char *src, int srclen)
 {
        int len, olen;
@@ -100,7 +100,7 @@ static int parse_ie(char *data, int maxdatalen, char *src, int srclen)
        return olen + 1;
 }
 
-/*--- parse_naptr: Parse DNS NAPTR record used in ENUM ---*/
+/*! \brief Parse DNS NAPTR record used in ENUM ---*/
 static int parse_naptr(char *dst, int dstsize, char *tech, int techsize, char *answer, int len, char *naptrinput)
 {
 
@@ -309,7 +309,7 @@ struct enum_context {
        int naptr_rrs_count; /* Size of array naptr_rrs */
 };
 
-/*--- txt_callback: Callback for TXT record lookup */
+/*! \brief Callback for TXT record lookup */
 static int txt_callback(void *context, char *answer, int len, char *fullanswer)
 {
        struct enum_context *c = (struct enum_context *)context;
@@ -344,7 +344,7 @@ static int txt_callback(void *context, char *answer, int len, char *fullanswer)
        return 1;
 }
 
-/*--- enum_callback: Callback from ENUM lookup function */
+/*! \brief Callback from ENUM lookup function */
 static int enum_callback(void *context, char *answer, int len, char *fullanswer)
 {
        struct enum_context *c = (struct enum_context *)context;
@@ -383,7 +383,7 @@ static int enum_callback(void *context, char *answer, int len, char *fullanswer)
        return 0;
 }
 
-/*--- ast_get_enum: ENUM lookup */
+/*! \brief ENUM lookup */
 int ast_get_enum(struct ast_channel *chan, const char *number, char *dst, int dstlen, char *tech, int techlen, char* suffix, char* options)
 {
        struct enum_context context;
@@ -545,7 +545,7 @@ int ast_get_enum(struct ast_channel *chan, const char *number, char *dst, int ds
        return ret;
 }
 
-/*--- ast_get_txt: Get TXT record from DNS.
+/*! \brief Get TXT record from DNS.
        Really has nothing to do with enum, but anyway...
  */
 int ast_get_txt(struct ast_channel *chan, const char *number, char *dst, int dstlen, char *tech, int techlen, char *txt, int txtlen)
@@ -608,7 +608,7 @@ int ast_get_txt(struct ast_channel *chan, const char *number, char *dst, int dst
        return ret;
 }
 
-/*--- enum_newtoplev: Add enum tree to linked list ---*/
+/*! \brief Add enum tree to linked list ---*/
 static struct enum_search *enum_newtoplev(char *s)
 {
        struct enum_search *tmp;
@@ -621,7 +621,7 @@ static struct enum_search *enum_newtoplev(char *s)
        return tmp;
 }
 
-/*--- ast_enum_init: Initialize the ENUM support subsystem */
+/*! \brief Initialize the ENUM support subsystem */
 int ast_enum_init(void)
 {
        struct ast_config *cfg;
index 7de58c9..afdfa58 100644 (file)
--- a/logger.c
+++ b/logger.c
@@ -500,8 +500,7 @@ static int handle_logger_rotate(int fd, int argc, char *argv[])
                return RESULT_SUCCESS;
 }
 
-/*--- handle_logger_show_channels: CLI command to show logging system 
-       configuration */
+/*! \brief CLI command to show logging system configuration */
 static int handle_logger_show_channels(int fd, int argc, char *argv[])
 {
 #define FORMATL        "%-35.35s %-8.8s %-9.9s "