Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

clean up a lot of doxygen errors and warnings (issue #5522)

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6865 65c4cc65-6c06-0410-ace0-fbb531ad65f3
1.2-netsec
Russell Bryant 20 years ago
parent 5187de9ab6
commit 3332a8acd1
23 changed files with 133 additions and 115 deletions
Show Stats Download Patch File Download Diff File

4
ast_expr2f.c
Unescape View File

@ -2156,7 +2156,7 @@ YY_BUFFER_STATE ast_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yys
/** Setup the input buffer state to scan a string. The next call to ast_yylex() will
* scan from a @e copy of @a str.
* @param str a NUL-terminated string to scan
* @param yy_str a NUL-terminated string to scan
* @param yyscanner The scanner object.
* @return the newly allocated buffer state object.
* @note If you want to scan bytes that may contain NUL values, then use
@ -2332,7 +2332,7 @@ void ast_yyset_lineno (int line_number , yyscan_t yyscanner)
}
/** Set the current column.
* @param line_number
* @param column_no
* @param yyscanner The scanner object.
*/
void ast_yyset_column (int column_no , yyscan_t yyscanner)

3
codecs/log2comp.h
Unescape View File

@ -1,4 +1,5 @@
/*! \file \brief log2comp.h - various base 2 log computation versions
/*! \file
* \brief log2comp.h - various base 2 log computation versions
*
* Asterisk -- A telephony toolkit for Linux.
*

2
include/asterisk/adsi.h
Unescape View File

@ -212,7 +212,7 @@ extern int adsi_get_cpeinfo(struct ast_channel *chan, int *width, int *height, i
/*! Begin an ADSI script download */
/*!
* \param buf Character buffer to create parameter in (must have at least 256 free)
* \param service, a 1-18 byte name of the feature
* \param service a 1-18 byte name of the feature
* \param fdn 4 byte Feature Download Number (for loading soft keys)
* \param sec 4 byte vendor security code
* \param ver version number (0-255, or -1 to omit)

8
include/asterisk/callerid.h
Unescape View File

@ -57,6 +57,7 @@ extern void callerid_init(void);
* \param buf Buffer to use. If "buf" is supplied, it will use that buffer instead of allocating its own. "buf" must be at least 32000 bytes in size of you want to be sure you don't have an overrun.
* \param number Use NULL for no number or "P" for "private"
* \param name name to be used
* \param flags passed flags
* \param callwaiting callwaiting flag
* \param codec -- either AST_FORMAT_ULAW or AST_FORMAT_ALAW
* This function creates a stream of callerid (a callerid spill) data in ulaw format. It returns the size
@ -76,7 +77,7 @@ extern struct callerid_state *callerid_new(int cid_signalling);
/*! Read samples into the state machine. */
/*!
* \param cid Which state machine to act upon
* \param buffer containing your samples
* \param ubuf containing your samples
* \param samples number of samples contained within the buffer.
* \param codec which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW)
*
@ -120,7 +121,8 @@ extern void callerid_free(struct callerid_state *cid);
/*! Generate Caller-ID spill from the "callerid" field of asterisk (in e-mail address like format) */
/*!
* \param buf buffer for output samples. See callerid_generate() for details regarding buffer.
* \param astcid Asterisk format callerid string, taken from the callerid field of asterisk.
* \param name Caller-ID Name
* \param number Caller-ID Number
* \param codec Asterisk codec (either AST_FORMAT_ALAW or AST_FORMAT_ULAW)
*
* Acts like callerid_generate except uses an asterisk format callerid string.
@ -138,7 +140,7 @@ extern int ast_callerid_callwaiting_generate(unsigned char *buf, char *name, cha
/*! Destructively parse inbuf into name and location (or number) */
/*!
* \param inbuf buffer of callerid stream (in audio form) to be parsed. Warning, data in buffer is changed.
* \param instr buffer of callerid stream (in audio form) to be parsed. Warning, data in buffer is changed.
* \param name address of a pointer-to-char for the name value of the stream.
* \param location address of a pointer-to-char for the phone number value of the stream.
* Parses callerid stream from inbuf and changes into useable form, outputed in name and location.

3
include/asterisk/cdr.h
Unescape View File

@ -219,6 +219,7 @@ extern void ast_cdr_submit_batch(int shutdown);
/*! Set the destination channel, if there was one */
/*!
* \param cdr Which cdr it's applied to
* \param chan Channel to which dest will be
* Sets the destination channel the CDR is applied to
* Returns nothing
*/
@ -244,7 +245,7 @@ extern int ast_cdr_amaflags2int(const char *flag);
/*! Disposition to a string */
/*!
* \param flag input binary form
* \param disposition input binary form
* Converts the binary form of a disposition to string form.
* Returns a pointer to the string form
*/

13
include/asterisk/channel.h
Unescape View File

@ -489,6 +489,7 @@ void ast_channel_free(struct ast_channel *);
* \param type type of channel to request
* \param format requested channel format
* \param data data to pass to the channel requester
* \param status status
* Request a channel of a given type, with data as optional information used
* by the low level module
* Returns an ast_channel on success, NULL on failure.
@ -500,7 +501,9 @@ struct ast_channel *ast_request(const char *type, int format, void *data, int *s
* \param format requested channel format
* \param data data to pass to the channel requester
* \param timeout maximum amount of time to wait for an answer
* \param why unsuccessful (if unsuceessful)
* \param reason why unsuccessful (if unsuceessful)
* \param cidnum Caller-ID Number
* \param cidname Caller-ID Name
* Request a channel of a given type, with data as optional information used
* by the low level module and attempt to place a call on it
* Returns an ast_channel on success or no answer, NULL on failure. Check the value of chan->_state
@ -550,7 +553,9 @@ int ast_hangup(struct ast_channel *chan);
* Returns 0 regardless
*/
int ast_softhangup(struct ast_channel *chan, int cause);
/*! Softly hangup up a channel (no channel lock)
* \param chan channel to be soft-hung-up
* \param cause Ast hangupcause for hangup */
int ast_softhangup_nolock(struct ast_channel *chan, int cause);
@ -823,7 +828,7 @@ int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
/*!
* \param c0 first channel to bridge
* \param c1 second channel to bridge
* \param flags for the channels
* \param config config for the channels
* \param fo destination frame(?)
* \param rc destination channel(?)
* Bridge two channels (c0 and c1) together. If an important frame occurs, we return that frame in
@ -845,7 +850,7 @@ int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clo
/*! Gives the string form of a given cause code */
/*!
* \param cause cause to get the description of
* \param state cause to get the description of
* Give a name to a cause code
* Returns the text form of the binary cause code given
*/
@ -861,7 +866,7 @@ char *ast_state2str(int state);
/*! Gives the string form of a given transfer capability */
/*!
* \param transercapability transfercapabilty to get the name of
* \param transfercapability transfercapabilty to get the name of
* Give a name to a transfercapbility
* See above
* Returns the text form of the binary transfer capbility

10
include/asterisk/config.h
Unescape View File

@ -60,7 +60,7 @@ struct ast_config_engine {
};
/*! \brief Load a config file
* \param configfile path of file to open. If no preceding '/' character, path is considered relative to AST_CONFIG_DIR
* \param filename 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.
*
* Returns NULL on error, or an ast_config data structure on success
@ -94,7 +94,7 @@ struct ast_variable *ast_variable_browse(const struct ast_config *config, const
/*! \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
* \param variable which variable you wish to get the data for
* Goes through a given config file in the given category and searches for the given variable
*
* Returns the variable value on success, or NULL if unable to find it.
@ -121,8 +121,6 @@ int ast_category_exist(const struct ast_config *config, const char *category_nam
/*! \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.
* This will use builtin configuration backends to look up a particular
* entity in realtime and return a variable list of its parameters. Note
* that unlike the variables in ast_config, the resulting list of variables
@ -132,8 +130,6 @@ struct ast_variable *ast_load_realtime(const char *family, ...);
/*! \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.
* This will use builtin configuration backends to look up a particular
* entity in realtime and return a variable list of its parameters. Unlike
* the ast_load_realtime, this function can return more than one entry and
@ -146,8 +142,6 @@ struct ast_config *ast_load_realtime_multientry(const char *family, ...);
* \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.
* \param variable which variable should be updated in the config, NULL to end list
* \param value the value to be assigned to that variable in the given entity.
* This function is used to update a parameter in realtime configuration space.
*
*/

1
include/asterisk/devicestate.h
Unescape View File

@ -87,6 +87,7 @@ int ast_device_state_changed(const char *fmt, ...)
int ast_device_state_changed_literal(const char *device);
/*! \brief Registers a device state change callback
* \param callback 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

94
include/asterisk/doxyref.h
Unescape View File

@ -88,7 +88,7 @@ DUNDi is a peer-to-peer system for locating Internet gateways to telephony servi
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 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
*/
@ -99,6 +99,7 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub
* \arg \ref cdr.c
* \arg \ref Config_cdr CDR configuration files
*/
/*! \page AstREADME README - the general administrator introduction
* \verbinclude README
*/
@ -127,7 +128,7 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub
* \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
* \section chanconf Channel configuration files
* \arg \link Config_iax IAX2 configuration \endlink
* \arg \link Config_sip SIP configuration \endlink
* \arg \link Config_mgcp MGCP configuration \endlink
@ -140,12 +141,20 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub
* \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 cdrconf CDR configuration files
* \arg \link Config_cdr CDR configuration \endlink
* \arg \link cdr_custom Custom CDR driver configuration \endlink
* \arg \link cdr_ami Manager CDR driver configuration \endlink
* \arg \link cdr_odbc ODBC CDR driver configuration \endlink
* \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
* \arg \link cdr_sqlite SQLite CDR driver configuration \endlink
* \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
* \section miscconf Miscellenaous configuration files
* \arg \link Config_adsi Adsi configuration \endlink
* \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_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
@ -169,17 +178,22 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub
*/
/*! \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
* IAX2 is implemented in \ref chan_iax2.c
* \arg \link Config_iax iax.conf Configuration file example \endlink
* \section iaxreadme IAX readme file
* \verbinclude README.iax
* \section iaxconfig IAX Configuration example
* \section Config_iax IAX Configuration example
* \verbinclude iax.conf.sample
* \section iaxjitter IAX Jitterbuffer information
* \verbinclude README.jitterbuffer
*/
/*! \page Config_iax IAX configuration
* \ref chan_iax2.c
* \section iaxconf iax.conf
* \verbinclude iax.conf.sample
*/
/*! \page Config_sip SIP configuration
* Also see \ref Config_rtp RTP configuration
* \ref chan_sip.c
@ -194,7 +208,6 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub
* \verbinclude mgcp.conf.sample
*/
/*! \page Config_vm VoiceMail configuration
* \section vmconf voicemail.conf
* \ref app_voicemail.c
@ -233,8 +246,8 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub
* \verbinclude rtp.conf.sample
*/
/*! \page Config_dun Dundi Configuration
* \arg See also \ref AstDundi
/*! \page Config_dun DUNDi Configuration
* \arg See also \ref AstDUNDi
* \section dundiconf dundi.conf
* \verbinclude dundi.conf.sample
*/
@ -246,37 +259,60 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub
* \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
/*! \page cdr_custom Custom CDR Configuration
* \arg See also \ref cdrconf
* \arg \ref cdr_custom.c
* \verbinclude cdr_custom.conf.sample
* \section cdrami Manager CDR driver configuration
*/
/*! \page cdr_ami Manager CDR driver configuration
* \arg See also \ref cdrconf
* See also:
* \arg \ref AstAMI
* \arg \ref cdr_manager.c
* \verbinclude cdr_manager.conf.sample
* \section cdrodbc ODBC CDR driver configuration
* See also:
* \arg http://www.unixodbc.org
*/
/*! \page cdr_odbc ODBC CDR driver configuration
* \arg See also \ref cdrconf
* \arg \ref cdr_odbc.c
* \verbinclude cdr_odbc.conf.sample
* \section cdrpgsql Postgres CDR driver configuration
* See also:
* \arg http://www.unixodbc.org
*/
/*! \page cdr_pgsql PostgreSQL CDR driver configuration
* \arg See also \ref cdrconf
* \arg \ref cdr_pgsql.c
* See also:
* \arg http://www.postgresql.org
* \verbinclude cdr_pgsql.conf.sample
* \section cdrtds FreeTDS CDR driver configuration
*/
/*! \page cdr_sqlite SQLite CDR driver configuration
* \arg See also \ref cdrconf
* \arg \ref cdr_sqlite.c
* See also:
* \arg http://www.sqlite.org
*/
/*! \page cdr_tds FreeTDS CDR driver configuration
* \arg See also \ref cdrconf
* See also:
* \arg http://www.freetds.org
* \verbinclude cdr_tds.conf.sample
*/
/*! \page Config_cdr CDR configuration
* \verbinclude cdr.conf.sample
* \arg \link Config_cdr CDR configuration \endlink
* \arg \link cdr_custom Custom CDR driver configuration \endlink
* \arg \link cdr_ami Manager CDR driver configuration \endlink
* \arg \link cdr_odbc ODBC CDR driver configuration \endlink
* \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
* \arg \link cdr_sqlite SQLite CDR driver configuration \endlink
* \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
*/
/*! \page Config_moh Music on Hold Configuration
* \arg Implemented in \ref res_musiconhold.c
@ -295,13 +331,13 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub
*/
/*! \page Config_ara REALTIME Configuration
* \arg See also: \AstARA
* \arg See also: \arg \link AstARA \endlink
* \section extconf extconfig.conf
* \verbinclude extconfig.conf.sample
*/
/*! \page Config_ami AMI configuration
* \arg See also: \AstAMI
* \arg See also: \arg \link AstAMI \endlink
* \section amiconf manager.conf
* \verbinclude manager.conf.sample
*/

19
include/asterisk/enum.h
Unescape View File

@ -27,27 +27,24 @@
/*! \brief Lookup entry in ENUM Returns 1 if found, 0 if not found, -1 on hangup
\param chan Channel
\param number E164 number with or without the leading +
\param number E164 number with or without the leading +
\param location Number returned (or SIP uri)
\param maxloc Max length
\param tech Technology (from url scheme in response)
\param maxtech Max length
\param tech Technology (from url scheme in response)
\param technology Technology (from url scheme in response)
You can set it to get particular answer RR, if there are many techs in DNS response, example: "sip"
If you need any record, then set it to empty string
\param maxtech Max length
\param suffix Zone suffix (if is NULL then use enum.conf 'search' variable)
\param options Options ('c' to count number of NAPTR RR, or number - the position of required RR in the answer list
\param maxtech Max length
\param suffix Zone suffix (if is NULL then use enum.conf 'search' variable)
\param options Options ('c' to count number of NAPTR RR, or number - the position of required RR in the answer list
*/
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 +
\param locatio Number returned (or SIP uri)
\param number E164 number with or without the leading +
\param location Number returned (or SIP uri)
\param maxloc Max length of number
\param tech Technology (not used in TXT records)
\param technology Technology (not used in TXT records)
\param maxtech Max length
\param txt Text string (return value)
\param maxtxt Max length of "txt"

36
include/asterisk/file.h
Unescape View File

@ -109,7 +109,7 @@ int ast_filerename(const char *oldname, const char *newname, const char *fmt);
/*! Deletes a file */
/*!
* \param filename name of the file you wish to delete (minus the extension)
* \param format of the file
* \param fmt of the file
* Delete a given file in a given format, or if fmt is NULL, then do so for all
*/
int ast_filedelete(const char *filename, const char *fmt);
@ -181,7 +181,7 @@ struct ast_filestream *ast_readfile(const char *filename, const char *type, cons
* \param filename the name of the file to write to
* \param type format of file you wish to write out to
* \param comment comment to go with
* \param oflags output file flags
* \param flags output file flags
* \param check (unimplemented, hence negligible)
* \param mode Open mode
* Create an outgoing file stream. oflags are flags for the open() command, and
@ -239,21 +239,21 @@ struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *fil
/*! Applys a open stream to a channel. */
/*!
* \param chan channel to work
* \param ast_filestream s to apply
* \param s ast_filestream to apply
* Returns 0 for success, -1 on failure
*/
int ast_applystream(struct ast_channel *chan, struct ast_filestream *s);
/*! play a open stream on a channel. */
/*!
* \param ast_filestream s to play
* \param s filestream to play
* Returns 0 for success, -1 on failure
*/
int ast_playstream(struct ast_filestream *s);
/*! Seeks into stream */
/*!
* \param ast_filestream to perform seek on
* \param fs ast_filestream to perform seek on
* \param sample_offset numbers of samples to seek
* \param whence SEEK_SET, SEEK_CUR, SEEK_END
* Returns 0 for success, or -1 for error
@ -262,14 +262,14 @@ int ast_seekstream(struct ast_filestream *fs, long sample_offset, int whence);
/*! Trunc stream at current location */
/*!
* \param ast_filestream fs
* \param fs filestream to act on
* Returns 0 for success, or -1 for error
*/
int ast_truncstream(struct ast_filestream *fs);
/*! Fast forward stream ms */
/*!
* \param ast_filestream fs filestream to act on
* \param fs filestream to act on
* \param ms milliseconds to move
* Returns 0 for success, or -1 for error
*/
@ -277,23 +277,7 @@ int ast_stream_fastforward(struct ast_filestream *fs, long ms);
/*! Rewind stream ms */
/*!
* \param ast_filestream fs filestream to act on
* \param ms milliseconds to move
* Returns 0 for success, or -1 for error
*/
int ast_stream_rewind(struct ast_filestream *fs, long ms);
/*! Fast forward stream ms */
/*!
* \param ast_filestream fs filestream to act on
* \param ms milliseconds to move
* Returns 0 for success, or -1 for error
*/
int ast_stream_fastforward(struct ast_filestream *fs, long ms);
/*! Rewind stream ms */
/*!
* \param ast_filestream fs filestream to act on
* \param fs filestream to act on
* \param ms milliseconds to move
* Returns 0 for success, or -1 for error
*/
@ -301,14 +285,14 @@ int ast_stream_rewind(struct ast_filestream *fs, long ms);
/*! Tell where we are in a stream */
/*!
* \param ast_filestream fs to act on
* \param fs fs to act on
* Returns a long as a sample offset into stream
*/
long ast_tellstream(struct ast_filestream *fs);
/*! Read a frame from a filestream */
/*!
* \param ast_filestream fs to act on
* \param s ast_filestream to act on
* Returns a frame or NULL if read failed
*/
struct ast_frame *ast_readframe(struct ast_filestream *s);

2
include/asterisk/frame.h
Unescape View File

@ -336,7 +336,7 @@ extern char* ast_getformatname(int format);
/*! Get the names of a set of formats */
/*!
* \param buf a buffer for the output string
* \param n size of buf (bytes)
* \param size size of buf (bytes)
* \param format the format (combined IDs of codecs)
* Prints a list of readable codec names corresponding to "format".
* ex: for format=AST_FORMAT_GSM|AST_FORMAT_SPEEX|AST_FORMAT_ILBC it will return "0x602 (GSM|SPEEX|ILBC)"

15
include/asterisk/manager.h
Unescape View File

@ -16,11 +16,6 @@
* at the top of the source tree.
*/
/*! \file
* \brief AMI - Asterisk Management Interface
* External call management support
*/
#ifndef _ASTERISK_MANAGER_H
#define _ASTERISK_MANAGER_H
@ -33,9 +28,9 @@
#include "asterisk/lock.h"
/*!
\file manager.h
\brief The AMI - Asterisk Manager Interface - is a TCP protocol created to
manage Asterisk with third-party software.
\file
\brief The AMI - Asterisk Manager Interface - is a TCP protocol created to
manage Asterisk with third-party software.
Manager protocol packages are text fields of the form a: b. There is
always exactly one space after the colon.
@ -47,9 +42,7 @@
** Please try to re-use existing headers to simplify manager message parsing in clients.
Don't re-use an existing header with a new meaning, please.
You can find a reference of standard headers in
doc/manager.txt
You can find a reference of standard headers in doc/manager.txt
*/
#define DEFAULT_MANAGER_PORT 5038 /* Default port for Asterisk management via TCP */

3
include/asterisk/module.h
Unescape View File

@ -179,6 +179,7 @@ void ast_update_use_count(void);
/*!
* \brief Ask for a list of modules, descriptions, and use counts.
* \param modentry A callback to an updater function.
* \param like
*
* For each of the modules loaded, modentry will be executed with the resource,
* description, and usecount values of each particular module.
@ -201,7 +202,7 @@ int ast_loader_register(int (*updater)(void));
/*!
* \brief Remove a procedure to be run when modules are updated.
* \param The updater function to unregister.
* \param updater The updater function to unregister.
*
* This removes the given function from the updater list.
*

15
include/asterisk/pbx.h
Unescape View File

@ -184,7 +184,7 @@ struct ast_context *ast_context_create(struct ast_context **extcontexts, const c
/*! Merge the temporary contexts into a global contexts list and delete from the global list the ones that are being added */
/*!
* \param extcontexts pointer to the ast_context structure pointer
* \param registar of the context; if it's set the routine will delete all contexts that belong to that registrar; if NULL only the contexts that are specified in extcontexts
* \param registrar of the context; if it's set the routine will delete all contexts that belong to that registrar; if NULL only the contexts that are specified in extcontexts
*/
void ast_merge_contexts_and_delete(struct ast_context **extcontexts, const char *registrar);
@ -233,6 +233,7 @@ enum ast_pbx_result ast_pbx_run(struct ast_channel *c);
* \param replace
* \param extension extension to add
* \param priority priority level of extension addition
* \param label extension label
* \param callerid callerid of extension
* \param application application to run on the extension with that priority level
* \param data data to pass to the application
@ -310,6 +311,7 @@ int ast_extension_state_add(const char *context, const char *exten,
/*! Deletes a registered state change callback by ID */
/*!
* \param id of the callback to delete
* \param callback callback
* Removes the callback from list of callbacks
* Return 0 on success, -1 on failure
*/
@ -319,8 +321,8 @@ int ast_extension_state_del(int id, ast_state_cb_type callback);
/*!
* \param hint buffer for hint
* \param maxlen size of hint buffer
* \param hint buffer for name portion of hint
* \param maxlen size of name buffer
* \param name buffer for name portion of hint
* \param maxnamelen size of name buffer
* \param c this is not important
* \param context which context to look in
* \param exten which extension to search for
@ -349,7 +351,7 @@ int ast_exists_extension(struct ast_channel *c, const char *context, const char
* \param c this is not important
* \param context which context to look in
* \param exten which extension to search for
* \param labellabel of the action within the extension to match to priority
* \param label label of the action within the extension to match to priority
* \param callerid callerid to search for
* If an priority which matches given label in extension or -1 if not found.
\ */
@ -411,6 +413,7 @@ int ast_spawn_extension(struct ast_channel *c, const char *context, const char *
\param context which context extension is in
\param exten extension to execute
\param priority priority to execute within the given extension
\param callerid Caller-ID
If it's not available, do whatever you should do for
default extensions and halt the thread if necessary. This function does not
return, except on error.
@ -497,7 +500,7 @@ int ast_context_remove_extension2(struct ast_context *con, const char *extension
/*! Add an ignorepat */
/*!
* \param context which context to add the ignorpattern to
* \param ignorpat ignorepattern to set up for the extension
* \param ignorepat ignorepattern to set up for the extension
* \param registrar registrar of the ignore pattern
* Adds an ignore pattern to a particular context.
* Returns 0 on success, -1 on failure
@ -519,7 +522,7 @@ int ast_context_remove_ignorepat2(struct ast_context *con, const char *ignorepat
/*! Checks to see if a number should be ignored */
/*!
* \param context context to search within
* \param extension to check whether it should be ignored or not
* \param pattern to check whether it should be ignored or not
* Check if a number should be ignored with respect to dialtone cancellation.
* Returns 0 if the pattern should not be ignored, or non-zero if the pattern should be ignored
*/

2
include/asterisk/plc.h
Unescape View File

@ -150,8 +150,6 @@ int plc_fillin(plc_state_t *s, int16_t amp[], int len);
/*! Process a block of received V.29 modem audio samples.
\brief Process a block of received V.29 modem audio samples.
\param s The packet loss concealer context.
\param amp The audio sample buffer.
\param len The number of samples in the buffer.
\return A pointer to the he packet loss concealer context. */
plc_state_t *plc_init(plc_state_t *s);

6
include/asterisk/strings.h
Unescape View File

@ -37,6 +37,7 @@ static inline int ast_strlen_zero(const char *s)
/*!
\brief Gets a pointer to the first non-whitespace character in a string.
\param ast_skip_blanks function being used
\param str the input string
\return a pointer to the first non-whitespace character
*/
@ -51,6 +52,7 @@ char *ast_skip_blanks(char *str),
/*!
\brief Trims trailing whitespace characters from a string.
\param ast_trim_blanks function being used
\param str the input string
\return a pointer to the NULL following the string
*/
@ -76,6 +78,7 @@ char *ast_trim_blanks(char *str),
/*!
\brief Gets a pointer to first whitespace character in a string.
\param ast_skip_noblanks function being used
\param str the input string
\return a pointer to the first whitespace character
*/
@ -135,6 +138,7 @@ char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes);
/*!
\brief Size-limited null-terminating string copy.
\param ast_copy_string function being used
\param dst The destination buffer.
\param src The source string
\param size The size of the destination buffer
@ -167,10 +171,10 @@ void ast_copy_string(char *dst, const char *src, size_t size),
This is a wrapper for snprintf, that properly handles the buffer pointer
and buffer space available.
\return 0 on success, non-zero on failure.
\param buffer current position in buffer to place string into (will be updated on return)
\param space remaining space in buffer (will be updated on return)
\param fmt printf-style format string
\return 0 on success, non-zero on failure.
*/
int ast_build_string(char **buffer, size_t *space, const char *fmt, ...) __attribute__ ((format (printf, 3, 4)));

3
include/asterisk/tdd.h
Unescape View File

@ -37,6 +37,7 @@ extern void tdd_init(void);
/*! Generates a CallerID FSK stream in ulaw format suitable for transmission. */
/*!
* \param tdd tdd structure
* \param buf Buffer to use. This needs to be large enough to accomodate all the generated samples.
* \param string This is the string to send.
* This function creates a stream of TDD data in ulaw format. It returns the size
@ -54,7 +55,7 @@ extern struct tdd_state *tdd_new(void);
/*! Read samples into the state machine, and return character (if any). */
/*!
* \param tdd Which state machine to act upon
* \param buffer containing your samples
* \param ubuf containing your samples
* \param samples number of samples contained within the buffer.
*
* Send received audio to the TDD demodulator.

2
manager.c
Unescape View File

@ -22,7 +22,7 @@
*
* Channel Management and more
*
* \ref manconf
* \ref amiconf
*/
#include <stdio.h>

1
pbx.c
Unescape View File

@ -4932,7 +4932,6 @@ static void *async_wait(void *data)
* This function updates the cdr for a failed spool call
* and takes the channel of the failed call as an argument.
*
* \param chan the channel for the failed call.
*/
int ast_pbx_outgoing_cdr_failed(void)
{

2
plc.c
Unescape View File

@ -28,8 +28,6 @@
*
*/
/*! \file */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

2
res/res_odbc.c
Unescape View File

@ -24,7 +24,7 @@
*
* \brief ODBC resource manager
*
* \arg See also: \ref cdrodbc
* \arg See also: \ref cdr_odbc
*
*/

2
say.c
Unescape View File

@ -3591,7 +3591,7 @@ int ast_say_date_with_format_de(struct ast_channel *chan, time_t time, const cha
/** ast_say_date_with_format_he Say formmated date in Hebrew
*
* @seealso ast_say_date_with_format_en for the details of the options
* \ref ast_say_date_with_format_en for the details of the options
*
* Changes from the English version:
*

Write Preview
Loading…
Cancel
Save