[Asterisk-cvs] asterisk manager.c, 1.128, 1.129 pbx.c, 1.290, 1.291 say.c, 1.71, 1.72 utils.c, 1.76, 1.77

russell russell
Wed Oct 26 09:10:26 CDT 2005 

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

Modified Files:
	manager.c pbx.c say.c utils.c 
Log Message:
more doxygenification (issue #5513)


Index: manager.c
===================================================================
RCS file: /usr/cvsroot/asterisk/manager.c,v
retrieving revision 1.128
retrieving revision 1.129
diff -u -d -r1.128 -r1.129
--- manager.c	24 Oct 2005 20:12:05 -0000	1.128
+++ manager.c	26 Oct 2005 13:03:16 -0000	1.129
@@ -195,7 +195,7 @@
 	return RESULT_SUCCESS;
 }
 
-/*--- handle_showmancmds: CLI command */
+/*! \brief  handle_showmancmds: CLI command */
 /* Should change to "manager show commands" */
 static int handle_showmancmds(int fd, int argc, char *argv[])
 {
@@ -215,7 +215,7 @@
 	return RESULT_SUCCESS;
 }
 
-/*--- handle_showmanconn: CLI command show manager connected */
+/*! \brief  handle_showmanconn: CLI command show manager connected */
 /* Should change to "manager show connected" */
 static int handle_showmanconn(int fd, int argc, char *argv[])
 {
@@ -737,7 +737,7 @@
 }
 
 
