diff options
Diffstat (limited to 'include/asterisk')
62 files changed, 626 insertions, 346 deletions
diff --git a/include/asterisk/acl.h b/include/asterisk/acl.h index 5079b7dbb..ad946d57e 100755 --- a/include/asterisk/acl.h +++ b/include/asterisk/acl.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Access Control of various sorts +/*! \file + * \brief Access Control of various sorts */ #ifndef _ASTERISK_ACL_H diff --git a/include/asterisk/adsi.h b/include/asterisk/adsi.h index bc5179199..514307212 100755 --- a/include/asterisk/adsi.h +++ b/include/asterisk/adsi.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * ADSI Support (built upon Caller*ID) +/*! \file + * \brief ADSI Support (built upon Caller*ID) */ #ifndef _ASTERISK_ADSI_H diff --git a/include/asterisk/aes.h b/include/asterisk/aes.h index c77ea8f98..af648e8ee 100755 --- a/include/asterisk/aes.h +++ b/include/asterisk/aes.h @@ -39,8 +39,10 @@ and/or fitness for purpose. --------------------------------------------------------------------------- Issue Date: 26/08/2003 +*/ +/*!\file - This file contains the definitions required to use AES in C. See aesopt.h + \brief This file contains the definitions required to use AES in C. See aesopt.h for optimisation details. */ diff --git a/include/asterisk/agi.h b/include/asterisk/agi.h index 0d3fcc659..226041173 100755 --- a/include/asterisk/agi.h +++ b/include/asterisk/agi.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * AGI Extension interfaces +/*! \file + * \brief AGI Extension interfaces - Asterisk Gateway Interface */ #ifndef _ASTERISK_AGI_H diff --git a/include/asterisk/alaw.h b/include/asterisk/alaw.h index b2e0fae19..6feb07aa2 100755 --- a/include/asterisk/alaw.h +++ b/include/asterisk/alaw.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * A-Law to Signed linear conversion +/*! \file + * \brief A-Law to Signed linear conversion */ #ifndef _ASTERISK_ALAW_H diff --git a/include/asterisk/app.h b/include/asterisk/app.h index 706871f8d..36f245325 100755 --- a/include/asterisk/app.h +++ b/include/asterisk/app.h @@ -15,9 +15,9 @@ * at the top of the source tree. */ -/* - * Application convenience functions, designed to give consistent - * look and feel to Asterisk apps. +/*! \file + * \brief Application convenience functions, designed to give consistent + look and feel to Asterisk apps. */ #ifndef _ASTERISK_APP_H diff --git a/include/asterisk/astdb.h b/include/asterisk/astdb.h index c1012cda7..828fe9725 100755 --- a/include/asterisk/astdb.h +++ b/include/asterisk/astdb.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Persistant data storage (akin to *doze registry) +/*! \file + * \brief Persistant data storage (akin to *doze registry) */ #ifndef _ASTERISK_ASTDB_H diff --git a/include/asterisk/astmm.h b/include/asterisk/astmm.h index 3c86b7b9b..9e70366fa 100755 --- a/include/asterisk/astmm.h +++ b/include/asterisk/astmm.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Asterisk memory usage debugging +/*! \file + * \brief Asterisk memory usage debugging */ #ifndef NO_AST_MM diff --git a/include/asterisk/astosp.h b/include/asterisk/astosp.h index 9baf3f0b4..ee809bbc2 100755 --- a/include/asterisk/astosp.h +++ b/include/asterisk/astosp.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * OSP support +/*! \file + * \brief OSP support (Open Settlement Protocol) */ #ifndef _ASTERISK_OSP_H diff --git a/include/asterisk/callerid.h b/include/asterisk/callerid.h index ba84a54dd..ff7388381 100755 --- a/include/asterisk/callerid.h +++ b/include/asterisk/callerid.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * CallerID (and other GR30) Generation support +/*! \file + * \brief CallerID (and other GR30) Generation support * Includes code and algorithms from the Zapata library. */ diff --git a/include/asterisk/causes.h b/include/asterisk/causes.h index 7311e89cf..fc27c7970 100755 --- a/include/asterisk/causes.h +++ b/include/asterisk/causes.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Internal Asterisk hangup causes +/*! \file + * \brief Internal Asterisk hangup causes */ #ifndef _ASTERISK_CAUSES_H diff --git a/include/asterisk/cdr.h b/include/asterisk/cdr.h index 6cb75e415..78df4b9de 100755 --- a/include/asterisk/cdr.h +++ b/include/asterisk/cdr.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Call Detail Record API +/*! \file + * \brief Call Detail Record API */ #ifndef _ASTERISK_CDR_H @@ -104,26 +104,23 @@ extern int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr); typedef int (*ast_cdrbe)(struct ast_cdr *cdr); -/*! Allocate a record */ -/*! +/*! \brief Allocate a CDR record * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure) */ extern struct ast_cdr *ast_cdr_alloc(void); -/*! Duplicate a record */ -/*! +/*! \brief Duplicate a record * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure) */ extern struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr); -/*! Free a record */ -/* \param cdr ast_cdr structure to free +/*! \brief Free a CDR record + * \param cdr ast_cdr structure to free * Returns nothing important */ extern void ast_cdr_free(struct ast_cdr *cdr); -/*! Initialize based on a channel */ -/*! +/*! \brief Initialize based on a channel * \param cdr Call Detail Record to use for channel * \param chan Channel to bind CDR with * Initializes a CDR and associates it with a particular channel diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h index d0f3b98ea..00b0cce67 100755 --- a/include/asterisk/channel.h +++ b/include/asterisk/channel.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * General Asterisk channel definitions. +/*! \file + * \brief General Asterisk PBX channel definitions. */ #ifndef _ASTERISK_CHANNEL_H diff --git a/include/asterisk/chanvars.h b/include/asterisk/chanvars.h index 434874ba9..32cccf334 100755 --- a/include/asterisk/chanvars.h +++ b/include/asterisk/chanvars.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Channel Variables +/*! \file + * \brief Channel Variables */ #ifndef _ASTERISK_CHANVARS_H diff --git a/include/asterisk/cli.h b/include/asterisk/cli.h index 20a259be1..4dcdeab65 100755 --- a/include/asterisk/cli.h +++ b/include/asterisk/cli.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Standard Command Line Interface +/*! \file + * \brief Standard Command Line Interface */ #ifndef _ASTERISK_CLI_H @@ -42,7 +42,7 @@ extern void ast_cli(int fd, char *fmt, ...) #define AST_CLI_COMPLETE_EOF "_EOF_" -/*! A command line entry */ +/*! \brief A command line entry */ struct ast_cli_entry { /*! Null terminated list of the words of the command */ char *cmda[AST_MAX_CMD_LEN]; @@ -60,14 +60,13 @@ struct ast_cli_entry { int inuse; }; -/*! Interprets a command */ -/*! Interpret a command s, sending output to fd +/*! \brief Interprets a command + * Interpret a command s, sending output to fd * Returns 0 on succes, -1 on failure */ extern int ast_cli_command(int fd, char *s); -/*! Registers a command or an array of commands */ -/*! +/*! \brief Registers a command or an array of commands * \param e which cli entry to register * Register your own command * Returns 0 on success, -1 on failure @@ -75,14 +74,14 @@ extern int ast_cli_command(int fd, char *s); extern int ast_cli_register(struct ast_cli_entry *e); /*! + * \brief Register multiple commands * \param e pointer to first cli entry to register * \param len number of entries to register - * Register multiple commands */ extern void ast_cli_register_multiple(struct ast_cli_entry *e, int len); -/*! Unregisters a command or an array of commands */ -/*! +/*! \brief Unregisters a command or an array of commands + * * \param e which cli entry to unregister * Unregister your own command. You must pass a completed ast_cli_entry structure * Returns 0. @@ -90,14 +89,14 @@ extern void ast_cli_register_multiple(struct ast_cli_entry *e, int len); extern int ast_cli_unregister(struct ast_cli_entry *e); /*! + * \brief Unregister multiple commands * \param e pointer to first cli entry to unregister * \param len number of entries to unregister - * Unregister multiple commands */ extern void ast_cli_unregister_multiple(struct ast_cli_entry *e, int len); -/*! Readline madness */ -/* Useful for readline, that's about it +/*! \brief Readline madness + * Useful for readline, that's about it * Returns 0 on success, -1 on failure */ extern char *ast_cli_generator(char *, char *, int); diff --git a/include/asterisk/compat.h b/include/asterisk/compat.h index 71c18f29a..fc4791b9c 100755 --- a/include/asterisk/compat.h +++ b/include/asterisk/compat.h @@ -1,7 +1,5 @@ /* * Asterisk -- A telephony toolkit for Linux. - * - * General Definitions for Asterisk top level program * * Copyright (C) 1999-2005, Mark Spencer * @@ -11,6 +9,10 @@ * the GNU General Public License */ +/*! \file + * \brief General Definitions for Asterisk top level program + */ + #ifndef _COMPAT_H #define _COMPAT_H diff --git a/include/asterisk/compiler.h b/include/asterisk/compiler.h index 3cd622038..f436f4cb4 100755 --- a/include/asterisk/compiler.h +++ b/include/asterisk/compiler.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Compiler-specific macros and other items +/*! \file + * \brief Compiler-specific macros and other items */ #ifndef _ASTERISK_COMPILER_H diff --git a/include/asterisk/config.h b/include/asterisk/config.h index 5a6e2b22d..eff829b63 100755 --- a/include/asterisk/config.h +++ b/include/asterisk/config.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Configuration File Parser +/*! \file + * \brief Configuration File Parser */ #ifndef _ASTERISK_CONFIG_H @@ -37,8 +37,8 @@ struct ast_variable { char *name; char *value; int lineno; - int object; /* 0 for variable, 1 for object */ - int blanklines; /* Number of blanklines following entry */ + int object; /*!< 0 for variable, 1 for object */ + int blanklines; /*!< Number of blanklines following entry */ struct ast_comment *precomments; struct ast_comment *sameline; struct ast_variable *next; @@ -59,8 +59,7 @@ struct ast_config_engine { struct ast_config_engine *next; }; -/*! Load a config file */ -/*! +/*! \brief Load a config file * \param configfile path of file to open. If no preceding '/' character, path is considered relative to AST_CONFIG_DIR * Create a config structure from a given configuration file. * @@ -68,16 +67,14 @@ struct ast_config_engine { */ struct ast_config *ast_config_load(const char *filename); -/*! Destroys a config */ -/*! +/*! \brief Destroys a config * \param config pointer to config data structure * Free memory associated with a given config * */ void ast_config_destroy(struct ast_config *config); -/*! Goes through categories */ -/*! +/*! \brief Goes through categories * \param config Which config structure you wish to "browse" * \param prev A pointer to a previous category. * This funtion is kind of non-intuitive in it's use. To begin, one passes NULL as the second arguement. It will return a pointer to the string of the first category in the file. From here on after, one must then pass the previous usage's return value as the second pointer, and it will return a pointer to the category name afterwards. @@ -86,8 +83,7 @@ void ast_config_destroy(struct ast_config *config); */ char *ast_category_browse(struct ast_config *config, const char *prev); -/*! Goes through variables */ -/*! +/*! \brief Goes through variables * Somewhat similar in intent as the ast_category_browse. * List variables of config file category * @@ -95,8 +91,7 @@ char *ast_category_browse(struct ast_config *config, const char *prev); */ struct ast_variable *ast_variable_browse(const struct ast_config *config, const char *category); -/*! Gets a variable */ -/*! +/*! \brief Gets a variable * \param config which (opened) config to use * \param category category under which the variable lies * \param value which variable you wish to get the data for @@ -106,8 +101,7 @@ struct ast_variable *ast_variable_browse(const struct ast_config *config, const */ char *ast_variable_retrieve(const struct ast_config *config, const char *category, const char *variable); -/*! Retrieve a category if it exists */ -/*! +/*! \brief Retrieve a category if it exists * \param config which config to use * \param category_name name of the category you're looking for * This will search through the categories within a given config file for a match. @@ -116,8 +110,7 @@ char *ast_variable_retrieve(const struct ast_config *config, const char *categor */ struct ast_category *ast_category_get(const struct ast_config *config, const char *category_name); -/*! Check for category duplicates */ -/*! +/*! \brief Check for category duplicates * \param config which config to use * \param category_name name of the category you're looking for * This will search through the categories within a given config file for a match. @@ -126,8 +119,7 @@ struct ast_category *ast_category_get(const struct ast_config *config, const cha */ int ast_category_exist(const struct ast_config *config, const char *category_name); -/*! Retrieve realtime configuration */ -/*! +/*! \brief Retrieve realtime configuration * \param family which family/config to lookup * \param keyfield which field to use as the key * \param lookup which value to look for in the key field to match the entry. @@ -138,8 +130,7 @@ int ast_category_exist(const struct ast_config *config, const char *category_nam */ struct ast_variable *ast_load_realtime(const char *family, ...); -/*! Retrieve realtime configuration */ -/*! +/*! \brief Retrieve realtime configuration * \param family which family/config to lookup * \param keyfield which field to use as the key * \param lookup which value to look for in the key field to match the entry. @@ -151,8 +142,7 @@ struct ast_variable *ast_load_realtime(const char *family, ...); */ struct ast_config *ast_load_realtime_multientry(const char *family, ...); -/*! Update realtime configuration */ -/*! +/*! \brief Update realtime configuration * \param family which family/config to be updated * \param keyfield which field to use as the key * \param lookup which value to look for in the key field to match the entry. @@ -163,21 +153,24 @@ struct ast_config *ast_load_realtime_multientry(const char *family, ...); */ int ast_update_realtime(const char *family, const char *keyfield, const char *lookup, ...); -/*! Check if realtime engine is configured for family - returns 1 if family is configured in realtime and engine exists - \param family which family/config to be checked +/*! \brief Check if realtime engine is configured for family + * returns 1 if family is configured in realtime and engine exists + * \param family which family/config to be checked */ int ast_check_realtime(const char *family); -/*! Free variable list */ -/*! +/*! \brief Free variable list * \param var the linked list of variables to free * This function frees a list of variables. */ void ast_variables_destroy(struct ast_variable *var); +/*! \brief Register config engine */ int ast_config_engine_register(struct ast_config_engine *newconfig); + +/*! \brief Deegister config engine */ int ast_config_engine_deregister(struct ast_config_engine *del); + int register_config_cli(void); void read_config_maps(void); diff --git a/include/asterisk/crypto.h b/include/asterisk/crypto.h index 7d86da16d..2463ba4ed 100755 --- a/include/asterisk/crypto.h +++ b/include/asterisk/crypto.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Provide cryptographic signature routines +/*! \file + * \brief Provide cryptographic signature routines */ #ifndef _ASTERISK_CRYPTO_H @@ -35,8 +35,7 @@ extern "C" { struct ast_key; -/*! Retrieve a key */ -/*! +/*! \brief Retrieve a key * \param name of the key we are retrieving * \param int type of key (AST_KEY_PUBLIC or AST_KEY_PRIVATE) * @@ -44,8 +43,7 @@ struct ast_key; */ extern struct ast_key *(*ast_key_get)(const char *key, int type); -/*! Check the authenticity of a message signature using a given public key */ -/*! +/*! \brief Check the authenticity of a message signature using a given public key * \param key a public key to use to verify * \param msg the message that has been signed * \param sig the proposed valid signature in mime64-like encoding @@ -55,8 +53,7 @@ extern struct ast_key *(*ast_key_get)(const char *key, int type); */ extern int (*ast_check_signature)(struct ast_key *key, const char *msg, const char *sig); -/*! Check the authenticity of a message signature using a given public key */ -/*! +/*! \brief Check the authenticity of a message signature using a given public key * \param key a public key to use to verify * \param msg the message that has been signed * \param sig the proposed valid signature in raw binary representation @@ -76,6 +73,7 @@ extern int (*ast_check_signature_bin)(struct ast_key *key, const char *msg, int * */ extern int (*ast_sign)(struct ast_key *key, char *msg, char *sig); + /*! * \param key a private key to use to create the signature * \param msg the message to sign diff --git a/include/asterisk/devicestate.h b/include/asterisk/devicestate.h index ec8c6620b..49efcc10a 100755 --- a/include/asterisk/devicestate.h +++ b/include/asterisk/devicestate.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Device state management +/*! \file + * \brief Device state management */ #ifndef _ASTERISK_DEVICESTATE_H @@ -44,12 +44,12 @@ extern "C" { typedef int (*ast_devstate_cb_type)(const char *dev, int state, void *data); -/*! Convert device state to text string for output */ -/*! \param devstate Current device state */ +/*! \brief Convert device state to text string for output + * \param devstate Current device state + */ const char *devstate2str(int devstate); -/*! Search the Channels by Name */ -/*! +/*! \brief Search the Channels by Name * \param device like a dialstring * Search the Device in active channels by compare the channelname against * the devicename. Compared are only the first chars to the first '-' char. @@ -58,8 +58,7 @@ const char *devstate2str(int devstate); */ int ast_parse_device_state(const char *device); -/*! Asks a channel for device state */ -/*! +/*! \brief Asks a channel for device state * \param device like a dialstring * Asks a channel for device state, data is normaly a number from dialstring * used by the low level module @@ -69,8 +68,7 @@ int ast_parse_device_state(const char *device); */ int ast_device_state(const char *device); -/*! Tells Asterisk the State for Device is changed */ -/*! +/*! \brief Tells Asterisk the State for Device is changed * \param fmt devicename like a dialstring with format parameters * Asterisk polls the new extensionstates and calls the registered * callbacks for the changed extensions @@ -80,8 +78,7 @@ int ast_device_state_changed(const char *fmt, ...) __attribute__ ((format (printf, 1, 2))); -/*! Tells Asterisk the State for Device is changed */ -/*! +/*! \brief Tells Asterisk the State for Device is changed * \param device devicename like a dialstrin * Asterisk polls the new extensionstates and calls the registered * callbacks for the changed extensions @@ -89,8 +86,7 @@ int ast_device_state_changed(const char *fmt, ...) */ int ast_device_state_changed_literal(const char *device); -/*! Registers a device state change callback */ -/*! +/*! \brief Registers a device state change callback * \param data to pass to callback * The callback is called if the state for extension is changed * Return -1 on failure, ID on success diff --git a/include/asterisk/dns.h b/include/asterisk/dns.h index c1a0c3afd..18ebaf585 100755 --- a/include/asterisk/dns.h +++ b/include/asterisk/dns.h @@ -16,8 +16,9 @@ * at the top of the source tree. */ -/* - * DNS support +/*! \file + * \brief DNS support for Asterisk + * \author Thorsten Lockert <tholo@trollphone.org> */ #ifndef _ASTERISK_DNS_H diff --git a/include/asterisk/dnsmgr.h b/include/asterisk/dnsmgr.h index c5da2d9b0..b5cc2a7ed 100755 --- a/include/asterisk/dnsmgr.h +++ b/include/asterisk/dnsmgr.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Background DNS update manager +/*! \file + * \brief Background DNS update manager */ #ifndef _ASTERISK_DNSMGR_H diff --git a/include/asterisk/doxyref.h b/include/asterisk/doxyref.h new file mode 100755 index 000000000..f87a98b40 --- /dev/null +++ b/include/asterisk/doxyref.h @@ -0,0 +1,286 @@ +/* + * Asterisk -- An open source telephony toolkit. + * + * Copyright (C) 1999 - 2005, Digium, Inc. + * + * Mark Spencer <markster@digium.com> + * + * 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. + */ + +/* \file This file generates Doxygen pages from files in the /doc + directory of the Asterisk source code tree + */ + +/* The following is for Doxygen Developer's documentation generated + * by running "make progdocs" with doxygen installed on your + * system. + */ +/*! \page DevDoc Asterisk Developer's Documentation - appendices + * \arg \ref CodeGuide + * \arg \ref AstAPI + * \arg \ref AstDebug + * \arg \ref AstAMI + * \arg \ref AstARA + * \arg \ref AstDUNDi + * \arg \ref AstCDR + * \arg \ref AstREADME + * \arg \ref AstCREDITS + * \arg \ref AstVar + * \arg \ref AstENUM + * \arg \ref ConfigFiles + */ + +/*! \page CodeGuide Coding Guidelines + * \section Coding Guidelines + * This file is in the /doc directory in your Asterisk source tree. + * Make sure to stay up to date with the latest guidelines. + * \verbinclude CODING-GUIDELINES + */ +/*! \page AstAPI Asterisk API + * \section Asteriskapi Asterisk API + * This programmer's documentation covers the generic API. + * \subsection generic Generic Model + * \verbinclude model.txt + * \subsection channel Channels + * \verbinclude channel.txt + */ +/*! \page AstDebug Debugging + * \section debug Debugging + * \verbinclude README.backtrace + */ +/*! \page AstAMI AMI - The Manager Interface + * \section ami AMI - The manager Interface + * \arg \link Config_ami Configuration file \endlink + * \verbinclude manager.txt + */ +/*! \page AstARA ARA - The Asterisk Realtime Interface + * \section realtime ARA - a generic API to storage and retrieval + * Implemented in \ref config.c + * Implemented in \ref pbx_realtime.c + * \verbinclude README.realtime + * \verbinclude README.extconfig + */ +/*! \page AstDUNDi DUNDi +DUNDi is a peer-to-peer system for locating Internet gateways to telephony services. Unlike traditional centralized services (such as the remarkably simple and concise ENUM standard), DUNDi is fully-distributed with no centralized authority whatsoever. + +DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it publishes routes which are in turn accessed via industry standard protocols such as IAX, SIP and H.323. + + \arg Dundi is documented at http://www.dundi.com + \arg Implemented in \ref pbx_dundi.c and \ref dundi-parser.c + \arg Configuration in \link Config_dun dundi.conf \endlink + */ + +/*! \page AstCDR CDR - Call Data Records and billing + * \section cdr Call Data Records + * \verbinclude README.cdr + * \arg \ref Config_cdr CDR configuration files + */ +/*! \page AstREADME README - the general administrator introduction + * \verbinclude README + */ + +/*! \page AstCREDITS CREDITS + * \verbinclude CREDITS + */ + +/*! \page AstVar Global channel variables + * \section globchan Global Channel Variables + * \verbinclude README.variables + */ + +/*! \page AstENUM ENUM + * \section enumreadme ENUM + * \arg Configuration: \ref Config_enum + * \verbinclude README.enum + */ + +/*! \page ConfigFiles Configuration files + * \section config Main configuration files + * \arg \link Config_ast asterisk.conf - the main configuration file \endlink + * \arg \link Config_ext extensions.conf - The Dial Plan \endlink + * \arg \link Config_mod modules.conf - which modules to load and not to load \endlink + * \arg \link Config_fea features.conf - call features (transfer, parking, etc) \endlink + * \section chanconf Channel configurations + * \arg \link Config_iax IAX2 configuration \endlink + * \arg \link Config_sip SIP configuration \endlink + * \arg \link Config_mgcp MGCP configuration \endlink + * \arg \link Config_rtp RTP configuration \endlink + * \arg \link Config_zap Zaptel configuration \endlink + * \arg \link Config_oss OSS (sound card) configuration \endlink + * \arg \link Config_alsa ALSA (sound card) configuration \endlink + * \arg \link Config_agent Agent (proxy channel) configuration \endlink + * \section appconf Application configuration files + * \arg \link Config_mm Meetme (conference bridge) configuration \endlink + * \arg \link Config_qu Queue system configuration \endlink + * \arg \link Config_vm Voicemail configuration \endlink + * \section miscconf Miscellenaous configuration files + * \arg \link Config_adsi Adsi configuration \endlink + * \arg \link Config_ami AMI - Manager configuration \endlink + * \arg \link Config_ara Realtime configuration \endlink + * \arg \link Config_codec Codec configuration \endlink + * \arg \link Config_dun Dundi configuration \endlink + * \arg \link Config_enum ENUM configuration \endlink + * \arg \link Config_moh Music on Hold configuration \endlink + * \arg \link Config_vm Voicemail configuration \endlink + */ + +/*! \page Config_ast Asterisk.conf + * \verbinclude README.asterisk.conf + */ +/*! \page Config_mod Modules configuration + * \verbinclude modules.conf.sample + */ + +/*! \page Config_fea Call features configuration + * \section featconf features.conf + * \verbinclude features.conf.sample + */ + +/*! \page Config_ext Extensions.conf - the Dial Plan + * \section dialplan Extensions.conf + * \verbinclude extensions.conf.sample + */ + +/*! \page Config_iax IAX2 configuration + * IAX2 is implemented in \ref chan_iax2.c . + * \arg \link iaxreadme README file \endlink + * \arg \link iaxconfig iax.conf Configuration file example \endlink + * \section iaxreadme IAX readme file + * \verbinclude README.iax + * \section iaxconfig IAX Configuration example + * \verbinclude iax.conf.sample + * \section iaxjitter IAX Jitterbuffer information + * \verbinclude README.jitterbuffer + */ + +/*! \page Config_sip SIP configuration + * Also see \ref Config_rtp RTP configuration + * \ref chan_sip.c + * \section sipconf sip.conf + * \verbinclude sip.conf.sample + */ + +/*! \page Config_mgcp MGCP configuration + * Also see \ref Config_rtp RTP configuration + * \ref chan_mgcp.c + * \section mgcpconf mgcp.conf + * \verbinclude mgcp.conf.sample + */ + + +/*! \page Config_vm VoiceMail configuration + * \section vmconf voicemail.conf + * \ref app_voicemail.c + * \verbinclude voicemail.conf.sample + */ + +/*! \page Config_zap Zaptel configuration + * \section zapconf zapata.conf + * \ref chan_zap.c + * \verbinclude zapata.conf.sample + */ + +/*! \page Config_oss OSS configuration + * \section ossconf oss.conf + * \ref chan_oss.c + * \verbinclude oss.conf.sample + */ + +/*! \page Config_alsa ALSA configuration + * \section alsaconf alsa.conf + * \ref chan_alsa.c + * \verbinclude alsa.conf.sample + */ + +/*! \page Config_agent Agent configuration + * \section agentconf agents.conf + * The agent channel is a proxy channel for queues + * \ref chan_agent.c + * \verbinclude agents.conf.sample + */ + +/*! \page Config_rtp RTP configuration + * \ref rtp.c + * \section rtpconf rtp.conf + * \verbinclude rtp.conf.sample + */ +/*! \page Config_dun Dundi Configuration + * \arg See also \ref AstDundi + * \section dundiconf dundi.conf + * \verbinclude dundi.conf.sample + */ +/*! \page Config_enum ENUM Configuration + * \arg See also \ref enumreadme + * \section enumconf enum.conf + * \verbinclude enum.conf.sample + */ +/*! \page Config_cdr CDR configuration + * \arg \link cdrconf Main CDR Configuration \endlink + * \arg \link cdrcustom Custom CDR driver configuration \endlink + * \arg \link cdrami Manager CDR driver configuration \endlink + * \arg \link cdrodbc ODBC CDR driver configuration \endlink + * \arg \link cdrpgsql Postgres CDR driver configuration \endlink + * \arg \link cdrtds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink + * \section cdrconf Main CDR configuration + * \verbinclude cdr.conf.sample + * \section cdrcustom Custom CDR driver configuration + * \verbinclude cdr_custom.conf.sample + * \section cdrami Manager CDR driver configuration + * \verbinclude cdr_manager.conf.sample + * \section cdrodbc ODBC CDR driver configuration + * Based on http://www.unixodbc.org + * \verbinclude cdr_odbc.conf.sample + * \section cdrpgsql Postgres CDR driver configuration + * \verbinclude cdr_pgsql.conf.sample + * \verbinclude cdr_tds.conf.sample + * \section cdrtds FreeTDS CDR driver configuration + * \verbinclude cdr_tds.conf.sample + */ + +/*! \page Config_moh Music on Hold Configuration + * \arg Implemented in \ref res_musiconhold.c + * \section mohconf musiconhold.conf + * \verbinclude musiconhold.conf.sample + */ + +/*! \page Config_adsi ADSI Configuration + * \section adsiconf adsi.conf + * \verbinclude adsi.conf.sample + */ + +/*! \page Config_codec CODEC Configuration + * \section codecsconf codecs.conf + * \verbinclude codecs.conf.sample + */ + +/*! \page Config_ara REALTIME Configuration + * \arg See also: \AstARA + * \section extconf extconfig.conf + * \verbinclude extconfig.conf.sample + */ + +/*! \page Config_ami AMI configuration + * \arg See also: \AstAMI + * \section amiconf manager.conf + * \verbinclude manager.conf.sample + */ + +/*! \page Config_qu ACD - Queue system configuration + * \section quconf queues.conf + * \verbinclude queues.conf.sample + */ + +/*! \page Config_mm Meetme - The conference bridge configuration + * \section mmconf meetme.conf + * \verbinclude meetme.conf.sample + */ + diff --git a/include/asterisk/dsp.h b/include/asterisk/dsp.h index c189f9d03..b34701f30 100755 --- a/include/asterisk/dsp.h +++ b/include/asterisk/dsp.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Convenient Signal Processing routines +/*! \file + * \brief Convenient Signal Processing routines */ #ifndef _ASTERISK_DSP_H @@ -56,55 +56,56 @@ struct ast_dsp; struct ast_dsp *ast_dsp_new(void); void ast_dsp_free(struct ast_dsp *dsp); -/* Set threshold value for silence */ + +/*! \brief Set threshold value for silence */ void ast_dsp_set_threshold(struct ast_dsp *dsp, int threshold); -/* Set number of required cadences for busy */ +/*! \brief Set number of required cadences for busy */ void ast_dsp_set_busy_count(struct ast_dsp *dsp, int cadences); -/* Set expected lengths of the busy tone */ +/*! \brief Set expected lengths of the busy tone */ void ast_dsp_set_busy_pattern(struct ast_dsp *dsp, int tonelength, int quietlength); -/* Scans for progress indication in audio */ +/*! \brief Scans for progress indication in audio */ int ast_dsp_call_progress(struct ast_dsp *dsp, struct ast_frame *inf); -/* Set zone for doing progress detection */ +/*! \brief Set zone for doing progress detection */ int ast_dsp_set_call_progress_zone(struct ast_dsp *dsp, char *zone); -/* Return AST_FRAME_NULL frames when there is silence, AST_FRAME_BUSY on +/*! \brief Return AST_FRAME_NULL frames when there is silence, AST_FRAME_BUSY on busies, and call progress, all dependent upon which features are enabled */ struct ast_frame *ast_dsp_process(struct ast_channel *chan, struct ast_dsp *dsp, struct ast_frame *inf); -/* Return non-zero if this is silence. Updates "totalsilence" with the total +/*! \brief Return non-zero if this is silence. Updates "totalsilence" with the total number of seconds of silence */ int ast_dsp_silence(struct ast_dsp *dsp, struct ast_frame *f, int *totalsilence); -/* Return non-zero if historically this should be a busy, request that +/*! \brief Return non-zero if historically this should be a busy, request that ast_dsp_silence has already been called */ int ast_dsp_busydetect(struct ast_dsp *dsp); -/* Return non-zero if DTMF hit was found */ +/*! \brief Return non-zero if DTMF hit was found */ int ast_dsp_digitdetect(struct ast_dsp *dsp, struct ast_frame *f); -/* Reset total silence count */ +/*! \brief Reset total silence count */ void ast_dsp_reset(struct ast_dsp *dsp); -/* Reset DTMF detector */ +/*! \brief Reset DTMF detector */ void ast_dsp_digitreset(struct ast_dsp *dsp); -/* Select feature set */ +/*! \brief Select feature set */ void ast_dsp_set_features(struct ast_dsp *dsp, int features); -/* Get pending DTMF/MF digits */ +/*! \brief Get pending DTMF/MF digits */ int ast_dsp_getdigits(struct ast_dsp *dsp, char *buf, int max); -/* Set digit mode */ +/*! \brief Set digit mode */ int ast_dsp_digitmode(struct ast_dsp *dsp, int digitmode); -/* Get tstate (Tone State) */ +/*! \brief Get tstate (Tone State) */ int ast_dsp_get_tstate(struct ast_dsp *dsp); -/* Get tcount (Threshold counter) */ +/*! \brief Get tcount (Threshold counter) */ int ast_dsp_get_tcount(struct ast_dsp *dsp); #endif /* _ASTERISK_DSP_H */ diff --git a/include/asterisk/dundi.h b/include/asterisk/dundi.h index ef6b89fce..9290536d6 100755 --- a/include/asterisk/dundi.h +++ b/include/asterisk/dundi.h @@ -16,8 +16,9 @@ * at the top of the source tree. */ -/* - * Distributed Universal Number Discovery (DUNDi) +/*! \file + * \brief Distributed Universal Number Discovery (DUNDi) + * See also \ref AstDUNDi */ #ifndef _ASTERISK_DUNDI_H @@ -27,7 +28,7 @@ #define DUNDI_PORT 4520 -/* A DUNDi Entity ID is essentially a MAC address, brief and unique */ +/*!\brief A DUNDi Entity ID is essentially a MAC address, brief and unique */ struct _dundi_eid { unsigned char eid[6]; } __attribute__ ((__packed__)); @@ -35,12 +36,12 @@ struct _dundi_eid { typedef struct _dundi_eid dundi_eid; struct dundi_hdr { - unsigned short strans; /* Source transaction */ - unsigned short dtrans; /* Destination transaction */ - unsigned char iseqno; /* Next expected incoming sequence number */ - unsigned char oseqno; /* Outgoing sequence number */ - unsigned char cmdresp; /* Command / Response */ - unsigned char cmdflags; /* Command / Response specific flags*/ + unsigned short strans; /*!< Source transaction */ + unsigned short dtrans; /*!< Destination transaction */ + unsigned char iseqno; /*!< Next expected incoming sequence number */ + unsigned char oseqno; /*!< Outgoing sequence number */ + unsigned char cmdresp; /*!< Command / Response */ + unsigned char cmdflags; /*!< Command / Response specific flags*/ unsigned char ies[0]; } __attribute__ ((__packed__)); @@ -50,60 +51,60 @@ struct dundi_ie_hdr { unsigned char iedata[0]; } __attribute__ ((__packed__)); -#define DUNDI_FLAG_RETRANS (1 << 16) /* Applies to dtrans */ -#define DUNDI_FLAG_RESERVED (1 << 16) /* Applies to strans */ - -#define DUNDI_PROTO_NONE 0 /* No answer yet */ -#define DUNDI_PROTO_IAX 1 /* IAX version 2 */ -#define DUNDI_PROTO_SIP 2 /* Session Initiation Protocol */ -#define DUNDI_PROTO_H323 3 /* ITU H.323 */ - -#define DUNDI_FLAG_NONEXISTENT (0) /* Isn't and can't be a valid number */ -#define DUNDI_FLAG_EXISTS (1 << 0) /* Is a valid number */ -#define DUNDI_FLAG_MATCHMORE (1 << 1) /* Might be valid if you add more digits */ -#define DUNDI_FLAG_CANMATCH (1 << 2) /* Might be a match */ -#define DUNDI_FLAG_IGNOREPAT (1 << 3) /* Keep dialtone */ -#define DUNDI_FLAG_RESIDENTIAL (1 << 4) /* Destination known to be residential */ -#define DUNDI_FLAG_COMMERCIAL (1 << 5) /* Destination known to be commercial */ -#define DUNDI_FLAG_MOBILE (1 << 6) /* Destination known to be cellular/mobile */ -#define DUNDI_FLAG_NOUNSOLICITED (1 << 7) /* No unsolicited calls of any kind through this route */ -#define DUNDI_FLAG_NOCOMUNSOLICIT (1 << 8) /* No commercial unsolicited calls through this route */ - -#define DUNDI_HINT_NONE (0) -#define DUNDI_HINT_TTL_EXPIRED (1 << 0) /* TTL Expired */ -#define DUNDI_HINT_DONT_ASK (1 << 1) /* Don't ask for anything beginning with data */ -#define DUNDI_HINT_UNAFFECTED (1 << 2) /* Answer not affected by entity list */ - -struct dundi_encblock { /* AES-128 encrypted block */ - unsigned char iv[16]; /* Initialization vector of random data */ - unsigned char encdata[0]; /* Encrypted / compressed data */ +#define DUNDI_FLAG_RETRANS (1 << 16) /*!< Applies to dtrans */ +#define DUNDI_FLAG_RESERVED (1 << 16) /*!< Applies to strans */ + +#define DUNDI_PROTO_NONE 0 /*!< No answer yet */ +#define DUNDI_PROTO_IAX 1 /*!< IAX version 2 */ +#define DUNDI_PROTO_SIP 2 /*!< Session Initiation Protocol */ +#define DUNDI_PROTO_H323 3 /*!< ITU H.323 */ + +#define DUNDI_FLAG_NONEXISTENT (0) /*!< Isn't and can't be a valid number */ +#define DUNDI_FLAG_EXISTS (1 << 0) /*!< Is a valid number */ +#define DUNDI_FLAG_MATCHMORE (1 << 1) /*!< Might be valid if you add more digits */ +#define DUNDI_FLAG_CANMATCH (1 << 2) /*!< Might be a match */ +#define DUNDI_FLAG_IGNOREPAT (1 << 3) /*!< Keep dialtone */ +#define DUNDI_FLAG_RESIDENTIAL (1 << 4) /*!< Destination known to be residential */ +#define DUNDI_FLAG_COMMERCIAL (1 << 5) /*!< Destination known to be commercial */ +#define DUNDI_FLAG_MOBILE (1 << 6) /*!< Destination known to be cellular/mobile */ +#define DUNDI_FLAG_NOUNSOLICITED (1 << 7) /*!< No unsolicited calls of any kind through this route */ +#define DUNDI_FLAG_NOCOMUNSOLICIT (1 << 8) /*!< No commercial unsolicited calls through this route */ + +#define DUNDI_HINT_NONE (0) +#define DUNDI_HINT_TTL_EXPIRED (1 << 0) /*!< TTL Expired */ +#define DUNDI_HINT_DONT_ASK (1 << 1) /*!< Don't ask for anything beginning with data */ +#define DUNDI_HINT_UNAFFECTED (1 << 2) /*!< Answer not affected by entity list */ + +struct dundi_encblock { /*!< AES-128 encrypted block */ + unsigned char iv[16]; /*!< Initialization vector of random data */ + unsigned char encdata[0]; /*!< Encrypted / compressed data */ } __attribute__ ((__packed__)); struct dundi_answer { - dundi_eid eid; /* Original source of answer */ - unsigned char protocol; /* Protocol (DUNDI_PROTO_*) */ - unsigned short flags; /* Flags relating to answer */ - unsigned short weight; /* Weight of answers */ - unsigned char data[0]; /* Protocol specific URI */ + dundi_eid eid; /*!< Original source of answer */ + unsigned char protocol; /*!< Protocol (DUNDI_PROTO_*) */ + unsigned short flags; /*!< Flags relating to answer */ + unsigned short weight; /*!< Weight of answers */ + unsigned char data[0]; /*!< Protocol specific URI */ } __attribute__ ((__packed__)); struct dundi_hint { - unsigned short flags; /* Flags relating to answer */ - unsigned char data[0]; /* For data for hint */ + unsigned short flags; /*!< Flags relating to answer */ + unsigned char data[0]; /*!< For data for hint */ } __attribute__ ((__packed__)); -#define DUNDI_CAUSE_SUCCESS 0 /* Success */ -#define DUNDI_CAUSE_GENERAL 1 /* General unspecified failure */ -#define DUNDI_CAUSE_DYNAMIC 2 /* Requested entity is dynamic */ -#define DUNDI_CAUSE_NOAUTH 3 /* No or improper authorization */ -#define DUNDI_CAUSE_DUPLICATE 4 /* Duplicate request */ -#define DUNDI_CAUSE_TTL_EXPIRED 5 /* Expired TTL */ -#define DUNDI_CAUSE_NEEDKEY 6 /* Need new session key to decode */ -#define DUNDI_CAUSE_BADENCRYPT 7 /* Badly encrypted data */ +#define DUNDI_CAUSE_SUCCESS 0 /*!< Success */ +#define DUNDI_CAUSE_GENERAL 1 /*!< General unspecified failure */ +#define DUNDI_CAUSE_DYNAMIC 2 /*!< Requested entity is dynamic */ +#define DUNDI_CAUSE_NOAUTH 3 /*!< No or improper authorization */ +#define DUNDI_CAUSE_DUPLICATE 4 /*!< Duplicate request */ +#define DUNDI_CAUSE_TTL_EXPIRED 5 /*!< Expired TTL */ +#define DUNDI_CAUSE_NEEDKEY 6 /*!< Need new session key to decode */ +#define DUNDI_CAUSE_BADENCRYPT 7 /*!< Badly encrypted data */ struct dundi_cause { - unsigned char causecode; /* Numerical cause (DUNDI_CAUSE_*) */ - char desc[0]; /* Textual description */ + unsigned char causecode; /*!< Numerical cause (DUNDI_CAUSE_*) */ + char desc[0]; /*!< Textual description */ } __attribute__ ((__packed__)); struct dundi_peer_status { @@ -113,7 +114,7 @@ struct dundi_peer_status { dundi_eid peereid; } __attribute__ ((__packed__)); -#define DUNDI_PEER_PRIMARY (1 << 0) +#define DUNDI_PEER_PRIMARY (1 << 0) #define DUNDI_PEER_SECONDARY (1 << 1) #define DUNDI_PEER_UNAVAILABLE (1 << 2) #define DUNDI_PEER_REGISTERED (1 << 3) @@ -122,73 +123,73 @@ struct dundi_peer_status { #define DUNDI_PEER_PCMOD_OUTBOUND (1 << 6) #define DUNDI_PEER_PCMOD_INBOUND (1 << 7) -#define DUNDI_COMMAND_FINAL (0x80) /* Or'd with other flags */ - -#define DUNDI_COMMAND_ACK (0 | 0x40) /* Ack a message */ -#define DUNDI_COMMAND_DPDISCOVER 1 /* Request discovery */ -#define DUNDI_COMMAND_DPRESPONSE (2 | 0x40) /* Respond to a discovery request */ -#define DUNDI_COMMAND_EIDQUERY 3 /* Request information for a peer */ -#define DUNDI_COMMAND_EIDRESPONSE (4 | 0x40) /* Response to a peer query */ -#define DUNDI_COMMAND_PRECACHERQ 5 /* Pre-cache Request */ -#define DUNDI_COMMAND_PRECACHERP (6 | 0x40) /* Pre-cache Response */ -#define DUNDI_COMMAND_INVALID (7 | 0x40) /* Invalid dialog state (does not require ack) */ -#define DUNDI_COMMAND_UNKNOWN (8 | 0x40) /* Unknown command */ -#define DUNDI_COMMAND_NULL 9 /* No-op */ -#define DUNDI_COMMAND_REGREQ (10) /* Register Request */ -#define DUNDI_COMMAND_REGRESPONSE (11 | 0x40) /* Register Response */ -#define DUNDI_COMMAND_CANCEL (12) /* Cancel transaction entirely */ -#define DUNDI_COMMAND_ENCRYPT (13) /* Send an encrypted message */ -#define DUNDI_COMMAND_ENCREJ (14 | 0x40) /* Reject an encrypted message */ - -#define DUNDI_COMMAND_STATUS 15 /* Status command */ +#define DUNDI_COMMAND_FINAL (0x80) /*!< Or'd with other flags */ + +#define DUNDI_COMMAND_ACK (0 | 0x40) /*!< Ack a message */ +#define DUNDI_COMMAND_DPDISCOVER 1 /*!< Request discovery */ +#define DUNDI_COMMAND_DPRESPONSE (2 | 0x40) /*!< Respond to a discovery request */ +#define DUNDI_COMMAND_EIDQUERY 3 /*!< Request information for a peer */ +#define DUNDI_COMMAND_EIDRESPONSE (4 | 0x40) /*!< Response to a peer query */ +#define DUNDI_COMMAND_PRECACHERQ 5 /*!< Pre-cache Request */ +#define DUNDI_COMMAND_PRECACHERP (6 | 0x40) /*!< Pre-cache Response */ +#define DUNDI_COMMAND_INVALID (7 | 0x40) /*!< Invalid dialog state (does not require ack) */ +#define DUNDI_COMMAND_UNKNOWN (8 | 0x40) /*!< Unknown command */ +#define DUNDI_COMMAND_NULL 9 /*!< No-op */ +#define DUNDI_COMMAND_REGREQ (10) /*!< Register Request */ +#define DUNDI_COMMAND_REGRESPONSE (11 | 0x40) /*!< Register Response */ +#define DUNDI_COMMAND_CANCEL (12) /*!< Cancel transaction entirely */ +#define DUNDI_COMMAND_ENCRYPT (13) /*!< Send an encrypted message */ +#define DUNDI_COMMAND_ENCREJ (14 | 0x40) /*!< Reject an encrypted message */ + +#define DUNDI_COMMAND_STATUS 15 /*!< Status command */ /* * Remember that some information elements may occur * more than one time within a message */ -#define DUNDI_IE_EID 1 /* Entity identifier (dundi_eid) */ -#define DUNDI_IE_CALLED_CONTEXT 2 /* DUNDi Context (string) */ -#define DUNDI_IE_CALLED_NUMBER 3 /* Number of equivalent (string) */ -#define DUNDI_IE_EID_DIRECT 4 /* Entity identifier (dundi_eid), direct connect */ -#define DUNDI_IE_ANSWER 5 /* An answer (struct dundi_answer) */ -#define DUNDI_IE_TTL 6 /* Max TTL for this request / Remaining TTL for the response (short)*/ -#define DUNDI_IE_VERSION 10 /* DUNDi version (should be 1) (short) */ -#define DUNDI_IE_EXPIRATION 11 /* Recommended expiration (short) */ -#define DUNDI_IE_UNKNOWN 12 /* Unknown command (byte) */ -#define DUNDI_IE_CAUSE 14 /* Success or cause of failure */ -#define DUNDI_IE_REQEID 15 /* EID being requested for EIDQUERY*/ -#define DUNDI_IE_ENCDATA 16 /* AES-128 encrypted data */ -#define DUNDI_IE_SHAREDKEY 17 /* RSA encrypted AES-128 key */ -#define DUNDI_IE_SIGNATURE 18 /* RSA Signature of encrypted shared key */ -#define DUNDI_IE_KEYCRC32 19 /* CRC32 of encrypted key (int) */ -#define DUNDI_IE_HINT 20 /* Answer hints (struct ast_hint) */ - -#define DUNDI_IE_DEPARTMENT 21 /* Department, for EIDQUERY (string) */ -#define DUNDI_IE_ORGANIZATION 22 /* Organization, for EIDQUERY (string) */ -#define DUNDI_IE_LOCALITY 23 /* City/Locality, for EIDQUERY (string) */ -#define DUNDI_IE_STATE_PROV 24 /* State/Province, for EIDQUERY (string) */ -#define DUNDI_IE_COUNTRY 25 /* Country, for EIDQUERY (string) */ -#define DUNDI_IE_EMAIL 26 /* E-mail addy, for EIDQUERY (string) */ -#define DUNDI_IE_PHONE 27 /* Contact Phone, for EIDQUERY (string) */ -#define DUNDI_IE_IPADDR 28 /* IP Address, for EIDQUERY (string) */ -#define DUNDI_IE_CACHEBYPASS 29 /* Bypass cache (empty) */ - -#define DUNDI_IE_PEERSTATUS 30 /* Peer/peer status (struct dundi_peer_status) */ - -#define DUNDI_FLUFF_TIME 2000 /* Amount of time for answer */ -#define DUNDI_TTL_TIME 200 /* Incremental average time */ +#define DUNDI_IE_EID 1 /*!< Entity identifier (dundi_eid) */ +#define DUNDI_IE_CALLED_CONTEXT 2 /*!< DUNDi Context (string) */ +#define DUNDI_IE_CALLED_NUMBER 3 /*!< Number of equivalent (string) */ +#define DUNDI_IE_EID_DIRECT 4 /*!< Entity identifier (dundi_eid), direct connect */ +#define DUNDI_IE_ANSWER 5 /*!< An answer (struct dundi_answer) */ +#define DUNDI_IE_TTL 6 /*!< Max TTL for this request / Remaining TTL for the response (short)*/ +#define DUNDI_IE_VERSION 10 /*!< DUNDi version (should be 1) (short) */ +#define DUNDI_IE_EXPIRATION 11 /*!< Recommended expiration (short) */ +#define DUNDI_IE_UNKNOWN 12 /*!< Unknown command (byte) */ +#define DUNDI_IE_CAUSE 14 /*!< Success or cause of failure */ +#define DUNDI_IE_REQEID 15 /*!< EID being requested for EIDQUERY*/ +#define DUNDI_IE_ENCDATA 16 /*!< AES-128 encrypted data */ +#define DUNDI_IE_SHAREDKEY 17 /*!< RSA encrypted AES-128 key */ +#define DUNDI_IE_SIGNATURE 18 /*!< RSA Signature of encrypted shared key */ +#define DUNDI_IE_KEYCRC32 19 /*!< CRC32 of encrypted key (int) */ +#define DUNDI_IE_HINT 20 /*!< Answer hints (struct ast_hint) */ + +#define DUNDI_IE_DEPARTMENT 21 /*!< Department, for EIDQUERY (string) */ +#define DUNDI_IE_ORGANIZATION 22 /*!< Organization, for EIDQUERY (string) */ +#define DUNDI_IE_LOCALITY 23 /*!< City/Locality, for EIDQUERY (string) */ +#define DUNDI_IE_STATE_PROV 24 /*!< State/Province, for EIDQUERY (string) */ +#define DUNDI_IE_COUNTRY 25 /*!< Country, for EIDQUERY (string) */ +#define DUNDI_IE_EMAIL 26 /*!< E-mail addy, for EIDQUERY (string) */ +#define DUNDI_IE_PHONE 27 /*!< Contact Phone, for EIDQUERY (string) */ +#define DUNDI_IE_IPADDR 28 /*!< IP Address, for EIDQUERY (string) */ +#define DUNDI_IE_CACHEBYPASS 29 /*!< Bypass cache (empty) */ + +#define DUNDI_IE_PEERSTATUS 30 /*!< Peer/peer status (struct dundi_peer_status) */ + +#define DUNDI_FLUFF_TIME 2000 /*!< Amount of time for answer */ +#define DUNDI_TTL_TIME 200 /*!< Incremental average time */ #define DUNDI_DEFAULT_RETRANS 5 #define DUNDI_DEFAULT_RETRANS_TIMER 1000 -#define DUNDI_DEFAULT_TTL 120 /* In seconds/hops like TTL */ +#define DUNDI_DEFAULT_TTL 120 /*!< In seconds/hops like TTL */ #define DUNDI_DEFAULT_VERSION 1 -#define DUNDI_DEFAULT_CACHE_TIME 3600 /* In seconds */ -#define DUNDI_DEFAULT_KEY_EXPIRE 3600 /* Life of shared key In seconds */ -#define DUNDI_DEF_EMPTY_CACHE_TIME 60 /* In seconds, cache of empty answer */ -#define DUNDI_WINDOW 1 /* Max 1 message in window */ +#define DUNDI_DEFAULT_CACHE_TIME 3600 /*!< In seconds */ +#define DUNDI_DEFAULT_KEY_EXPIRE 3600 /*!< Life of shared key In seconds */ +#define DUNDI_DEF_EMPTY_CACHE_TIME 60 /*!< In seconds, cache of empty answer */ +#define DUNDI_WINDOW 1 /*!< Max 1 message in window */ -#define DEFAULT_MAXMS 2000 +#define DEFAULT_MAXMS 2000 struct dundi_result { unsigned int flags; @@ -212,14 +213,14 @@ struct dundi_entity_info { char ipaddr[80]; }; -/* Lookup the given number in the given dundi context (or e164 if unspecified) using the given callerid (if specified) and return up to maxret results in the array specified. +/*! \brief Lookup the given number in the given dundi context (or e164 if unspecified) using the given callerid (if specified) and return up to maxret results in the array specified. returns the number of results found or -1 on a hangup of teh channel. */ int dundi_lookup(struct dundi_result *result, int maxret, struct ast_channel *chan, const char *dcontext, const char *number, int nocache); -/* Retrieve information on a specific EID */ +/*! \brief Retrieve information on a specific EID */ int dundi_query_eid(struct dundi_entity_info *dei, const char *dcontext, dundi_eid eid); -/* Pre-cache to push upstream peers */ +/*! \brief Pre-cache to push upstream peers */ int dundi_precache(const char *dcontext, const char *number); #endif /* _ASTERISK_DUNDI_H */ diff --git a/include/asterisk/endian.h b/include/asterisk/endian.h index 0dfa4b2a9..55108b4e1 100755 --- a/include/asterisk/endian.h +++ b/include/asterisk/endian.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Asterisk architecture endianess compatibility definitions +/*! \file + * \brief Asterisk architecture endianess compatibility definitions */ #ifndef _ASTERISK_ENDIAN_H diff --git a/include/asterisk/enum.h b/include/asterisk/enum.h index 732a42a85..3547ef0a4 100755 --- a/include/asterisk/enum.h +++ b/include/asterisk/enum.h @@ -16,10 +16,6 @@ * at the top of the source tree. */ -/* - * ENUM support - */ - /*! \file enum.h \brief DNS and ENUM functions */ @@ -45,6 +41,7 @@ */ extern int ast_get_enum(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech, char* suffix, char* options); + /*! \brief Lookup DNS TXT record (used by app TXTCIDnum \param chan Channel \param number E164 number with or without the leading + diff --git a/include/asterisk/features.h b/include/asterisk/features.h index 4fa3e6daa..ffea39d2a 100755 --- a/include/asterisk/features.h +++ b/include/asterisk/features.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Call Parking and Pickup API +/*! \file + * \brief Call Parking and Pickup API * Includes code and algorithms from the Zapata library. */ @@ -30,7 +30,7 @@ #define FEATURE_SNAME_LEN 32 #define FEATURE_EXTEN_LEN 32 -/* main call feature structure */ +/*! \brief main call feature structure */ struct ast_call_feature { int feature_mask; char *fname; @@ -46,8 +46,8 @@ struct ast_call_feature { -/*! Park a call and read back parked location */ -/*! \param chan the channel to actually be parked +/*! \brief Park a call and read back parked location + * \param chan the channel to actually be parked \param host the channel which will have the parked location read to Park the channel chan, and read back the parked location to the host. If the call is not picked up within a specified period of @@ -57,8 +57,9 @@ struct ast_call_feature { \param extout is a parameter to an int that will hold the parked location, or NULL if you want */ extern int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout); -/*! Park a call via a masqueraded channel */ -/*! \param rchan the real channel to be parked + +/*! \brief Park a call via a masqueraded channel + * \param rchan the real channel to be parked \param host the channel to have the parking read to Masquerade the channel rchan into a new, empty channel which is then parked with ast_park_call @@ -67,25 +68,27 @@ extern int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int */ extern int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout); -/*! Determine system parking extension */ -/*! Returns the call parking extension for drivers that provide special +/*! \brief Determine system parking extension + * Returns the call parking extension for drivers that provide special call parking help */ extern char *ast_parking_ext(void); -extern char *ast_pickup_ext(void); -/*! Bridge a call, optionally allowing redirection */ +/*! \brief Determine system call pickup extension */ +extern char *ast_pickup_ext(void); +/*! \brief Bridge a call, optionally allowing redirection */ extern int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config); +/*! \brief Pickup a call */ extern int ast_pickup_call(struct ast_channel *chan); -/*! register new feature into feature_set +/*! \brief register new feature into feature_set \param feature an ast_call_feature object which contains a keysequence and a callback function which is called when this keysequence is pressed during a call. */ extern void ast_register_feature(struct ast_call_feature *feature); -/*! unregister feature from feature_set +/*! \brief unregister feature from feature_set \param feature the ast_call_feature object which was registered before*/ extern void ast_unregister_feature(struct ast_call_feature *feature); diff --git a/include/asterisk/file.h b/include/asterisk/file.h index 7dc2f9ec5..c25837384 100755 --- a/include/asterisk/file.h +++ b/include/asterisk/file.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Generic File Format Support. +/*! \file + * \brief Generic File Format Support. */ #ifndef _ASTERISK_FILE_H diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h index 47ec5a984..a4db87aba 100755 --- a/include/asterisk/frame.h +++ b/include/asterisk/frame.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Asterisk internal frame definitions. +/*! \file + * \brief Asterisk internal frame definitions. */ #ifndef _ASTERISK_FRAME_H diff --git a/include/asterisk/fskmodem.h b/include/asterisk/fskmodem.h index 5f919c0f4..62b584ba4 100755 --- a/include/asterisk/fskmodem.h +++ b/include/asterisk/fskmodem.h @@ -16,9 +16,9 @@ * at the top of the source tree. */ -/* - * FSK Modem Support - * Includes code and algorithms from the Zapata library. +/*! \file + * \brief FSK Modem Support + * \note Includes code and algorithms from the Zapata library. */ #ifndef _ASTERISK_FSKMODEM_H @@ -57,7 +57,8 @@ typedef struct { float cola_demod[NCOLA]; /* Cola de muestras demoduladas */ } fsk_data; -/* Retrieve a serial byte into outbyte. Buffer is a pointer into a series of +/* \brief Retrieve a serial byte into outbyte. + Buffer is a pointer into a series of shorts and len records the number of bytes in the buffer. len will be overwritten with the number of bytes left that were not consumed, and the return value is as follows: diff --git a/include/asterisk/image.h b/include/asterisk/image.h index b4044c974..1b29b1daa 100755 --- a/include/asterisk/image.h +++ b/include/asterisk/image.h @@ -16,14 +16,14 @@ * at the top of the source tree. */ -/* - * General Asterisk channel definitions. +/*! \file + * \brief General Asterisk channel definitions for image handling */ #ifndef _ASTERISK_IMAGE_H #define _ASTERISK_IMAGE_H -/*! structure associated with registering an image format */ +/*! \brief structure associated with registering an image format */ struct ast_imager { /*! Name */ char *name; diff --git a/include/asterisk/indications.h b/include/asterisk/indications.h index bc5f8b431..4ae0d2056 100755 --- a/include/asterisk/indications.h +++ b/include/asterisk/indications.h @@ -8,8 +8,8 @@ * channels for your use. */ -/* - * BSD Telephony Of Mexico "Tormenta" Tone Zone Support 2/22/01 +/*! \file + * \brief BSD Telephony Of Mexico "Tormenta" Tone Zone Support 2/22/01 * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by diff --git a/include/asterisk/inline_api.h b/include/asterisk/inline_api.h index 52b5673f6..2347d09d7 100755 --- a/include/asterisk/inline_api.h +++ b/include/asterisk/inline_api.h @@ -16,14 +16,12 @@ * at the top of the source tree. */ -/* - * Inlinable API function macro - */ - #ifndef __ASTERISK_INLINEAPI_H #define __ASTERISK_INLINEAPI_H -/* +/*! \file + * \brief Inlinable API function macro + Small API functions that are candidates for inlining need to be specially declared and defined, to ensure that the 'right thing' always happens. For example: diff --git a/include/asterisk/io.h b/include/asterisk/io.h index 8bda98a2b..c33fb515b 100755 --- a/include/asterisk/io.h +++ b/include/asterisk/io.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * I/O Management (derived from Cheops-NG) +/*! \file + * \brief I/O Management (derived from Cheops-NG) */ #ifndef _ASTERISK_IO_H diff --git a/include/asterisk/localtime.h b/include/asterisk/localtime.h index c02dc43b6..fac1788c0 100755 --- a/include/asterisk/localtime.h +++ b/include/asterisk/localtime.h @@ -17,8 +17,8 @@ * at the top of the source tree. */ -/* - * Custom localtime functions for multiple timezones +/*! \file + * \brief Custom localtime functions for multiple timezones */ #ifndef _ASTERISK_LOCALTIME_H diff --git a/include/asterisk/lock.h b/include/asterisk/lock.h index a0b84c01f..f1747454c 100755 --- a/include/asterisk/lock.h +++ b/include/asterisk/lock.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * General Asterisk channel definitions. +/*! \file + * \brief General Asterisk channel locking definitions. */ #ifndef _ASTERISK_LOCK_H @@ -35,7 +35,7 @@ #ifdef __APPLE__ /* Provide the Linux initializers for MacOS X */ -#define PTHREAD_MUTEX_RECURSIVE_NP PTHREAD_MUTEX_RECURSIVE +#define PTHREAD_MUTEX_RECURSIVE_NP PTHREAD_MUTEX_RECURSIVE #define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP { 0x4d555458, \ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, \ 0x20 } } diff --git a/include/asterisk/manager.h b/include/asterisk/manager.h index ea8f91de9..efe6c89b6 100755 --- a/include/asterisk/manager.h +++ b/include/asterisk/manager.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * AMI - Asterisk Management Interface +/*! \file + * \brief AMI - Asterisk Management Interface * External call management support */ diff --git a/include/asterisk/md5.h b/include/asterisk/md5.h index b2d6eb3d7..f738bd5b6 100755 --- a/include/asterisk/md5.h +++ b/include/asterisk/md5.h @@ -16,6 +16,10 @@ * at the top of the source tree. */ +/*!\file + * \brief MD5 digest functions + */ + #ifndef _ASTERISK_MD5_H #define _ASTERISK_MD5_H diff --git a/include/asterisk/monitor.h b/include/asterisk/monitor.h index 21f30f05c..8793f70c2 100755 --- a/include/asterisk/monitor.h +++ b/include/asterisk/monitor.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Channel monitoring +/*! \file + * \brief Channel monitoring */ #ifndef _ASTERISK_MONITOR_H diff --git a/include/asterisk/musiconhold.h b/include/asterisk/musiconhold.h index 410e99e58..8a0bf6417 100755 --- a/include/asterisk/musiconhold.h +++ b/include/asterisk/musiconhold.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Music on hold handling +/*! \file + * \brief Music on hold handling */ #ifndef _ASTERISK_MOH_H diff --git a/include/asterisk/netsock.h b/include/asterisk/netsock.h index 3e99e6875..dd1c3a8f6 100755 --- a/include/asterisk/netsock.h +++ b/include/asterisk/netsock.h @@ -17,8 +17,8 @@ * at the top of the source tree. */ -/* - * Network socket handling +/*! \file + * \brief Network socket handling */ #ifndef _ASTERISK_NETSOCK_H diff --git a/include/asterisk/options.h b/include/asterisk/options.h index e00fb7696..20df377fb 100755 --- a/include/asterisk/options.h +++ b/include/asterisk/options.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Options provided by main asterisk program +/*! \file + * \brief Options provided by main asterisk program */ #ifndef _ASTERISK_OPTIONS_H diff --git a/include/asterisk/pbx.h b/include/asterisk/pbx.h index f49eee16b..2c54adb97 100755 --- a/include/asterisk/pbx.h +++ b/include/asterisk/pbx.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Core PBX routines and definitions. +/*! \file + * \brief Core PBX routines and definitions. */ #ifndef _ASTERISK_PBX_H diff --git a/include/asterisk/plc.h b/include/asterisk/plc.h index eda87b408..bb1a9f52b 100755 --- a/include/asterisk/plc.h +++ b/include/asterisk/plc.h @@ -1,9 +1,9 @@ -/* - * SpanDSP - a series of DSP components for telephony +/*! \file + * \brief SpanDSP - a series of DSP components for telephony * * plc.h * - * Written by Steve Underwood <steveu@coppice.org> + * \author Steve Underwood <steveu@coppice.org> * * Copyright (C) 2004 Steve Underwood * @@ -27,7 +27,6 @@ * This version is disclaimed to DIGIUM for inclusion in the Asterisk project. */ -/*! \file */ #if !defined(_PLC_H_) #define _PLC_H_ diff --git a/include/asterisk/privacy.h b/include/asterisk/privacy.h index 48d1518c5..686a14d75 100755 --- a/include/asterisk/privacy.h +++ b/include/asterisk/privacy.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Persistant data storage (akin to *doze registry) +/*! \file + * \brief Persistant data storage (akin to *doze registry) */ #ifndef _ASTERISK_PRIVACY_H diff --git a/include/asterisk/res_odbc.h b/include/asterisk/res_odbc.h index edba5b336..d585ebdab 100755 --- a/include/asterisk/res_odbc.h +++ b/include/asterisk/res_odbc.h @@ -18,8 +18,8 @@ * at the top of the source tree. */ -/* - * ODBC resource manager +/*! \file + * \brief ODBC resource manager */ #ifndef _ASTERISK_RES_ODBC_H diff --git a/include/asterisk/rtp.h b/include/asterisk/rtp.h index a5c3014ea..bdb0391fd 100755 --- a/include/asterisk/rtp.h +++ b/include/asterisk/rtp.h @@ -20,7 +20,7 @@ * \file rtp.h * \brief Supports RTP and RTCP with Symmetric RTP support for NAT traversal. * - * RTP is deffined in RFC 3550. + * RTP is defined in RFC 3550. */ #ifndef _ASTERISK_RTP_H diff --git a/include/asterisk/say.h b/include/asterisk/say.h index 9634271f3..ac498cde2 100755 --- a/include/asterisk/say.h +++ b/include/asterisk/say.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Say numbers and dates (maybe words one day too) +/*! \file + * \brief Say numbers and dates (maybe words one day too) */ #ifndef _ASTERISK_SAY_H diff --git a/include/asterisk/sched.h b/include/asterisk/sched.h index 766342f0f..eca928ca4 100755 --- a/include/asterisk/sched.h +++ b/include/asterisk/sched.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Scheduler Routines (derived from cheops) +/*! \file + * \brief Scheduler Routines (derived from cheops) */ #ifndef _ASTERISK_SCHED_H diff --git a/include/asterisk/slinfactory.h b/include/asterisk/slinfactory.h index fc7990000..e7403032c 100755 --- a/include/asterisk/slinfactory.h +++ b/include/asterisk/slinfactory.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * A machine to gather up arbitrary frames and convert them +/*! \file + * \brief A machine to gather up arbitrary frames and convert them * to raw slinear on demand. */ diff --git a/include/asterisk/srv.h b/include/asterisk/srv.h index cde9b6ac0..08dcac0f2 100755 --- a/include/asterisk/srv.h +++ b/include/asterisk/srv.h @@ -28,7 +28,7 @@ struct ast_channel; /*! \file srv.h \brief Support for DNS SRV records, used in to locate SIP services. - Note: The Asterisk DNS SRV record support is broken, it only + \note Note: The Asterisk DNS SRV record support is broken, it only supports the first DNS SRV record and will give no load balancing or failover support. */ diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h index 508a3ba7e..d7d27e515 100755 --- a/include/asterisk/strings.h +++ b/include/asterisk/strings.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * String manipulation functions +/*! \file + * \brief String manipulation functions */ #ifndef _ASTERISK_STRINGS_H diff --git a/include/asterisk/tdd.h b/include/asterisk/tdd.h index 2e129fed4..ed85e0d34 100755 --- a/include/asterisk/tdd.h +++ b/include/asterisk/tdd.h @@ -16,9 +16,9 @@ * at the top of the source tree. */ -/* - * TTY/TDD Generation support - * Includes code and algorithms from the Zapata library. +/*! \file + * \brief TTY/TDD Generation support + * \note Includes code and algorithms from the Zapata library. */ #ifndef _ASTERISK_TDD_H diff --git a/include/asterisk/term.h b/include/asterisk/term.h index fc0dab669..499927600 100755 --- a/include/asterisk/term.h +++ b/include/asterisk/term.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Handy terminal functions for vt* terms +/*! \file + * \brief Handy terminal functions for vt* terms */ #ifndef _ASTERISK_TERM_H @@ -29,22 +29,22 @@ extern "C" { #define ESC 0x1b #define ATTR_RESET 0 -#define ATTR_BRIGHT 1 +#define ATTR_BRIGHT 1 #define ATTR_DIM 2 #define ATTR_UNDER 4 #define ATTR_BLINK 5 #define ATTR_REVER 7 -#define ATTR_HIDDEN 8 +#define ATTR_HIDDEN 8 #define COLOR_BLACK 30 #define COLOR_GRAY 30 | 128 -#define COLOR_RED 31 -#define COLOR_BRRED 31 | 128 -#define COLOR_GREEN 32 +#define COLOR_RED 31 +#define COLOR_BRRED 31 | 128 +#define COLOR_GREEN 32 #define COLOR_BRGREEN 32 | 128 -#define COLOR_BROWN 33 +#define COLOR_BROWN 33 #define COLOR_YELLOW 33 | 128 -#define COLOR_BLUE 34 +#define COLOR_BLUE 34 #define COLOR_BRBLUE 34 | 128 #define COLOR_MAGENTA 35 #define COLOR_BRMAGENTA 35 | 128 diff --git a/include/asterisk/time.h b/include/asterisk/time.h index 45fdb46ed..c957cb142 100755 --- a/include/asterisk/time.h +++ b/include/asterisk/time.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Time-related functions and macros +/*! \file + * \brief Time-related functions and macros */ #ifndef _ASTERISK_TIME_H diff --git a/include/asterisk/transcap.h b/include/asterisk/transcap.h index 0187a7381..5da8329dc 100755 --- a/include/asterisk/transcap.h +++ b/include/asterisk/transcap.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * General Asterisk channel definitions. +/*! \file + * \brief General Asterisk channel transcoding definitions. */ #ifndef _ASTERISK_TRANSCAP_H diff --git a/include/asterisk/translate.h b/include/asterisk/translate.h index aea3996e5..7bb4aa441 100755 --- a/include/asterisk/translate.h +++ b/include/asterisk/translate.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Translate via the use of pseudo channels +/*! \file + * \brief Translate via the use of pseudo channels */ #ifndef _ASTERISK_TRANSLATE_H diff --git a/include/asterisk/ulaw.h b/include/asterisk/ulaw.h index 58c1cb9d4..b9edacb97 100755 --- a/include/asterisk/ulaw.h +++ b/include/asterisk/ulaw.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * u-Law to Signed linear conversion +/*! \file + * \brief u-Law to Signed linear conversion */ #ifndef _ASTERISK_ULAW_H diff --git a/include/asterisk/unaligned.h b/include/asterisk/unaligned.h index f05369c75..16791d6f0 100755 --- a/include/asterisk/unaligned.h +++ b/include/asterisk/unaligned.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Handle unaligned data access +/*! \file + * \brief Handle unaligned data access */ #ifndef _ASTERISK_UNALIGNED_H diff --git a/include/asterisk/utils.h b/include/asterisk/utils.h index cd2098d94..e0c32597d 100755 --- a/include/asterisk/utils.h +++ b/include/asterisk/utils.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Utility functions +/*! \file + * \brief Utility functions */ #ifndef _ASTERISK_UTILS_H @@ -34,7 +34,9 @@ #include "asterisk/time.h" #include "asterisk/strings.h" -/* Note: +/*! \note + \verbatim + Note: It is very important to use only unsigned variables to hold bit flags, as otherwise you can fall prey to the compiler's sign-extension antics if you try to use the top two bits in @@ -46,13 +48,13 @@ type of variable, a warning message similar to this: warning: comparison of distinct pointer types lacks cast - will be generated. The "dummy" variable below is used to make these comparisons. Also note that at -O2 or above, this type-safety checking does _not_ produce any additional object code at all. + \endverbatim */ extern unsigned int __unsigned_int_flags_dummy; diff --git a/include/asterisk/vmodem.h b/include/asterisk/vmodem.h index 1ea57c6d6..8d700653b 100755 --- a/include/asterisk/vmodem.h +++ b/include/asterisk/vmodem.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Voice Modem Definitions +/*! \file + * \brief Voice Modem Definitions */ #ifndef _ASTERISK_VMODEM_H @@ -35,13 +35,13 @@ #define MODEM_DEV_SPKRPHONE 6 #define MODEM_DEV_HANDSET 9 -#define MODEM_DTMF_NONE (1 << 0) -#define MODEM_DTMF_AST (1 << 1) -#define MODEM_DTMF_I4L (1 << 2) +#define MODEM_DTMF_NONE (1 << 0) +#define MODEM_DTMF_AST (1 << 1) +#define MODEM_DTMF_I4L (1 << 2) /* Thirty millisecond sections */ -#define MODEM_MAX_LEN 30 -#define MODEM_MAX_BUF MODEM_MAX_LEN * 16 +#define MODEM_MAX_LEN 30 +#define MODEM_MAX_BUF MODEM_MAX_LEN * 16 #define AST_MAX_INIT_STR 256 |