[Asterisk-cvs] asterisk acl.c, 1.57, 1.58 aescrypt.c, 1.2,
1.3 aeskey.c, 1.2, 1.3 alaw.c, 1.5, 1.6 app.c, 1.76,
1.77 asterisk.c, 1.183, 1.184 astmm.c, 1.22,
1.23 autoservice.c, 1.14, 1.15 callerid.c, 1.36, 1.37 cdr.c,
1.53, 1.54 channel.c, 1.251, 1.252 chanvars.c, 1.12,
1.13 cli.c, 1.101, 1.102 config.c, 1.78, 1.79 db.c, 1.23,
1.24 devicestate.c, 1.8, 1.9 dns.c, 1.18, 1.19 dnsmgr.c, 1.8,
1.9 dsp.c, 1.49, 1.50 enum.c, 1.33, 1.34 file.c, 1.78,
1.79 frame.c, 1.64, 1.65 fskmodem.c, 1.9, 1.10 image.c, 1.17,
1.18 indications.c, 1.29, 1.30 io.c, 1.14, 1.15 jitterbuf.c,
1.20, 1.21 loader.c, 1.52, 1.53 logger.c, 1.85, 1.86 manager.c,
1.127, 1.128 md5.c, 1.15, 1.16 muted.c, 1.12, 1.13 netsock.c,
1.2, 1.3 pbx.c, 1.288, 1.289 plc.c, 1.8, 1.9 privacy.c, 1.8,
1.9 rtp.c, 1.150, 1.151 say.c, 1.70, 1.71 sched.c, 1.25,
1.26 slinfactory.c, 1.3, 1.4 srv.c, 1.17, 1.18 tdd.c, 1.8,
1.9 term.c, 1.14, 1.15 translate.c, 1.43, 1.44 ulaw.c, 1.6,
1.7 utils.c, 1.75, 1.76
russell
russell
Mon Oct 24 16:19:03 CDT 2005
Update of /usr/cvsroot/asterisk
In directory mongoose.digium.com:/tmp/cvs-serv2226
Modified Files:
acl.c aescrypt.c aeskey.c alaw.c app.c asterisk.c astmm.c
autoservice.c callerid.c cdr.c channel.c chanvars.c cli.c
config.c db.c devicestate.c dns.c dnsmgr.c dsp.c enum.c file.c
frame.c fskmodem.c image.c indications.c io.c jitterbuf.c
loader.c logger.c manager.c md5.c muted.c netsock.c pbx.c
plc.c privacy.c rtp.c say.c sched.c slinfactory.c srv.c tdd.c
term.c translate.c ulaw.c utils.c
Log Message:
Doxygen documentation update from oej (issue #5505)
Index: acl.c
===================================================================
RCS file: /usr/cvsroot/asterisk/acl.c,v
retrieving revision 1.57
retrieving revision 1.58
diff -u -d -r1.57 -r1.58
--- acl.c 14 Sep 2005 20:46:49 -0000 1.57
+++ acl.c 24 Oct 2005 20:12:04 -0000 1.58
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Various sorts of access control
+ * \brief Various sorts of access control
*
*/
Index: aescrypt.c
===================================================================
RCS file: /usr/cvsroot/asterisk/aescrypt.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- aescrypt.c 7 Jan 2004 20:45:50 -0000 1.2
+++ aescrypt.c 24 Oct 2005 20:12:04 -0000 1.3
@@ -30,7 +30,9 @@
---------------------------------------------------------------------------
Issue Date: 26/08/2003
- This file contains the code for implementing encryption and decryption
+*/
+/*! \file
+\brief This file contains the code for implementing encryption and decryption
for AES (Rijndael) for block and key sizes of 16, 24 and 32 bytes. It
can optionally be replaced by code written in assembler using NASM. For
further details see the file aesopt.h
Index: aeskey.c
===================================================================
RCS file: /usr/cvsroot/asterisk/aeskey.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- aeskey.c 7 Jan 2004 20:45:50 -0000 1.2
+++ aeskey.c 24 Oct 2005 20:12:04 -0000 1.3
@@ -30,7 +30,9 @@
---------------------------------------------------------------------------
Issue Date: 26/08/2003
- This file contains the code for implementing the key schedule for AES
+*/
+/*! \file
+\brief This file contains the code for implementing the key schedule for AES
(Rijndael) for block and key sizes of 16, 24, and 32 bytes. See aesopt.h
for further details including optimisation.
*/
Index: alaw.c
===================================================================
RCS file: /usr/cvsroot/asterisk/alaw.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- alaw.c 14 Sep 2005 20:46:49 -0000 1.5
+++ alaw.c 24 Oct 2005 20:12:04 -0000 1.6
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * u-Law to Signed linear conversion
+ * \brief u-Law to Signed linear conversion
*
*/
Index: app.c
===================================================================
RCS file: /usr/cvsroot/asterisk/app.c,v
retrieving revision 1.76
retrieving revision 1.77
diff -u -d -r1.76 -r1.77
--- app.c 14 Sep 2005 20:46:49 -0000 1.76
+++ app.c 24 Oct 2005 20:12:04 -0000 1.77
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Convenient Application Routines
+ * \brief Convenient Application Routines
*
*/
Index: asterisk.c
===================================================================
RCS file: /usr/cvsroot/asterisk/asterisk.c,v
retrieving revision 1.183
retrieving revision 1.184
diff -u -d -r1.183 -r1.184
--- asterisk.c 29 Sep 2005 02:38:24 -0000 1.183
+++ asterisk.c 24 Oct 2005 20:12:04 -0000 1.184
@@ -16,10 +16,41 @@
* at the top of the source tree.
*/
-/*
+
+/* Doxygenified Copyright Header */
+/*!
+ * \mainpage Asterisk -- An Open Source Telephony Toolkit
+ *
+ * \arg \ref DevDoc
+ * \arg \ref ConfigFiles
+ *
+ * \section copyright Copyright and author
+ *
+ * Copyright (C) 1999 - 2005, Digium, Inc.
+ * Asterisk is a trade mark registered by Digium, Inc.
+ *
+ * \author Mark Spencer <markster at digium.com>
+ * Also see \ref AstCREDITS
+ *
+ * \section license License
+ * 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.
+ *
+ * \verbinclude LICENSE
*
- * Top level source file for asterisk
- *
+ */
+
+/*! \file
+ \brief Top level source file for Asterisk - the Open Source PBX. Implementation
+ of PBX core functions and CLI interface.
+
*/
#include <unistd.h>
@@ -78,6 +109,8 @@
#include "asterisk/linkedlists.h"
#include "asterisk/devicestate.h"
+#include "asterisk/doxyref.h" /* Doxygen documentation */
+
#include "defaults.h"
#ifndef AF_LOCAL
@@ -116,19 +149,20 @@
char record_cache_dir[AST_CACHE_DIR_LEN] = AST_TMP_DIR;
char debug_filename[AST_FILENAME_MAX] = "";
-static int ast_socket = -1; /* UNIX Socket for allowing remote control */
-static int ast_consock = -1; /* UNIX Socket for controlling another asterisk */
+static int ast_socket = -1; /*!< UNIX Socket for allowing remote control */
+static int ast_consock = -1; /*!< UNIX Socket for controlling another asterisk */
int ast_mainpid;
struct console {
- int fd; /* File descriptor */
- int p[2]; /* Pipe */
- pthread_t t; /* Thread of handler */
+ int fd; /*!< File descriptor */
+ int p[2]; /*!< Pipe */
+ pthread_t t; /*!< Thread of handler */
};
static struct ast_atexit {
void (*func)(void);
struct ast_atexit *next;
} *atexits = NULL;
+
AST_MUTEX_DEFINE_STATIC(atexitslock);
time_t ast_startuptime;
@@ -222,6 +256,7 @@
" Shows the revision numbers of the files used to build this copy of Asterisk.\n"
" Optional regular expression pattern is used to filter the file list.\n";
+/*! CLI command to list module versions */
static int handle_show_version_files(int fd, int argc, char *argv[])
{
#define FORMAT "%-25.25s %-40.40s\n"
@@ -343,7 +378,7 @@
return write(fd, s, strlen(s) + 1);
}
-/* NULL handler so we can collect the child exit status */
+/*! NULL handler so we can collect the child exit status */
static void null_sig_handler(int signal)
{
@@ -408,7 +443,7 @@
return res;
}
-/*
+/*!
* write the string to all attached console clients
*/
static void ast_network_puts(const char *string)
@@ -420,7 +455,7 @@
}
}
-/*
+/*!
* write the string to the console, and all attached
* console clients
*/
@@ -657,13 +692,15 @@
return 1;
}
+/*! Urgent handler
+ Called by soft_hangup to interrupt the poll, read, or other
+ system call. We don't actually need to do anything though.
+ Remember: Cannot EVER ast_log from within a signal handler
+ SLD: seems to be some pthread activity relating to the printf anyway:
+ which is leading to a deadlock?
+ */
static void urg_handler(int num)
{
- /* Called by soft_hangup to interrupt the poll, read, or other
- system call. We don't actually need to do anything though. */
- /* Cannot EVER ast_log from within a signal handler */
- /* SLD: seems to be some pthread activity relating to the printf anyway:
- * which is leading to a deadlock? */
#if 0
if (option_debug > 2)
printf("-- Asterisk Urgent handler\n");
@@ -698,9 +735,9 @@
signal(sig, child_handler);
}
+/*! Set an X-term or screen title */
static void set_title(char *text)
{
- /* Set an X-term or screen title */
if (getenv("TERM") && strstr(getenv("TERM"), "xterm"))
fprintf(stdout, "\033]2;%s\007", text);
}
@@ -711,12 +748,12 @@
fprintf(stdout, "\033]1;%s\007", text);
}
+/*! We set ourselves to a high priority, that we might pre-empt everything
+ else. If your PBX has heavy activity on it, this is a good thing. */
int ast_set_priority(int pri)
{
struct sched_param sched;
memset(&sched, 0, sizeof(sched));
- /* We set ourselves to a high priority, that we might pre-empt everything
- else. If your PBX has heavy activity on it, this is a good thing. */
#ifdef __linux__
if (pri) {
sched.sched_priority = 10;
Index: astmm.c
===================================================================
RCS file: /usr/cvsroot/asterisk/astmm.c,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -d -r1.22 -r1.23
--- astmm.c 29 Sep 2005 04:34:11 -0000 1.22
+++ astmm.c 24 Oct 2005 20:12:04 -0000 1.23
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Memory Management
+ * \brief Memory Management
*
*/
Index: autoservice.c
===================================================================
RCS file: /usr/cvsroot/asterisk/autoservice.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- autoservice.c 14 Sep 2005 20:46:49 -0000 1.14
+++ autoservice.c 24 Oct 2005 20:12:04 -0000 1.15
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Automatic channel service routines
+ * \brief Automatic channel service routines
*
*/
Index: callerid.c
===================================================================
RCS file: /usr/cvsroot/asterisk/callerid.c,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -d -r1.36 -r1.37
--- callerid.c 14 Sep 2005 20:46:49 -0000 1.36
+++ callerid.c 24 Oct 2005 20:12:04 -0000 1.37
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * CallerID Generation support
+ * \brief CallerID Generation support
*
*/
Index: cdr.c
===================================================================
RCS file: /usr/cvsroot/asterisk/cdr.c,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -d -r1.53 -r1.54
--- cdr.c 14 Sep 2005 20:46:49 -0000 1.53
+++ cdr.c 24 Oct 2005 20:12:04 -0000 1.54
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Call Detail Record API
+ * \brief Call Detail Record API
*
* Includes code and algorithms from the Zapata library.
*
Index: channel.c
===================================================================
RCS file: /usr/cvsroot/asterisk/channel.c,v
retrieving revision 1.251
retrieving revision 1.252
diff -u -d -r1.251 -r1.252
--- channel.c 20 Oct 2005 22:45:47 -0000 1.251
+++ channel.c 24 Oct 2005 20:12:04 -0000 1.252
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Channel Management
+ * \brief Channel Management
*
*/
Index: chanvars.c
===================================================================
RCS file: /usr/cvsroot/asterisk/chanvars.c,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- chanvars.c 5 Oct 2005 21:11:17 -0000 1.12
+++ chanvars.c 24 Oct 2005 20:12:04 -0000 1.13
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Channel Variables
+ * \brief Channel Variables
*
*/
Index: cli.c
===================================================================
RCS file: /usr/cvsroot/asterisk/cli.c,v
retrieving revision 1.101
retrieving revision 1.102
diff -u -d -r1.101 -r1.102
--- cli.c 11 Oct 2005 20:20:40 -0000 1.101
+++ cli.c 24 Oct 2005 20:12:04 -0000 1.102
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Standard Command Line Interface
+ * \brief Standard Command Line Interface
*
*/
Index: config.c
===================================================================
RCS file: /usr/cvsroot/asterisk/config.c,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -d -r1.78 -r1.79
--- config.c 17 Oct 2005 13:53:50 -0000 1.78
+++ config.c 24 Oct 2005 20:12:04 -0000 1.79
@@ -16,10 +16,12 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Configuration File Parser
- *
+ * \brief Configuration File Parser
+ *
+ * Includes the Asterisk Realtime API - ARA
+ * See README.realtime
*/
#include <stdio.h>
Index: db.c
===================================================================
RCS file: /usr/cvsroot/asterisk/db.c,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -d -r1.23 -r1.24
--- db.c 28 Sep 2005 23:10:13 -0000 1.23
+++ db.c 24 Oct 2005 20:12:04 -0000 1.24
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Channel Management
+ * \brief ASTdb Management
*
*
* DB3 is licensed under Sleepycat Public License and is thus incompatible
Index: devicestate.c
===================================================================
RCS file: /usr/cvsroot/asterisk/devicestate.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- devicestate.c 17 Oct 2005 15:41:55 -0000 1.8
+++ devicestate.c 24 Oct 2005 20:12:04 -0000 1.9
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Device state management
+ * \brief Device state management
*
*/
Index: dns.c
===================================================================
RCS file: /usr/cvsroot/asterisk/dns.c,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19
--- dns.c 14 Sep 2005 20:46:49 -0000 1.18
+++ dns.c 24 Oct 2005 20:12:04 -0000 1.19
@@ -18,10 +18,11 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * DNS Support for Asterisk
+ * \brief DNS Support for Asterisk
*
+ * \author Thorsten Lockert <tholo at trollphone.org>
*/
#include <sys/types.h>
Index: dnsmgr.c
===================================================================
RCS file: /usr/cvsroot/asterisk/dnsmgr.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- dnsmgr.c 14 Sep 2005 20:46:49 -0000 1.8
+++ dnsmgr.c 24 Oct 2005 20:12:04 -0000 1.9
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Background DNS update manager
+ * \brief Background DNS update manager
*
*/
Index: dsp.c
===================================================================
RCS file: /usr/cvsroot/asterisk/dsp.c,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -d -r1.49 -r1.50
--- dsp.c 15 Sep 2005 15:44:25 -0000 1.49
+++ dsp.c 24 Oct 2005 20:12:04 -0000 1.50
@@ -19,9 +19,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Convenience Signal Processing routines
+ * \brief Convenience Signal Processing routines
*
*/
Index: enum.c
===================================================================
RCS file: /usr/cvsroot/asterisk/enum.c,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -d -r1.33 -r1.34
--- enum.c 23 Sep 2005 02:40:38 -0000 1.33
+++ enum.c 24 Oct 2005 20:12:04 -0000 1.34
@@ -18,9 +18,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * ENUM Support for Asterisk
+ * \brief ENUM Support for Asterisk
*
*/
Index: file.c
===================================================================
RCS file: /usr/cvsroot/asterisk/file.c,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -d -r1.78 -r1.79
--- file.c 16 Oct 2005 23:26:35 -0000 1.78
+++ file.c 24 Oct 2005 20:12:05 -0000 1.79
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Generic File Format Support.
+ * \brief Generic File Format Support.
*
*/
Index: frame.c
===================================================================
RCS file: /usr/cvsroot/asterisk/frame.c,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -d -r1.64 -r1.65
--- frame.c 29 Sep 2005 17:40:24 -0000 1.64
+++ frame.c 24 Oct 2005 20:12:05 -0000 1.65
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Frame manipulation routines
+ * \brief Frame manipulation routines
*
*/
Index: fskmodem.c
===================================================================
RCS file: /usr/cvsroot/asterisk/fskmodem.c,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- fskmodem.c 14 Sep 2005 20:46:49 -0000 1.9
+++ fskmodem.c 24 Oct 2005 20:12:05 -0000 1.10
@@ -18,9 +18,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * FSK Modulator/Demodulator
+ * \brief FSK Modulator/Demodulator
*
*/
Index: image.c
===================================================================
RCS file: /usr/cvsroot/asterisk/image.c,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -r1.17 -r1.18
--- image.c 14 Sep 2005 20:46:49 -0000 1.17
+++ image.c 24 Oct 2005 20:12:05 -0000 1.18
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Channel Management
+ * \brief Image Management
*
*/
Index: indications.c
===================================================================
RCS file: /usr/cvsroot/asterisk/indications.c,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -d -r1.29 -r1.30
--- indications.c 16 Oct 2005 03:07:15 -0000 1.29
+++ indications.c 24 Oct 2005 20:12:05 -0000 1.30
@@ -3,7 +3,6 @@
*
* Copyright (C) 2002, Pauline Middelink
*
- * Pauline Middelink <middelink at polyware.nl>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
@@ -16,10 +15,12 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Tone Management
+ * \brief Tone Management
*
+ * \author Pauline Middelink <middelink at polyware.nl>
+ *
* This set of function allow us to play a list of tones on a channel.
* Each element has two frequencies, which are mixed together and a
* duration. For silence both frequencies can be set to 0.
Index: io.c
===================================================================
RCS file: /usr/cvsroot/asterisk/io.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- io.c 14 Sep 2005 20:46:49 -0000 1.14
+++ io.c 24 Oct 2005 20:12:05 -0000 1.15
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * I/O Managment (Derived from Cheops-NG)
+ * \brief I/O Managment (Derived from Cheops-NG)
*
*/
Index: jitterbuf.c
===================================================================
RCS file: /usr/cvsroot/asterisk/jitterbuf.c,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -d -r1.20 -r1.21
--- jitterbuf.c 15 Sep 2005 15:44:26 -0000 1.20
+++ jitterbuf.c 24 Oct 2005 20:12:05 -0000 1.21
@@ -19,9 +19,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * jitterbuf: an application-independent jitterbuffer
+ * \brief jitterbuf: an application-independent jitterbuffer
*
*/
Index: loader.c
===================================================================
RCS file: /usr/cvsroot/asterisk/loader.c,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -d -r1.52 -r1.53
--- loader.c 26 Sep 2005 17:17:56 -0000 1.52
+++ loader.c 24 Oct 2005 20:12:05 -0000 1.53
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Module Loader
+ * \brief Module Loader
*
*/
Index: logger.c
===================================================================
RCS file: /usr/cvsroot/asterisk/logger.c,v
retrieving revision 1.85
retrieving revision 1.86
diff -u -d -r1.85 -r1.86
--- logger.c 5 Oct 2005 00:21:56 -0000 1.85
+++ logger.c 24 Oct 2005 20:12:05 -0000 1.86
@@ -16,8 +16,8 @@
* at the top of the source tree.
*/
-/*
- * Asterisk Logger
+/*! \file
+ * \brief Asterisk Logger
*
* Logging routines
*
Index: manager.c
===================================================================
RCS file: /usr/cvsroot/asterisk/manager.c,v
retrieving revision 1.127
retrieving revision 1.128
diff -u -d -r1.127 -r1.128
--- manager.c 14 Oct 2005 20:37:40 -0000 1.127
+++ manager.c 24 Oct 2005 20:12:05 -0000 1.128
@@ -16,12 +16,13 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * The Asterisk Management Interface - AMI
+ * \brief The Asterisk Management Interface - AMI
*
* Channel Management and more
*
+ * \ref manconf
*/
#include <stdio.h>
@@ -100,7 +101,7 @@
static struct manager_action *first_action = NULL;
AST_MUTEX_DEFINE_STATIC(actionlock);
-/* If you are calling carefulwrite, it is assumed that you are calling
+/*! If you are calling ast_carefulwrite, it is assumed that you are calling
it on a file descriptor that _DOES_ have NONBLOCK set. This way,
there is only one system call made to do a write, unless we actually
have a need to wait. This way, we get better performance. */
@@ -131,7 +132,7 @@
return res;
}
-/*--- authority_to_str: Convert authority code to string with serveral options */
+/*! authority_to_str: Convert authority code to string with serveral options */
static char *authority_to_str(int authority, char *res, int reslen)
{
int running_total = 0, i;
@@ -334,7 +335,7 @@
return head;
}
-/* NOTE:
+/*! NOTE:
Callers of astman_send_error(), astman_send_response() or astman_send_ack() must EITHER
hold the session lock _or_ be running in an action callback (in which case s->busy will
be non-zero). In either of these cases, there is no need to lock-protect the session's
@@ -342,7 +343,6 @@
be read until either the current action finishes or get_input() obtains the session
lock.
*/
-
void astman_send_error(struct mansession *s, struct message *m, char *error)
{
char *id = astman_get_header(m,"ActionID");
@@ -371,7 +371,7 @@
astman_send_response(s, m, "Success", msg);
}
-/* Tells you if smallstr exists inside bigstr
+/*! Tells you if smallstr exists inside bigstr
which is delim by delim and uses no buf or stringsep
ast_instring("this|that|more","this",',') == 1;
@@ -452,7 +452,7 @@
return ret;
}
-/*
+/*!
Rather than braindead on,off this now can also accept a specific int mask value
or a ',' delim list of mask strings (the same as manager.conf) -anthm
*/
Index: md5.c
===================================================================
RCS file: /usr/cvsroot/asterisk/md5.c,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- md5.c 6 Jun 2005 22:12:18 -0000 1.15
+++ md5.c 24 Oct 2005 20:12:05 -0000 1.16
@@ -1,4 +1,6 @@
-/* MD5 checksum routines used for authentication. Not covered by GPL, but
+
+/*!\file
+\brief MD5 checksum routines used for authentication. Not covered by GPL, but
in the public domain as per the copyright below */
/*
Index: muted.c
===================================================================
RCS file: /usr/cvsroot/asterisk/muted.c,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- muted.c 15 Sep 2005 15:44:26 -0000 1.12
+++ muted.c 24 Oct 2005 20:12:05 -0000 1.13
@@ -19,8 +19,8 @@
* at the top of the source tree.
*/
-/*
- * Mute Daemon
+/*! \file
+ * \brief Mute Daemon
*
* Specially written for Malcolm Davenport, but I think I'll use it too
*
Index: netsock.c
===================================================================
RCS file: /usr/cvsroot/asterisk/netsock.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- netsock.c 14 Sep 2005 20:46:49 -0000 1.2
+++ netsock.c 24 Oct 2005 20:12:05 -0000 1.3
@@ -17,9 +17,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Network socket handling
+ * \brief Network socket handling
*
*/
Index: pbx.c
===================================================================
RCS file: /usr/cvsroot/asterisk/pbx.c,v
retrieving revision 1.288
retrieving revision 1.289
diff -u -d -r1.288 -r1.289
--- pbx.c 18 Oct 2005 19:16:13 -0000 1.288
+++ pbx.c 24 Oct 2005 20:12:05 -0000 1.289
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Core PBX routines.
+ * \brief Core PBX routines.
*
*/
Index: plc.c
===================================================================
RCS file: /usr/cvsroot/asterisk/plc.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- plc.c 15 Sep 2005 15:44:26 -0000 1.8
+++ plc.c 24 Oct 2005 20:12:05 -0000 1.9
@@ -22,9 +22,9 @@
* This version is disclaimed to DIGIUM for inclusion in the Asterisk project.
*/
-/*
+/*! \file
*
- * SpanDSP - a series of DSP components for telephony
+ * \brief SpanDSP - a series of DSP components for telephony
*
*/
Index: privacy.c
===================================================================
RCS file: /usr/cvsroot/asterisk/privacy.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- privacy.c 14 Sep 2005 20:46:49 -0000 1.8
+++ privacy.c 24 Oct 2005 20:12:05 -0000 1.9
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Privacy Routines
+ * \brief Privacy Routines
*
*/
Index: rtp.c
===================================================================
RCS file: /usr/cvsroot/asterisk/rtp.c,v
retrieving revision 1.150
retrieving revision 1.151
diff -u -d -r1.150 -r1.151
--- rtp.c 14 Oct 2005 17:02:20 -0000 1.150
+++ rtp.c 24 Oct 2005 20:12:05 -0000 1.151
@@ -17,7 +17,7 @@
*/
/*!
- * \file rtp.c
+ * \file
* \brief Supports RTP and RTCP with Symmetric RTP support for NAT traversal.
*
* RTP is deffined in RFC 3550.
Index: say.c
===================================================================
RCS file: /usr/cvsroot/asterisk/say.c,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -d -r1.70 -r1.71
--- say.c 27 Sep 2005 02:25:12 -0000 1.70
+++ say.c 24 Oct 2005 20:12:05 -0000 1.71
@@ -17,9 +17,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Say numbers and dates (maybe words one day too)
+ * \brief Say numbers and dates (maybe words one day too)
*
* 12-16-2004 : Support for Greek added by InAccess Networks (work funded by HOL, www.hol.gr)
* George Konstantoulakis <gkon at inaccessnetworks.com>
Index: sched.c
===================================================================
RCS file: /usr/cvsroot/asterisk/sched.c,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -d -r1.25 -r1.26
--- sched.c 14 Sep 2005 20:46:49 -0000 1.25
+++ sched.c 24 Oct 2005 20:12:05 -0000 1.26
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Scheduler Routines (from cheops-NG)
+ * \brief Scheduler Routines (from cheops-NG)
*
*/
Index: slinfactory.c
===================================================================
RCS file: /usr/cvsroot/asterisk/slinfactory.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- slinfactory.c 17 Oct 2005 17:54:05 -0000 1.3
+++ slinfactory.c 24 Oct 2005 20:12:05 -0000 1.4
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * A machine to gather up arbitrary frames and convert them
+ * \brief A machine to gather up arbitrary frames and convert them
* to raw slinear on demand.
*
*/
Index: srv.c
===================================================================
RCS file: /usr/cvsroot/asterisk/srv.c,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -r1.17 -r1.18
--- srv.c 14 Sep 2005 20:46:49 -0000 1.17
+++ srv.c 24 Oct 2005 20:12:05 -0000 1.18
@@ -18,9 +18,11 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * ENUM Support for Asterisk
+ * \brief DNS SRV Record Lookup Support for Asterisk
+ *
+ * \arg See also \ref AstENUM
*
*/
Index: tdd.c
===================================================================
RCS file: /usr/cvsroot/asterisk/tdd.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- tdd.c 14 Sep 2005 20:46:49 -0000 1.8
+++ tdd.c 24 Oct 2005 20:12:05 -0000 1.9
@@ -18,9 +18,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * TTY/TDD Generation support
+ * \brief TTY/TDD Generation support
*
*/
Index: term.c
===================================================================
RCS file: /usr/cvsroot/asterisk/term.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- term.c 14 Sep 2005 20:46:49 -0000 1.14
+++ term.c 24 Oct 2005 20:12:05 -0000 1.15
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Terminal Routines
+ * \brief Terminal Routines
*
*/
Index: translate.c
===================================================================
RCS file: /usr/cvsroot/asterisk/translate.c,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -d -r1.43 -r1.44
--- translate.c 14 Sep 2005 20:46:49 -0000 1.43
+++ translate.c 24 Oct 2005 20:12:05 -0000 1.44
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Translate via the use of pseudo channels
+ * \brief Translate via the use of pseudo channels
*
*/
Index: ulaw.c
===================================================================
RCS file: /usr/cvsroot/asterisk/ulaw.c,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- ulaw.c 14 Sep 2005 20:46:49 -0000 1.6
+++ ulaw.c 24 Oct 2005 20:12:05 -0000 1.7
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * u-Law to Signed linear conversion
+ * \brief u-Law to Signed linear conversion
*
*/
Index: utils.c
===================================================================
RCS file: /usr/cvsroot/asterisk/utils.c,v
retrieving revision 1.75
retrieving revision 1.76
diff -u -d -r1.75 -r1.76
--- utils.c 21 Oct 2005 14:09:03 -0000 1.75
+++ utils.c 24 Oct 2005 20:12:05 -0000 1.76
@@ -14,10 +14,13 @@
* at the top of the source tree.
*/
-/*
+/*! \file
*
- * Utility functions
+ * \brief Utility functions
*
+ * \note These are important for portability and security,
+ * so please use them in favour of other routines.
+ * Please consult the CODING GUIDELINES for more information.
*/
#include <ctype.h>
More information about the svn-commits
mailing list