-/*--- action_status: Manager "status" command to show channels */
+/*! \brief  action_status: Manager "status" command to show channels */
 /* Needs documentation... */
 static int action_status(struct mansession *s, struct message *m)
 {
@@ -835,7 +835,7 @@
 "	*Priority: Priority to transfer to\n"
 "	ActionID: Optional Action id for message matching.\n";
 
-/*--- action_redirect: The redirect manager command */
+/*! \brief  action_redirect: The redirect manager command */
 static int action_redirect(struct mansession *s, struct message *m)
 {
 	char *name = astman_get_header(m, "Channel");
@@ -892,7 +892,7 @@
 "	*Command: Asterisk CLI command to run\n"
 "	ActionID: Optional Action id for message matching.\n";
 
-/*--- action_command: Manager command "command" - execute CLI command */
+/*! \brief  action_command: Manager command "command" - execute CLI command */
 static int action_command(struct mansession *s, struct message *m)
 {
 	char *cmd = astman_get_header(m, "Command");
@@ -1477,7 +1477,7 @@
 	return -1;
 }
 
-/*--- manager_event: Send AMI event to client */
+/*! \brief  manager_event: Send AMI event to client */
 int manager_event(int category, char *event, char *fmt, ...)
 {
 	struct mansession *s;

Index: pbx.c
===================================================================
RCS file: /usr/cvsroot/asterisk/pbx.c,v
retrieving revision 1.290
retrieving revision 1.291
diff -u -d -r1.290 -r1.291
--- pbx.c	26 Oct 2005 03:58:32 -0000	1.290
+++ pbx.c	26 Oct 2005 13:03:16 -0000	1.291
@@ -57,8 +57,8 @@
 #include "asterisk/app.h"
 #include "asterisk/devicestate.h"
 
-/*
- * I M P O R T A N T :
+/*!
+ * \note I M P O R T A N T :
  *
  *		The speed of extension handling will likely be among the most important
  * aspects of this PBX.  The switching scheme as it exists right now isn't
@@ -984,7 +984,7 @@
 	return ret;
 }
 
-/*--- pbx_retrieve_variable: Support for Asterisk built-in variables and
+/*! \brief  pbx_retrieve_variable: Support for Asterisk built-in variables and
       functions in the dialplan
   ---*/
 void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp)
@@ -1769,7 +1769,7 @@
 
 }
 
-/*--- ast_hint_extension: Find hint for given extension in context */
+/*! \brief  ast_hint_extension: Find hint for given extension in context */
 static struct ast_exten *ast_hint_extension(struct ast_channel *c, const char *context, const char *exten)
 {
 	struct ast_exten *e;
@@ -1789,7 +1789,7 @@
 	return e;
 }
 
-/*--- ast_extensions_state2: Check state of extension by using hints */
+/*! \brief  ast_extensions_state2: Check state of extension by using hints */
 static int ast_extension_state2(struct ast_exten *e)
 {
 	char hint[AST_MAX_EXTENSION] = "";    
@@ -1863,7 +1863,7 @@
 	return AST_EXTENSION_NOT_INUSE;
 }
 
-/*--- ast_extension_state2str: Return extension_state as string */
+/*! \brief  ast_extension_state2str: Return extension_state as string */
 const char *ast_extension_state2str(int extension_state)
 {
 	int i;
@@ -1876,7 +1876,7 @@
 	return "Unknown";	
 }
 
-/*--- ast_extension_state: Check extension state for an extension by using hint */
+/*! \brief  ast_extension_state: Check extension state for an extension by using hint */
 int ast_extension_state(struct ast_channel *c, char *context, char *exten)
 {
 	struct ast_exten *e;
@@ -1930,7 +1930,7 @@
 	ast_mutex_unlock(&hintlock);
 }
 			
-/*--- ast_extension_state_add: Add watcher for extension states */
+/*! \brief  ast_extension_state_add: Add watcher for extension states */
 int ast_extension_state_add(const char *context, const char *exten, 
 			    ast_state_cb_type callback, void *data)
 {
@@ -2013,7 +2013,7 @@
 	return cblist->id;
 }
 
-/*--- ast_extension_state_del: Remove a watcher from the callback list */
+/*! \brief  ast_extension_state_del: Remove a watcher from the callback list */
 int ast_extension_state_del(int id, ast_state_cb_type callback)
 {
 	struct ast_hint *list;
@@ -2076,7 +2076,7 @@
 	return -1;
 }
 
-/*--- ast_add_hint: Add hint to hint list, check initial extension state */
+/*! \brief  ast_add_hint: Add hint to hint list, check initial extension state */
 static int ast_add_hint(struct ast_exten *e)
 {
 	struct ast_hint *list;
@@ -2119,7 +2119,7 @@
 	return 0;
 }
 
-/*--- ast_change_hint: Change hint for an extension */
+/*! \brief  ast_change_hint: Change hint for an extension */
 static int ast_change_hint(struct ast_exten *oe, struct ast_exten *ne)
 { 
 	struct ast_hint *list;
@@ -2140,7 +2140,7 @@
 	return -1;
 }
 
-/*--- ast_remove_hint: Remove hint from extension */
+/*! \brief  ast_remove_hint: Remove hint from extension */
 static int ast_remove_hint(struct ast_exten *e)
 {
 	/* Cleanup the Notifys if hint is removed */
@@ -2185,7 +2185,7 @@
 }
 
 
-/*--- ast_get_hint: Get hint for channel */
+/*! \brief  ast_get_hint: Get hint for channel */
 int ast_get_hint(char *hint, int hintsize, char *name, int namesize, struct ast_channel *c, const char *context, const char *exten)
 {
 	struct ast_exten *e;
@@ -3129,7 +3129,7 @@
 	return RESULT_SUCCESS;
 }
 
-/*--- handle_show_hints: CLI support for listing registred dial plan hints */
+/*! \brief  handle_show_hints: CLI support for listing registred dial plan hints */
 static int handle_show_hints(int fd, int argc, char *argv[])
 {
 	struct ast_hint *hint;
@@ -3164,7 +3164,7 @@
 	return RESULT_SUCCESS;
 }
 
-/*--- handle_show_switches: CLI support for listing registred dial plan switches */
+/*! \brief  handle_show_switches: CLI support for listing registred dial plan switches */
 static int handle_show_switches(int fd, int argc, char *argv[])
 {
 	struct ast_switch *sw;
@@ -3927,7 +3927,7 @@
 	"sat",
 };
 
-/*--- get_dow: Get day of week */
+/*! \brief  get_dow: Get day of week */
 static unsigned int get_dow(char *dow)
 {
 	char *c;

Index: say.c
===================================================================
RCS file: /usr/cvsroot/asterisk/say.c,v
retrieving revision 1.71
retrieving revision 1.72
diff -u -d -r1.71 -r1.72
--- say.c	24 Oct 2005 20:12:05 -0000	1.71
+++ say.c	26 Oct 2005 13:03:16 -0000	1.72
@@ -402,7 +402,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full: call language-specific functions */
+/*! \brief  ast_say_number_full: call language-specific functions */
 /* Called from AGI */
 int ast_say_number_full(struct ast_channel *chan, int num, const char *ints, const char *language, const char *options, int audiofd, int ctrlfd)
 {
@@ -446,13 +446,13 @@
 	return(ast_say_number_full_en(chan, num, ints, language, audiofd, ctrlfd));
 }
 
-/*--- ast_say_number: call language-specific functions without file descriptors */
+/*! \brief  ast_say_number: call language-specific functions without file descriptors */
 int ast_say_number(struct ast_channel *chan, int num, const char *ints, const char *language, const char *options)
 {
 	return(ast_say_number_full(chan, num, ints, language, options, -1, -1));
 }
 
-/*--- ast_say_number_full_en: English syntax */
+/*! \brief  ast_say_number_full_en: English syntax */
 /* This is the default syntax, if no other syntax defined in this file is used */
 static int ast_say_number_full_en(struct ast_channel *chan, int num, const char *ints, const char *language, int audiofd, int ctrlfd)
 {
@@ -526,7 +526,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_cz: Czech syntax */
+/*! \brief  ast_say_number_full_cz: Czech syntax */
 /* files needed:
  * 1m,2m - gender male
  * 1w,2w - gender female
@@ -641,7 +641,7 @@
 	return res; 
 }
 
-/*--- ast_say_number_full_da: Danish syntax */
+/*! \brief  ast_say_number_full_da: Danish syntax */
 /* New files:
  In addition to English, the following sounds are required: "1N", "millions", "and" and "1-and" through "9-and" 
  */
@@ -749,7 +749,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_de: German syntax */
+/*! \brief  ast_say_number_full_de: German syntax */
 /* New files:
  In addition to English, the following sounds are required:
  "millions"
@@ -889,7 +889,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_en_GB: British and Norwegian syntax */
+/*! \brief  ast_say_number_full_en_GB: British and Norwegian syntax */
 /* New files:
  In addition to American English, the following sounds are required:  "and"
  */
@@ -965,7 +965,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_es: Spanish syntax */
+/*! \brief  ast_say_number_full_es: Spanish syntax */
 /* New files:
  Requires a few new audios:
    1F.gsm: feminine 'una'
@@ -1071,7 +1071,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_fr: French syntax */
+/*! \brief  ast_say_number_full_fr: French syntax */
 /* 	Extra sounds needed:
  	1F: feminin 'une'
  	et: 'and' */
@@ -1163,7 +1163,7 @@
 
 
 
-/*--- ast_say_number_full_he: Hebrew syntax */
+/*! \brief  ast_say_number_full_he: Hebrew syntax */
 /* 	Extra sounds needed:
  	1F: feminin 'one'
 	ve: 'and'
@@ -1307,7 +1307,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_it:  Italian */
+/*! \brief  ast_say_number_full_it:  Italian */
 static int ast_say_number_full_it(struct ast_channel *chan, int num, const char *ints, const char *language, int audiofd, int ctrlfd)
 {
 	int res = 0;
@@ -1460,7 +1460,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_nl: dutch syntax */
+/*! \brief  ast_say_number_full_nl: dutch syntax */
 /* New files: digits/nl-en
  */
 static int ast_say_number_full_nl(struct ast_channel *chan, int num, const char *ints, const char *language, int audiofd, int ctrlfd)
@@ -1537,7 +1537,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_no: Norwegian syntax */
+/*! \brief  ast_say_number_full_no: Norwegian syntax */
 /* New files:
  In addition to American English, the following sounds are required:  "and", "1N"
  */
@@ -2018,7 +2018,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_se: Swedish syntax */
+/*! \brief  ast_say_number_full_se: Swedish syntax */
 static int ast_say_number_full_se(struct ast_channel *chan, int num, const char *ints, const char *language, const char *options, int audiofd, int ctrlfd)
 {
 	int res = 0;
@@ -2090,7 +2090,7 @@
 	return res;
 }
 
-/*--- ast_say_number_full_tw: Taiwanese syntax */
+/*! \brief  ast_say_number_full_tw: Taiwanese syntax */
 static int ast_say_number_full_tw(struct ast_channel *chan, int num, const char *ints, const char *language, int audiofd, int ctrlfd)
 {
 	int res = 0;
@@ -2156,7 +2156,7 @@
 }
 
 
-/*--- determine last digits for thousands/millions (ru) */
+/*! \brief  determine last digits for thousands/millions (ru) */
 static int get_lastdigits_ru(int num) {
 	if (num < 20) {
 		return num;
@@ -2169,8 +2169,8 @@
 }
 
 
-/*--- ast_say_number_full_ru: Russian syntax */
-/*--- additional files:
+/*! \brief  ast_say_number_full_ru: Russian syntax */
+/*! \brief  additional files:
 	n00.gsm			(one hundred, two hundred, ...)
 	thousand.gsm
 	million.gsm
@@ -2262,7 +2262,7 @@
 }
 
 
-/*--- ast_say_enumeration_full: call language-specific functions */
+/*! \brief  ast_say_enumeration_full: call language-specific functions */
 /* Called from AGI */
 int ast_say_enumeration_full(struct ast_channel *chan, int num, const char *ints, const char *language, const char *options, int audiofd, int ctrlfd)
 {
@@ -2278,13 +2278,13 @@
 	return(ast_say_enumeration_full_en(chan, num, ints, language, audiofd, ctrlfd));
 }
 
-/*--- ast_say_enumeration: call language-specific functions without file descriptors */
+/*! \brief  ast_say_enumeration: call language-specific functions without file descriptors */
 int ast_say_enumeration(struct ast_channel *chan, int num, const char *ints, const char *language, const char *options)
 {
 	return(ast_say_enumeration_full(chan, num, ints, language, options, -1, -1));
 }
 
-/*--- ast_say_enumeration_full_en: English syntax */
+/*! \brief  ast_say_enumeration_full_en: English syntax */
 /* This is the default syntax, if no other syntax defined in this file is used */
 static int ast_say_enumeration_full_en(struct ast_channel *chan, int num, const char *ints, const char *language, int audiofd, int ctrlfd)
 {
@@ -2383,7 +2383,7 @@
 	return res;
 }
 
-/*--- ast_say_enumeration_full_da: Danish syntax */
+/*! \brief  ast_say_enumeration_full_da: Danish syntax */
 static int ast_say_enumeration_full_da(struct ast_channel *chan, int num, const char *ints, const char *language, const char *options, int audiofd, int ctrlfd)
 {
 	/* options can be: '' or 'm' male gender; 'f' female gender; 'n' neuter gender; 'p' plural */
@@ -2546,7 +2546,7 @@
 	return res;
 }
 
-/*--- ast_say_enumeration_full_de: German syntax */
+/*! \brief  ast_say_enumeration_full_de: German syntax */
 static int ast_say_enumeration_full_de(struct ast_channel *chan, int num, const char *ints, const char *language, const char *options, int audiofd, int ctrlfd)
 {
 	/* options can be: '' or 'm' male gender; 'f' female gender; 'n' neuter gender; 'p' plural */

Index: utils.c
===================================================================
RCS file: /usr/cvsroot/asterisk/utils.c,v
retrieving revision 1.76
retrieving revision 1.77
diff -u -d -r1.76 -r1.77
--- utils.c	24 Oct 2005 20:12:05 -0000	1.76
+++ utils.c	26 Oct 2005 13:03:17 -0000	1.77
@@ -167,7 +167,7 @@
 
 #endif
 
-/* Re-entrant (thread safe) version of gethostbyname that replaces the 
+/*! \brief Re-entrant (thread safe) version of gethostbyname that replaces the 
    standard gethostbyname (which is not thread safe)
 */
 struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp)
@@ -217,9 +217,6 @@
 }
 
 
-/* This is a regression test for recursive mutexes.
-   test_for_thread_safety() will return 0 if recursive mutex locks are
-   working properly, and non-zero if they are not working properly. */
 
 AST_MUTEX_DEFINE_STATIC(test_lock);
 AST_MUTEX_DEFINE_STATIC(test_lock2);
@@ -227,6 +224,9 @@
 static int lock_count = 0;
 static int test_errors = 0;
 
+/*! \brief This is a regression test for recursive mutexes.
+   test_for_thread_safety() will return 0 if recursive mutex locks are
+   working properly, and non-zero if they are not working properly. */
 static void *test_thread_body(void *data) 
 { 
 	ast_mutex_lock(&test_lock);
@@ -278,7 +278,7 @@
 	return(test_errors);          /* return 0 on success. */
 }
 
-/*--- ast_md5_hash: Produce 16 char MD5 hash of value. ---*/
+/*! \brief ast_md5_hash: Produce 16 char MD5 hash of value. ---*/
 void ast_md5_hash(char *output, char *input)
 {
 	struct MD5Context md5;
@@ -409,7 +409,7 @@
 #endif
 }
 
-/*--- ast_uri_encode: Turn text string to URI-encoded %XX version ---*/
+/*! \brief  ast_uri_encode: Turn text string to URI-encoded %XX version ---*/
 /* 	At this point, we're converting from ISO-8859-x (8-bit), not UTF8
 	as in the SIP protocol spec 
 	If doreserved == 1 we will convert reserved characters also.
@@ -451,7 +451,7 @@
 	return outbuf;
 }
 
-/*--- ast_uri_decode: Decode SIP URI, URN, URL (overwrite the string)  ---*/
+/*! \brief  ast_uri_decode: Decode SIP URI, URN, URL (overwrite the string)  ---*/
 void ast_uri_decode(char *s) 
 {
 	char *o;
@@ -468,7 +468,7 @@
 	*o = '\0';
 }
 
-/*--- ast_inet_ntoa: Recursive thread safe replacement of inet_ntoa */
+/*! \brief  ast_inet_ntoa: Recursive thread safe replacement of inet_ntoa */
 const char *ast_inet_ntoa(char *buf, int bufsiz, struct in_addr ia)
 {
 	return inet_ntop(AF_INET, &ia, buf, bufsiz);

More information about the svn-commits mailing list