sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

progdocs: Fix for Doxygen, the hidden parts. 

ASTERISK-29779

Change-Id: If338163488498f65fa7248b60e80299c0a928e4b
This commit is contained in:
Alexander Traud 2021-11-27 20:11:37 +01:00 committed by Kevin Harwell
parent affe7ee879
commit cc025026b7
48 changed files with 120 additions and 382 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
apps/app_confbridge.c
View File

@ -909,7 +909,7 @@ static int conf_start_record(struct confbridge_conference *conference)
return 0;
}
/* \brief Playback the given filename and monitor for any dtmf interrupts.
/*! \brief Playback the given filename and monitor for any dtmf interrupts.
*
* This function is used to playback sound files on a given channel and optionally
* allow dtmf interrupts to occur.
@ -923,7 +923,9 @@ static int conf_start_record(struct confbridge_conference *conference)
* \param channel Optional channel to play file on if bridge_channel not given
* \param filename The file name to playback
*
* \retval -1 failure during playback, 0 on file was fully played, 1 on dtmf interrupt.
* \retval -1 failure during playback.
* \retval 0 on file was fully played.
* \retval 1 on dtmf interrupt.
*/
static int play_file(struct ast_bridge_channel *bridge_channel, struct ast_channel *channel,
const char *filename)
@ -1306,7 +1308,7 @@ void conf_update_user_mute(struct confbridge_user *user)
ast_channel_name(user->chan));
}
/*
/*!
* \internal
* \brief Mute/unmute a single user.
*/
@ -3491,7 +3493,7 @@ static char *handle_cli_confbridge_list(struct ast_cli_entry *e, int cmd, struct
return CLI_SHOWUSAGE;
}
/* \internal
/*! \internal
* \brief finds a conference by name and locks/unlocks.
*
* \retval 0 success
@ -3515,7 +3517,7 @@ static int generic_lock_unlock_helper(int lock, const char *conference_name)
return res;
}
/* \internal
/*! \internal
* \brief finds a conference user by channel name and mutes/unmutes them.
*
* \retval 0 success

10
apps/app_queue.c
View File

@ -7790,9 +7790,10 @@ static int set_member_value(const char *queuename, const char *interface, int pr
return RESULT_FAILURE;
}
/* \brief Gets members penalty.
/*!
* \brief Gets members penalty.
* \return Return the members penalty or RESULT_FAILURE on error.
*/
*/
static int get_member_penalty(char *queuename, char *interface)
{
int foundqueue = 0, penalty;
@ -11542,9 +11543,10 @@ static int reload(void)
return 0;
}
/* \brief Find a member by looking up queuename and interface.
/*!
* \brief Find a member by looking up queuename and interface.
* \return member or NULL if member not found.
*/
*/
static struct member *find_member_by_queuename_and_interface(const char *queuename, const char *interface)
{
struct member *mem = NULL;

2
apps/app_stack.c
View File

@ -924,8 +924,6 @@ static struct ast_custom_function stackpeek_function = {
* \param chan Channel to balance stack on.
*
* \note The channel is already locked when called.
*
* \return Nothing
*/
static void balance_stack(struct ast_channel *chan)
{

2
apps/app_stasis.c
View File

@ -79,7 +79,7 @@
/*! \brief Dialplan application name */
static const char *stasis = "Stasis";
/*! /brief Stasis dialplan application callback */
/*! \brief Stasis dialplan application callback */
static int app_exec(struct ast_channel *chan, const char *data)
{
char *parse = NULL;

3
apps/app_voicemail.c
View File

@ -2865,6 +2865,7 @@ static int has_voicemail(const char *mailbox, const char *folder)
* \param recip
* \param fmt
* \param dir
* \param flag, dest_folder
*
* This works with IMAP storage based mailboxes.
*
@ -4154,8 +4155,6 @@ bail:
*
* This method is used when mailboxes are stored in an ODBC back end.
* The specified message is directly deleted from the database 'voicemessages' table.
*
* \return the value greater than zero on success to indicate the number of messages, less than zero on error.
*/
static void delete_file(const char *sdir, int smsg)
{

9
channels/chan_dahdi.c
View File

@ -2884,13 +2884,17 @@ static void my_set_rdnis(void *pvt, const char *rdnis)
*
* \details
* original dialstring:
* DAHDI/[i<span>-](g|G|r|R)<group#(0-63)>[c|r<cadence#>|d][/extension[/options]]
* \verbatim
DAHDI/[i<span>-](g|G|r|R)<group#(0-63)>[c|r<cadence#>|d][/extension[/options]]
\endverbatim
*
* The modified dialstring will have prefixed the channel-group section
* with the ISDN channel restriction.
*
* buf:
* DAHDI/i<span>-(g|G|r|R)<group#(0-63)>[c|r<cadence#>|d][/extension[/options]]
* \verbatim
DAHDI/i<span>-(g|G|r|R)<group#(0-63)>[c|r<cadence#>|d][/extension[/options]]
\endverbatim
*
* The routine will check to see if the ISDN channel restriction is already
* in the original dialstring.
@ -3150,6 +3154,7 @@ static struct sig_ss7_linkset *my_ss7_find_linkset(struct ss7 *ss7)
* \param law Companding law to use.
* \param exten Dialplan extension for incoming call.
* \param requestor Channel requesting this new channel.
* \param assignedids
*
* \retval ast_channel on success.
* \retval NULL on error.

2
channels/iax2/include/firmware.h
View File

@ -38,8 +38,6 @@ void iax_firmware_reload(void);
/*!
* \internal
* \brief Unload all of the currently loaded firmware.
*
* return Nothing
*/
void iax_firmware_unload(void);

151
channels/sig_pri.c
View File

@ -300,8 +300,6 @@ static void sig_pri_dial_digits(struct sig_pri_chan *p, const char *dial_string)
*
* \param pri PRI span control structure.
*
* \return Nothing
*
* \note Assumes the pri->lock is already obtained.
*/
static void sig_pri_span_devstate_changed(struct sig_pri_span *pri)
@ -317,8 +315,6 @@ static void sig_pri_span_devstate_changed(struct sig_pri_span *pri)
* \since 1.8
*
* \param p sig_pri channel structure.
*
* \return Nothing
*/
static void sig_pri_set_caller_id(struct sig_pri_chan *p)
{
@ -361,8 +357,6 @@ static void sig_pri_set_caller_id(struct sig_pri_chan *p)
*
* \param p sig_pri channel structure.
* \param dnid Dialed Number Identifier string.
*
* \return Nothing
*/
static void sig_pri_set_dnid(struct sig_pri_chan *p, const char *dnid)
{
@ -378,8 +372,6 @@ static void sig_pri_set_dnid(struct sig_pri_chan *p, const char *dnid)
*
* \param p sig_pri channel structure.
* \param rdnis Redirecting Directory Number Information Service (RDNIS) string.
*
* \return Nothing
*/
static void sig_pri_set_rdnis(struct sig_pri_chan *p, const char *rdnis)
{
@ -715,9 +707,6 @@ static int ast_to_pri_char_set(enum AST_PARTY_CHAR_SET ast_char_set)
*
* \param ast_subaddress Asterisk party subaddress structure.
* \param pri_subaddress PRI party subaddress structure.
*
* \return Nothing
*
*/
static void sig_pri_set_subaddress(struct ast_party_subaddress *ast_subaddress, const struct pri_party_subaddress *pri_subaddress)
{
@ -838,8 +827,6 @@ static int ast_pri_pack_hex_string(unsigned char *dst, char *src, int maxlen)
* \param pri_subaddress PRI party subaddress structure.
* \param ast_subaddress Asterisk party subaddress structure.
*
* \return Nothing
*
* \note Assumes that pri_subaddress has been previously memset to zero.
*/
static void sig_pri_party_subaddress_from_ast(struct pri_party_subaddress *pri_subaddress, const struct ast_party_subaddress *ast_subaddress)
@ -884,8 +871,6 @@ static void sig_pri_party_subaddress_from_ast(struct pri_party_subaddress *pri_s
* \param pri_name PRI party name structure.
* \param ast_name Asterisk party name structure.
*
* \return Nothing
*
* \note Assumes that pri_name has been previously memset to zero.
*/
static void sig_pri_party_name_from_ast(struct pri_party_name *pri_name, const struct ast_party_name *ast_name)
@ -909,8 +894,6 @@ static void sig_pri_party_name_from_ast(struct pri_party_name *pri_name, const s
* \param pri_number PRI party number structure.
* \param ast_number Asterisk party number structure.
*
* \return Nothing
*
* \note Assumes that pri_number has been previously memset to zero.
*/
static void sig_pri_party_number_from_ast(struct pri_party_number *pri_number, const struct ast_party_number *ast_number)
@ -934,8 +917,6 @@ static void sig_pri_party_number_from_ast(struct pri_party_number *pri_number, c
* \param pri_id PRI party id structure.
* \param ast_id Asterisk party id structure.
*
* \return Nothing
*
* \note Assumes that pri_id has been previously memset to zero.
*/
static void sig_pri_party_id_from_ast(struct pri_party_id *pri_id, const struct ast_party_id *ast_id)
@ -955,8 +936,6 @@ static void sig_pri_party_id_from_ast(struct pri_party_id *pri_id, const struct
* \param pvt sig_pri private channel structure.
* \param ast Asterisk channel
*
* \return Nothing
*
* \note Assumes that the PRI lock is already obtained.
*/
static void sig_pri_redirecting_update(struct sig_pri_chan *pvt, struct ast_channel *ast)
@ -985,8 +964,6 @@ static void sig_pri_redirecting_update(struct sig_pri_chan *pvt, struct ast_chan
* \since 1.8
*
* \param p sig_pri channel structure.
*
* \return Nothing
*/
static void sig_pri_dsp_reset_and_flush_digits(struct sig_pri_chan *p)
{
@ -1060,8 +1037,6 @@ static struct ast_channel *sig_pri_new_ast_channel(struct sig_pri_chan *p, int s
* \since 1.8
*
* \param p Channel private control structure.
*
* \return Nothing
*/
static void sig_pri_open_media(struct sig_pri_chan *p)
{
@ -1082,8 +1057,6 @@ static void sig_pri_open_media(struct sig_pri_chan *p)
* \param p Channel private control structure.
*
* \note Assumes the private and owner are locked.
*
* \return Nothing
*/
static void sig_pri_ami_channel_event(struct sig_pri_chan *p)
{
@ -1262,8 +1235,6 @@ int sig_pri_is_chan_available(struct sig_pri_chan *pvt)
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_pri_lock_owner(struct sig_pri_span *pri, int chanpos)
{
@ -1295,8 +1266,6 @@ static void sig_pri_lock_owner(struct sig_pri_span *pri, int chanpos)
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void pri_queue_frame(struct sig_pri_span *pri, int chanpos, struct ast_frame *frame)
{
@ -1317,8 +1286,6 @@ static void pri_queue_frame(struct sig_pri_span *pri, int chanpos, struct ast_fr
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_pri_queue_hold(struct sig_pri_span *pri, int chanpos)
{
@ -1339,8 +1306,6 @@ static void sig_pri_queue_hold(struct sig_pri_span *pri, int chanpos)
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_pri_queue_unhold(struct sig_pri_span *pri, int chanpos)
{
@ -1362,8 +1327,6 @@ static void sig_pri_queue_unhold(struct sig_pri_span *pri, int chanpos)
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void pri_queue_control(struct sig_pri_span *pri, int chanpos, int subclass)
{
@ -1390,8 +1353,6 @@ static void pri_queue_control(struct sig_pri_span *pri, int chanpos, int subclas
* \note The unlocking/locking sequence now present has been stress tested
* without deadlocks. Please don't change it without consulting
* core development team members.
*
* \return Nothing
*/
static void sig_pri_queue_hangup(struct sig_pri_span *pri, int chanpos)
{
@ -1427,11 +1388,10 @@ static void sig_pri_queue_hangup(struct sig_pri_span *pri, int chanpos)
* \param pri PRI span control structure.
* \param chanpos Channel position in the span.
* \param cause String describing the cause to be placed into the frame.
* \param ast_cause
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void pri_queue_pvt_cause_data(struct sig_pri_span *pri, int chanpos, const char *cause, int ast_cause)
{
@ -1493,8 +1453,6 @@ static int pri_find_principle_by_call(struct sig_pri_span *pri, q931_call *call)
* Asks the channel driver to queue the span for destruction at a
* possibly later time, if (e.g.) locking considerations don't allow
* destroying it right now.
*
* \return Nothing
*/
static void pri_destroy_later(struct sig_pri_span *pri)
{
@ -1514,8 +1472,6 @@ static void pri_destroy_later(struct sig_pri_span *pri)
* \param cause Reason call was killed.
*
* \note Assumes the pvt->pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_kill_call(struct sig_pri_span *pri, q931_call *call, int cause)
{
@ -1850,8 +1806,6 @@ static char *dialplan2str(int dialplan)
* \param pri PRI span control structure.
* \param number Number to apply numbering plan.
* \param plan Numbering plan to apply.
*
* \return Nothing
*/
static void apply_plan_to_number(char *buf, size_t size, const struct sig_pri_span *pri, const char *number, int plan)
{
@ -1886,8 +1840,6 @@ static void apply_plan_to_number(char *buf, size_t size, const struct sig_pri_sp
* \param pri PRI span control structure.
* \param number Number to apply numbering plan.
* \param plan Numbering plan to apply.
*
* \return Nothing
*/
static void apply_plan_to_existing_number(char *buf, size_t size, const struct sig_pri_span *pri, const char *number, int plan)
{
@ -1908,8 +1860,6 @@ static void apply_plan_to_existing_number(char *buf, size_t size, const struct s
* \param pri PRI span control structure.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void pri_check_restart(struct sig_pri_span *pri)
{
@ -1956,8 +1906,6 @@ static void pri_check_restart(struct sig_pri_span *pri)
* \param pri PRI span control structure.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_init_config(struct sig_pri_chan *pvt, struct sig_pri_span *pri)
{
@ -2270,8 +2218,6 @@ void pri_event_noalarm(struct sig_pri_span *pri, int index, int before_start_pri
*
* \note The filled in ast_name structure needs to be destroyed by
* ast_party_name_free() when it is no longer needed.
*
* \return Nothing
*/
static void sig_pri_party_name_convert(struct ast_party_name *ast_name, const struct pri_party_name *pri_name)
{
@ -2292,8 +2238,6 @@ static void sig_pri_party_name_convert(struct ast_party_name *ast_name, const st
*
* \note The filled in ast_number structure needs to be destroyed by
* ast_party_number_free() when it is no longer needed.
*
* \return Nothing
*/
static void sig_pri_party_number_convert(struct ast_party_number *ast_number, const struct pri_party_number *pri_number, struct sig_pri_span *pri)
{
@ -2318,8 +2262,6 @@ static void sig_pri_party_number_convert(struct ast_party_number *ast_number, co
*
* \note The filled in ast_id structure needs to be destroyed by
* ast_party_id_free() when it is no longer needed.
*
* \return Nothing
*/
static void sig_pri_party_id_convert(struct ast_party_id *ast_id, const struct pri_party_id *pri_id, struct sig_pri_span *pri)
{
@ -2348,8 +2290,6 @@ static void sig_pri_party_id_convert(struct ast_party_id *ast_id, const struct p
*
* \note The filled in ast_redirecting structure needs to be destroyed by
* ast_party_redirecting_free() when it is no longer needed.
*
* \return Nothing
*/
static void sig_pri_redirecting_convert(struct ast_party_redirecting *ast_redirecting,
const struct pri_party_redirecting *pri_redirecting,
@ -2473,8 +2413,6 @@ static void party_subaddress_json_to_ami(struct ast_str **msg, const char *prefi
* \param msg Event message string being built.
* \param prefix Prefix to add to the party id lines.
* \param party Party information to encode.
*
* \return Nothing
*/
static void party_json_to_ami(struct ast_str **msg, const char *prefix, struct ast_json *party)
{
@ -2554,8 +2492,6 @@ static void send_mcid(struct ast_channel *chan, struct ast_party_id *caller, str
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the owner channel lock is already obtained if still present.
*
* \return Nothing
*/
static void sig_pri_mcid_event(struct sig_pri_span *pri, const struct pri_subcmd_mcid_req *mcid, struct ast_channel *owner)
{
@ -2609,8 +2545,6 @@ struct xfer_rsp_data {
* \param is_successful TRUE if the transfer was successful.
*
* \note Assumes the rsp->pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_transfer_rsp(struct xfer_rsp_data *rsp, int is_successful)
{
@ -2879,8 +2813,6 @@ static struct sig_pri_cc_monitor_instance *sig_pri_find_cc_monitor_by_cc_id(stru
* \since 1.8
*
* \param data Monitor instance to destroy.
*
* \return Nothing
*/
static void sig_pri_cc_monitor_instance_destroy(void *data)
{
@ -3028,8 +2960,6 @@ static int sig_pri_cc_available(struct sig_pri_span *pri, int chanpos, long cc_i
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_pri_cc_generic_check(struct sig_pri_span *pri, int chanpos, enum ast_cc_service_type service)
{
@ -3125,8 +3055,6 @@ done:
* \param pri PRI span control structure.
* \param cc_id CC record ID.
* \param is_agent TRUE if the cc_id is for an agent.
*
* \return Nothing
*/
static void sig_pri_cc_link_canceled(struct sig_pri_span *pri, long cc_id, int is_agent)
{
@ -3359,8 +3287,6 @@ static enum ast_aoc_time_scale sig_pri_aoc_scale_to_ast(enum PRI_AOC_TIME_SCALE
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri private is locked
* \note Assumes the owner channel lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_aoc_s_from_pri(const struct pri_subcmd_aoc_s *aoc_s, struct ast_channel *owner, int passthrough)
{
@ -3447,13 +3373,11 @@ static void sig_pri_aoc_s_from_pri(const struct pri_subcmd_aoc_s *aoc_s, struct
* \brief Generate AOC Request Response
* \since 1.8
*
* \param aoc_request
* \param aoc_request, pvt, call
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri private is locked
* \note Assumes the owner channel lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_aoc_request_from_pri(const struct pri_subcmd_aoc_request *aoc_request, struct sig_pri_chan *pvt, q931_call *call)
{
@ -3516,15 +3440,13 @@ static void sig_pri_aoc_request_from_pri(const struct pri_subcmd_aoc_request *ao
* \brief Generate AOC-D AST_CONTROL_AOC frame
* \since 1.8
*
* \param aoc_e AOC-D event parameters.
* \param aoc_d AOC-D event parameters.
* \param owner Asterisk channel associated with the call.
* \param passthrough indicating if this message should be queued on the ast channel
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri private is locked
* \note Assumes the owner channel lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_aoc_d_from_pri(const struct pri_subcmd_aoc_d *aoc_d, struct ast_channel *owner, int passthrough)
{
@ -3632,8 +3554,6 @@ static void sig_pri_aoc_d_from_pri(const struct pri_subcmd_aoc_d *aoc_d, struct
* \note Assumes the sig_pri private is locked
* \note Assumes the owner channel lock is already obtained.
* \note owner channel may be NULL. In that case, generate event only
*
* \return Nothing
*/
static void sig_pri_aoc_e_from_pri(const struct pri_subcmd_aoc_e *aoc_e, struct ast_channel *owner, int passthrough)
{
@ -3748,9 +3668,7 @@ static void sig_pri_aoc_e_from_pri(const struct pri_subcmd_aoc_e *aoc_e, struct
* \brief send an AOC-S message on the current call
*
* \param pvt sig_pri private channel structure.
* \param generic decoded ast AOC message
*
* \return Nothing
* \param decoded decoded ast AOC message
*
* \note Assumes that the PRI lock is already obtained.
*/
@ -3847,9 +3765,7 @@ static void sig_pri_aoc_s_from_ast(struct sig_pri_chan *pvt, struct ast_aoc_deco
* \brief send an AOC-D message on the current call
*
* \param pvt sig_pri private channel structure.
* \param generic decoded ast AOC message
*
* \return Nothing
* \param decoded decoded ast AOC message
*
* \note Assumes that the PRI lock is already obtained.
*/
@ -3930,9 +3846,7 @@ static void sig_pri_aoc_d_from_ast(struct sig_pri_chan *pvt, struct ast_aoc_deco
* \brief send an AOC-E message on the current call
*
* \param pvt sig_pri private channel structure.
* \param generic decoded ast AOC message
*
* \return Nothing
* \param decoded decoded ast AOC message
*
* \note Assumes that the PRI lock is already obtained.
*/
@ -4050,8 +3964,6 @@ static void sig_pri_aoc_e_from_ast(struct sig_pri_chan *pvt, struct ast_aoc_deco
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_pri_send_aoce_termination_request(struct sig_pri_span *pri, int chanpos, unsigned int ms)
{
@ -4127,8 +4039,6 @@ static int sig_pri_is_cis_call(int channel)
* need to use the pointer to send a response message back.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_handle_cis_subcmds(struct sig_pri_span *pri, int event_id,
const struct pri_subcommands *subcmds, q931_call *call_rsp)
@ -4344,8 +4254,6 @@ static void sig_pri_handle_cis_subcmds(struct sig_pri_span *pri, int event_id,
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_pri_handle_subcmds(struct sig_pri_span *pri, int chanpos, int event_id,
const struct pri_subcommands *subcmds, q931_call *call_rsp)
@ -5329,8 +5237,6 @@ static const sig_pri_moh_fsm_state sig_pri_moh_fsm[SIG_PRI_MOH_STATE_NUM] = {
*
* \note Assumes the pvt->pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pvt) is already obtained.
*
* \return Nothing
*/
static void sig_pri_moh_fsm_event(struct ast_channel *chan, struct sig_pri_chan *pvt, enum sig_pri_moh_event event)
{
@ -5507,8 +5413,6 @@ done_with_private:;
* \param ev Hold acknowledge event received.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_handle_hold_ack(struct sig_pri_span *pri, pri_event *ev)
{
@ -5560,8 +5464,6 @@ static void sig_pri_handle_hold_ack(struct sig_pri_span *pri, pri_event *ev)
* \param ev Hold reject event received.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_handle_hold_rej(struct sig_pri_span *pri, pri_event *ev)
{
@ -5609,8 +5511,6 @@ static void sig_pri_handle_hold_rej(struct sig_pri_span *pri, pri_event *ev)
* \param ev Retrieve event received.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_handle_retrieve(struct sig_pri_span *pri, pri_event *ev)
{
@ -5683,8 +5583,6 @@ static void sig_pri_handle_retrieve(struct sig_pri_span *pri, pri_event *ev)
* \param ev Retrieve acknowledge event received.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_handle_retrieve_ack(struct sig_pri_span *pri, pri_event *ev)
{
@ -5723,8 +5621,6 @@ static void sig_pri_handle_retrieve_ack(struct sig_pri_span *pri, pri_event *ev)
* \param ev Retrieve reject event received.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_handle_retrieve_rej(struct sig_pri_span *pri, pri_event *ev)
{
@ -5773,8 +5669,6 @@ static void sig_pri_handle_retrieve_rej(struct sig_pri_span *pri, pri_event *ev)
*
* \note Assumes the pri->lock is already obtained.
* \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void setup_incoming_channel(struct sig_pri_span *pri, int chanpos, pri_event *ev)
{
@ -5867,8 +5761,6 @@ static void setup_incoming_channel(struct sig_pri_span *pri, int chanpos, pri_ev
* \param e SETUP event received.
*
* \note Assumes the pri->lock is already obtained.
*
* \return Nothing
*/
static void sig_pri_handle_setup(struct sig_pri_span *pri, pri_event *e)
{
@ -7794,12 +7686,10 @@ int sig_pri_hangup(struct sig_pri_chan *p, struct ast_channel *ast)
*
* \param p sig_pri channel structure.
* \param rdest Dial string buffer to extract called number and subaddress.
* \param called Buffer to fill with extracted <number>[:<subaddress>]
* \param called Buffer to fill with extracted \<number\>[:\<subaddress\>]
* \param called_buff_size Size of buffer to fill.
*
* \note Parsing must remain in sync with sig_pri_call().
*
* \return Nothing
*/
void sig_pri_extract_called_num_subaddr(struct sig_pri_chan *p, const char *rdest, char *called, size_t called_buff_size)
{
@ -8832,8 +8722,6 @@ int sig_pri_digit_begin(struct sig_pri_chan *pvt, struct ast_channel *ast, char
* \param ast Asterisk channel
*
* \note Channel and private lock are already held.
*
* \return Nothing
*/
void sig_pri_dial_complete(struct sig_pri_chan *pvt, struct ast_channel *ast)
{
@ -8869,8 +8757,6 @@ void sig_pri_dial_complete(struct sig_pri_chan *pvt, struct ast_channel *ast)
* \param vm_box Voicemail mailbox number
* \param mbox_id Mailbox id
* \param num_messages Number of messages waiting.
*
* \return Nothing
*/
static void sig_pri_send_mwi_indication(struct sig_pri_span *pri, const char *vm_number, const char *vm_box, const char *mbox_id, int num_messages)
{
@ -8913,10 +8799,7 @@ static void sig_pri_send_mwi_indication(struct sig_pri_span *pri, const char *vm
*
* \param userdata the data provider in the call to stasis_subscribe()
* \param sub the subscription to which the message was delivered for this callback
* \param topic the topic on which the message was published
* \param msg the message being passed to the subscriber
*
* \return Nothing
*/
static void sig_pri_mwi_event_cb(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg)
{
@ -8953,8 +8836,6 @@ static void sig_pri_mwi_event_cb(void *userdata, struct stasis_subscription *sub
* \since 1.8
*
* \param pri PRI span control structure.
*
* \return Nothing
*/
static void sig_pri_mwi_cache_update(struct sig_pri_span *pri)
{
@ -8987,8 +8868,6 @@ static void sig_pri_mwi_cache_update(struct sig_pri_span *pri)
* \since 1.8
*
* \param pri PRI span control structure.
*
* \return Nothing
*/
void sig_pri_stop_pri(struct sig_pri_span *pri)
{
@ -9047,8 +8926,6 @@ static int sig_pri_cmp_pri_chans(const void *left, const void *right)
* \details
* Since the chan_dahdi.conf file can declare channels in any order, we need to sort
* the private channel pointer array.
*
* \return Nothing
*/
static void sig_pri_sort_pri_chans(struct sig_pri_span *pri)
{
@ -9282,8 +9159,6 @@ int sig_pri_start_pri(struct sig_pri_span *pri)
* \param noalarm Non-zero if not in alarm mode.
*
* \note Assumes the sig_pri_lock_private(p) is already obtained.
*
* \return Nothing
*/
void sig_pri_chan_alarm_notify(struct sig_pri_chan *p, int noalarm)
{
@ -9307,7 +9182,7 @@ void sig_pri_chan_alarm_notify(struct sig_pri_chan *p, int noalarm)
/*!
* \brief Determine if layer 1 alarms are ignored.
*
* \param p Channel private pointer.
* \param pri Channel private pointer.
*
* \return TRUE if the alarm is ignored.
*/
@ -9340,8 +9215,6 @@ struct sig_pri_chan *sig_pri_chan_new(void *pvt_data, struct sig_pri_span *pri,
* \since 1.8
*
* \param doomed sig_pri private channel structure to delete.
*
* \return Nothing
*/
void sig_pri_chan_delete(struct sig_pri_chan *doomed)
{
@ -9514,8 +9387,6 @@ void sig_pri_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, str
*
* \param p Channel to send text over
* \param text Text to send.
*
* \return Nothing
*/
void sig_pri_sendtext(struct sig_pri_chan *p, const char *text)
{
@ -9639,8 +9510,6 @@ int sig_pri_cc_agent_stop_offer_timer(struct ast_cc_agent *agent)
* The duty of this is to issue a propper response to a
* CC request from the caller by acknowledging receipt
* of that request or rejecting it.
*
* \return Nothing
*/
void sig_pri_cc_agent_req_rsp(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason)
{
@ -9863,8 +9732,6 @@ int sig_pri_cc_agent_callee_available(struct ast_cc_agent *agent)
* \note
* The agent private_data pointer may be NULL if the agent
* constructor failed.
*
* \return Nothing
*/
void sig_pri_cc_agent_destructor(struct ast_cc_agent *agent)
{
@ -10159,8 +10026,6 @@ int sig_pri_load(const char *cc_type_name)
/*!
* \brief Unload the sig_pri submodule.
* \since 1.8
*
* \return Nothing
*/
void sig_pri_unload(void)
{

4
channels/sig_pri.h
View File

@ -222,8 +222,6 @@ struct sig_pri_callback {
*
* \param pvt Private structure of the user of this module.
* \param chan Channel associated with the private pointer
*
* \return Nothing
*/
void (* const ami_channel_event)(void *pvt, struct ast_channel *chan);
@ -639,7 +637,7 @@ struct sig_pri_span {
* the configured threshold.
* AST_DEVICE_UNAVAILABLE - Span is in alarm.
* \note
* Device name: DAHDI/I<span>/threshold
* Device name: \verbatim DAHDI/I<span>/threshold \endverbatim
*/
int threshold_devstate;
/*!

62
channels/sig_ss7.c
View File

@ -171,8 +171,6 @@ static void sig_ss7_set_remotelyblocked(struct sig_ss7_chan *p, int is_blocked,
* \since 1.8.12
*
* \param p Channel private control structure.
*
* \return Nothing
*/
static void sig_ss7_open_media(struct sig_ss7_chan *p)
{
@ -187,8 +185,6 @@ static void sig_ss7_open_media(struct sig_ss7_chan *p)
* \since 1.8
*
* \param p sig_ss7 channel structure.
*
* \return Nothing
*/
static void sig_ss7_set_caller_id(struct sig_ss7_chan *p)
{
@ -230,8 +226,6 @@ static void sig_ss7_set_caller_id(struct sig_ss7_chan *p)
*
* \param p sig_ss7 channel structure.
* \param dnid Dialed Number Identifier string.
*
* \return Nothing
*/
static void sig_ss7_set_dnid(struct sig_ss7_chan *p, const char *dnid)
{
@ -327,7 +321,7 @@ static struct sig_ss7_linkset *sig_ss7_find_linkset(struct ss7 *ss7)
*
* \param pvt Channel to determine if available.
*
* \return TRUE if the channel is available.
* \retval TRUE if the channel is available.
*/
static int sig_ss7_is_chan_available(struct sig_ss7_chan *pvt)
{
@ -349,8 +343,6 @@ static int sig_ss7_is_chan_available(struct sig_ss7_chan *pvt)
*
* \note Assumes the ss7->lock is already obtained.
* \note Assumes the sig_ss7_lock_private(ss7->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_ss7_lock_owner(struct sig_ss7_linkset *ss7, int chanpos)
{
@ -382,8 +374,6 @@ static void sig_ss7_lock_owner(struct sig_ss7_linkset *ss7, int chanpos)
*
* \note Assumes the ss7->lock is already obtained.
* \note Assumes the sig_ss7_lock_private(ss7->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_ss7_queue_frame(struct sig_ss7_linkset *ss7, int chanpos, struct ast_frame *frame)
{
@ -405,8 +395,6 @@ static void sig_ss7_queue_frame(struct sig_ss7_linkset *ss7, int chanpos, struct
*
* \note Assumes the ss7->lock is already obtained.
* \note Assumes the sig_ss7_lock_private(ss7->pvts[chanpos]) is already obtained.
*
* \return Nothing
*/
static void sig_ss7_queue_control(struct sig_ss7_linkset *ss7, int chanpos, int subclass)
{
@ -428,12 +416,11 @@ static void sig_ss7_queue_control(struct sig_ss7_linkset *ss7, int chanpos, int
*
* \param owner Owner channel of the pvt.
* \param cause String describing the cause to be placed into the frame.
* \param ast_cause
*
* \note Assumes the linkset->lock is already obtained.
* \note Assumes the sig_ss7_lock_private(linkset->pvts[chanpos]) is already obtained.
* \note Assumes linkset->pvts[chanpos]->owner is non-NULL and its lock is already obtained.
*
* \return Nothing
*/
static void ss7_queue_pvt_cause_data(struct ast_channel *owner, const char *cause, int ast_cause)
{
@ -457,7 +444,7 @@ static void ss7_queue_pvt_cause_data(struct ast_channel *owner, const char *caus
* \param cic Circuit Identification Code
* \param dpc Destination Point Code
*
* \retval chanpos on success.
* \return chanpos on success.
* \retval -1 on error.
*/
int sig_ss7_find_cic(struct sig_ss7_linkset *linkset, int cic, unsigned int dpc)
@ -482,7 +469,7 @@ int sig_ss7_find_cic(struct sig_ss7_linkset *linkset, int cic, unsigned int dpc)
* \param dpc Destination Point Code
* \param msg_name Message type name that failed.
*
* \retval chanpos on success.
* \return chanpos on success.
* \retval -1 on error.
*/
static int ss7_find_cic_gripe(struct sig_ss7_linkset *linkset, int cic, unsigned int dpc, const char *msg_name)
@ -583,8 +570,6 @@ void sig_ss7_cb_notinservice(struct ss7 *ss7, int cic, unsigned int dpc)
* \param endcic Circuit Identification Code to search up-to
* \param dpc Destination Point Code
* \param state Array containing the status of the search
*
* \retval Nothing.
*/
static void ss7_check_range(struct sig_ss7_linkset *linkset, int startcic, int endcic, unsigned int dpc, unsigned char *state)
{
@ -618,7 +603,7 @@ static int ss7_match_range(struct sig_ss7_chan *pvt, int startcic, int endcic, u
*
* \note Assumes the linkset->lock is already obtained.
*
* \return TRUE if all CICs in the range are present
* \retval TRUE if all CICs in the range are present
*/
int sig_ss7_find_cic_range(struct sig_ss7_linkset *linkset, int startcic, int endcic, unsigned int dpc)
{
@ -720,8 +705,6 @@ static inline void ss7_hangup_cics(struct sig_ss7_linkset *linkset, int startcic
*
* \note Assumes the linkset->lock is already obtained.
* \note Must be called without sig_ss7_lock_private() obtained.
*
* \return Nothing.
*/
static inline void ss7_block_cics(struct sig_ss7_linkset *linkset, int startcic, int endcic, unsigned int dpc, unsigned char state[], int block, int remotely, int type)
{
@ -767,8 +750,6 @@ static inline void ss7_block_cics(struct sig_ss7_linkset *linkset, int startcic,
* \param dpc Destination Point Code.
*
* \note Must be called without sig_ss7_lock_private() obtained.
*
* \return Nothing.
*/
static void ss7_inservice(struct sig_ss7_linkset *linkset, int startcic, int endcic, unsigned int dpc)
{
@ -859,8 +840,6 @@ static void ss7_reset_linkset(struct sig_ss7_linkset *linkset)
*
* \note Assumes the ss7->lock is already obtained.
* \note Assumes sig_ss7_lock_private(p) is already obtained.
*
* \return Nothing.
*/
static void ss7_do_rsc(struct sig_ss7_chan *p)
{
@ -882,13 +861,13 @@ static void ss7_do_rsc(struct sig_ss7_chan *p)
* \brief Start RSC procedure on a specific link
* \since 11.0
*
* \param ss7 SS7 linkset control structure.
* \param linkset SS7 linkset control structure.
* \param which Channel position in the span.
*
* \note Assumes the ss7->lock is already obtained.
* \note Assumes the sig_ss7_lock_private(ss7->pvts[chanpos]) is already obtained.
*
* \return TRUE on success
* \retval TRUE on success
*/
static int ss7_start_rsc(struct sig_ss7_linkset *linkset, int which)
{
@ -930,8 +909,6 @@ static int ss7_start_rsc(struct sig_ss7_linkset *linkset, int which)
*
* \note Assumes the linkset->lock is already obtained.
* \note Must be called without sig_ss7_lock_private() obtained.
*
* \return Nothing.
*/
static void ss7_clear_channels(struct sig_ss7_linkset *linkset, int startcic, int endcic, int dpc, int do_hangup)
{
@ -966,8 +943,6 @@ static void ss7_clear_channels(struct sig_ss7_linkset *linkset, int startcic, in
*
* \note Assumes the linkset->lock is already obtained.
* \note Assumes the sig_ss7_lock_private(ss7->pvts[chanpos]) is already obtained.
*
* \return Nothing.
*/
static void ss7_start_call(struct sig_ss7_chan *p, struct sig_ss7_linkset *linkset)
{
@ -1346,8 +1321,6 @@ static ast_callid func_ss7_linkset_callid(struct sig_ss7_linkset *linkset, int c
*
* \note Assumes the linkset->lock is already obtained.
* \note Assumes the sig_ss7_lock_private(ss7->pvts[chanpos]) is already obtained.
*
* \return Nothing.
*/
static void ss7_match_extension(struct sig_ss7_linkset *linkset, struct sig_ss7_chan *p, ss7_event *e)
{
@ -2378,7 +2351,7 @@ static void ss7_grab(struct sig_ss7_chan *pvt, struct sig_ss7_linkset *ss7)
* \param cic Circuit Identification Code
* \param dpc Destination Point Code
*
* \return TRUE on success
* \retval TRUE on success
*/
int sig_ss7_reset_cic(struct sig_ss7_linkset *linkset, int cic, unsigned int dpc)
{
@ -2410,7 +2383,7 @@ int sig_ss7_reset_cic(struct sig_ss7_linkset *linkset, int cic, unsigned int dpc
* \param do_block Action to perform. Block if TRUE.
* \param which On which CIC to perform the operation.
*
* \return 0 on success
* \retval 0 on success
*/
int sig_ss7_cic_blocking(struct sig_ss7_linkset *linkset, int do_block, int which)
{
@ -2447,7 +2420,7 @@ int sig_ss7_cic_blocking(struct sig_ss7_linkset *linkset, int do_block, int whic
*
* \note Assumes the linkset->lock is already obtained.
*
* \return 0 on success
* \retval 0 on success
*/
int sig_ss7_group_blocking(struct sig_ss7_linkset *linkset, int do_block, int chanpos, int endcic, unsigned char state[], int type)
{
@ -2478,7 +2451,7 @@ int sig_ss7_group_blocking(struct sig_ss7_linkset *linkset, int do_block, int ch
*
* \note Assumes the linkset->lock is already obtained.
*
* \return 0 on success
* \retval 0 on success
*/
int sig_ss7_reset_group(struct sig_ss7_linkset *linkset, int cic, unsigned int dpc, int range)
{
@ -2547,8 +2520,6 @@ static int ss7_parse_prefix(struct sig_ss7_chan *p, const char *number, char *na
*
* \param linkset Controlling linkset for the channel.
* \param which Link index of the signaling channel.
*
* \return Nothing
*/
void sig_ss7_link_alarm(struct sig_ss7_linkset *linkset, int which)
{
@ -2563,8 +2534,6 @@ void sig_ss7_link_alarm(struct sig_ss7_linkset *linkset, int which)
*
* \param linkset Controlling linkset for the channel.
* \param which Link index of the signaling channel.
*
* \return Nothing
*/
void sig_ss7_link_noalarm(struct sig_ss7_linkset *linkset, int which)
{
@ -2585,6 +2554,7 @@ void sig_ss7_link_noalarm(struct sig_ss7_linkset *linkset, int which)
* \param networkindicator User configuration parameter.
* \param pointcode User configuration parameter.
* \param adjpointcode User configuration parameter.
* \param cur_slc
*
* \retval 0 on success.
* \retval -1 on error.
@ -3121,8 +3091,6 @@ int sig_ss7_answer(struct sig_ss7_chan *p, struct ast_channel *ast)
* \param oldchan Old channel pointer to replace.
* \param newchan New channel pointer to set.
* \param pchan Signaling private structure pointer.
*
* \return Nothing
*/
void sig_ss7_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_ss7_chan *pchan)
{
@ -3268,7 +3236,7 @@ int sig_ss7_indicate(struct sig_ss7_chan *p, struct ast_channel *chan, int condi
* \param p Signaling private structure pointer.
* \param law Companding law preferred
* \param requestor Asterisk channel requesting a channel to dial (Can be NULL)
* \param transfercapability
* \param assignedids, transfercapability
*
* \retval ast_channel on success.
* \retval NULL on error.
@ -3306,8 +3274,6 @@ struct ast_channel *sig_ss7_request(struct sig_ss7_chan *p, enum sig_ss7_law law
* \since 1.8
*
* \param doomed sig_ss7 private channel structure to delete.
*
* \return Nothing
*/
void sig_ss7_chan_delete(struct sig_ss7_chan *doomed)
{
@ -3389,8 +3355,6 @@ struct sig_ss7_chan *sig_ss7_chan_new(void *pvt_data, struct sig_ss7_linkset *ss
* \since 1.8
*
* \param ss7 SS7 linkset control structure.
*
* \return Nothing
*/
void sig_ss7_init_linkset(struct sig_ss7_linkset *ss7)
{

2
funcs/func_odbc.c
View File

@ -143,7 +143,7 @@ struct odbc_datastore {
char names[0];
};
/* \brief Data source name
/*! \brief Data source name
*
* This holds data that pertains to a DSN
*/

2
include/asterisk/calendar.h
View File

@ -91,7 +91,7 @@ struct ast_calendar_attendee {
AST_LIST_ENTRY(ast_calendar_attendee) next;
};
/* \brief Calendar events */
/*! \brief Calendar events */
struct ast_calendar_event {
AST_DECLARE_STRING_FIELDS(
AST_STRING_FIELD(summary);

10
include/asterisk/channel.h
View File

@ -1427,7 +1427,7 @@ void ast_change_name(struct ast_channel *chan, const char *newname);
* This function will unlink the channel from the global channels container
* if it is still there and also release the current reference to the channel.
*
* \retval NULL, convenient for clearing invalid pointers
* \retval NULL convenient for clearing invalid pointers
* \note Absolutely _NO_ channel locks should be held before calling this function.
*
* \since 1.8
@ -1738,7 +1738,9 @@ void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int cause
* \brief Compare a offset with the settings of when to hang a channel up
* \param chan channel on which to check for hangup
* \param offset offset in seconds and microseconds from current time
* \return 1, 0, or -1
* \retval 1
* \retval 0
* \retval -1
* This function compares a offset from current time with the absolute time
* out on a channel (when to hang up). If the absolute time out on a channel
* is earlier than current time plus the offset, it returns 1, if the two
@ -2952,7 +2954,7 @@ struct ast_channel_iterator;
* This function is used to destroy a channel iterator that was retrieved by
* using one of the channel_iterator_xxx_new() functions.
*
* \return NULL, for convenience to clear out the pointer to the iterator that
* \retval NULL for convenience to clear out the pointer to the iterator that
* was just destroyed.
*
* \since 1.8
@ -3029,7 +3031,7 @@ struct ast_channel_iterator *ast_channel_iterator_all_new(void);
*
* \retval the next channel that matches the parameters used when the iterator
* was created.
* \retval NULL, if no more channels match the iterator parameters.
* \retval NULL if no more channels match the iterator parameters.
*
* \since 1.8
*/

2
include/asterisk/cli.h
View File

@ -371,7 +371,7 @@ char *ast_complete_channels(const char *line, const char *word, int pos, int sta
*/
void ast_cli_print_timestr_fromseconds(int fd, int seconds, const char *prefix);
/*
/*!
* \brief Allow a CLI command to be executed while Asterisk is shutting down.
*
* CLI commands by defeault are disabled when Asterisk is shutting down. This is

2
include/asterisk/config.h
View File

@ -1026,7 +1026,7 @@ enum config_hook_flags {
butt,
};
/*
/*!
* \brief Callback when configuration is updated
*
* \param cfg A copy of the configuration that is being changed.

4
include/asterisk/datastore.h
View File

@ -44,8 +44,6 @@ struct ast_datastore_info {
* It allows a datastore to fix any pointers it saved to the owning channel
* in case that the owning channel has changed. Generally, this would happen
* when the datastore is set to be inherited, and a masquerade occurs.
*
* \return nothing.
*/
void (*chan_fixup)(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan);
@ -58,8 +56,6 @@ struct ast_datastore_info {
*
* This is the same as the above callback, except it is called for the channel
* being masqueraded into instead of the channel that is masquerading.
*
* \return nothing.
*/
void (*chan_breakdown)(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan);
};

2
include/asterisk/http_websocket.h
View File

@ -122,7 +122,7 @@ struct ast_websocket_protocol {
unsigned int version;
/*! \brief Callback called when a new session is attempted. Optional. */
ast_websocket_pre_callback session_attempted;
/* \brief Callback called when a new session is established. Mandatory. */
/*! \brief Callback called when a new session is established. Mandatory. */
ast_websocket_callback session_established;
};

24
include/asterisk/logger.h
View File

@ -671,8 +671,7 @@ void __attribute__((format (printf, 6, 7))) __ast_trace(const char *file, int li
*
* \param level The trace level
* \param indent_type One of the \ref ast_trace_indent_type values
* \param (optional) A printf style format string
* \param (optional) Arguments
* \param ... A printf style format string, optionally with arguments
*
*/
#define ast_trace_raw(level, indent_type, ...) \
@ -685,8 +684,7 @@ void __attribute__((format (printf, 6, 7))) __ast_trace(const char *file, int li
* \brief Print a basic trace message
*
* \param level The trace level
* \param (optional) A printf style format string
* \param (optional) Arguments
* \param ... A printf style format string, optionally with arguments
*
* This will print the file, line and function at the current indent level
*/
@ -732,8 +730,7 @@ unsigned long _ast_trace_dec_indent(void);
* \brief Print a trace message with details when a scope is entered or existed.
*
* \param level The trace level
* \param (optional) A printf style format string
* \param (optional) Arguments
* \param ... A printf style format string, optionally with arguments
*
* This will print the file, line and function plus details at the current indent level.
* \note Like RAII_VAR, this macro must be called before any code in the scope.
@ -775,8 +772,7 @@ unsigned long _ast_trace_dec_indent(void);
* \brief Scope Enter
*
* \param level The trace level
* \param (optional) A printf style format string
* \param (optional) Arguments
* \param ... A printf style format string, optionally with arguments
*/
#define SCOPE_ENTER(level, ...) \
int __scope_level = level; \
@ -797,8 +793,7 @@ unsigned long _ast_trace_dec_indent(void);
/*!
* \brief Scope Exit
*
* \param (optional) A printf style format string
* \param (optional) Arguments
* \param ... A printf style format string, optionally with arguments
*
* \details
* This macro can be used at the exit points of a statement block since it just prints the message.
@ -816,8 +811,7 @@ unsigned long _ast_trace_dec_indent(void);
* \brief Scope Exit with expression
*
* \param __expr An expression to execute after printing the message
* \param (optional) A printf style format string
* \param (optional) Arguments
* \param ... A printf style format string, optionally with arguments
*
* \details
* Handy for getting out of or continuing loops.
@ -846,8 +840,7 @@ unsigned long _ast_trace_dec_indent(void);
/*!
* \brief Scope Exit with return
*
* \param (optional) A printf style format string
* \param (optional) Arguments
* \param ... A printf style format string, optionally with arguments
*
* \details
* This macro can be used at the exit points of a function when no value
@ -867,8 +860,7 @@ unsigned long _ast_trace_dec_indent(void);
* \brief Scope Exit with return value
*
* \param __return_value The return value
* \param (optional) A printf style format string
* \param (optional) Arguments
* \param ... A printf style format string, optionally with arguments
*
* \details
* This macro can be used at the exit points of a function when a value

1
include/asterisk/netsock2.h
View File

@ -820,7 +820,6 @@ static inline int _ast_addressfamily_to_sockaddrsize(int af, const char *file, i
*
* \param[out] addr The address of the ast_sockaddr to store into
* \param sa The sockaddr structure (sockaddr_in or sockaddr_in6) to convert
* \return Nothing
*/
#define ast_sockaddr_from_sockaddr(addr,sa) ast_sockaddr_copy_sockaddr(addr, sa, ast_addressfamily_to_sockaddrsize(((const struct sockaddr*)(sa))->sa_family))

2
include/asterisk/pbx.h
View File

@ -1026,7 +1026,7 @@ int ast_context_add_ignorepat(const char *context, const char *ignorepat, const
int ast_context_add_ignorepat2(struct ast_context *con, const char *ignorepat, const char *registrar);
/*
/*!
* \brief Remove an ignorepat
*
* \param context context from which to remove the pattern

2
include/asterisk/res_pjsip.h
View File

@ -3481,8 +3481,6 @@ int ast_sip_call_codec_str_to_pref(struct ast_flags *pref, const char *pref_str,
* \param data User data to know what to do when transport shuts down.
*
* \note The callback does not need to care that data is an ao2 object.
*
* \return Nothing
*/
typedef void (*ast_transport_monitor_shutdown_cb)(void *data);

2
include/asterisk/sorcery.h
View File

@ -321,7 +321,7 @@ struct ast_sorcery_wizard {
/*! \brief Callback for closing a wizard */
void (*close)(void *data);
/* \brief Callback for whether or not the wizard believes the object is stale */
/*! \brief Callback for whether or not the wizard believes the object is stale */
int (*is_stale)(const struct ast_sorcery *sorcery, void *data, void *object);
/*! \brief Optional callback for forcing a reload to occur, even if wizard has determined no changes */

2
include/asterisk/stasis.h
View File

@ -1051,8 +1051,6 @@ typedef struct stasis_message *(*cache_aggregate_calc_fn)(struct stasis_cache_en
* any remote entities publishing state for a device. e.g., An aggregate
* MWI message is the old/new MWI counts accumulated from the local and
* any remote entities publishing to a mailbox.
*
* \return Nothing
*/
typedef void (*cache_aggregate_publish_fn)(struct stasis_topic *topic, struct stasis_message *aggregate);

5
include/asterisk/stasis_app_impl.h
View File

@ -51,13 +51,10 @@ int stasis_app_exec(struct ast_channel *chan, const char *app_name, int argc,
/*!
* \brief Typedef for data destructor for stasis app commands
*
* \param data Data to destroy.
*
* \details
* This is called during destruction of the command or if we fail to schedule
* a command. It is passed a pointer to the user-defined data of the command.
*
* \return Nothing
* \param data Data to destroy.
*/
typedef void (*command_data_destructor_fn)(void *data);

10
include/asterisk/stasis_app_mailbox.h
View File

@ -49,15 +49,15 @@ enum stasis_mailbox_result {
* be set to the JSON representation of the mailbox
*
* \return stasis mailbox result code indicating success or failure and cause
* \return \c NULL on error.
* \retval NULL on error.
*/
enum stasis_mailbox_result stasis_app_mailbox_to_json(const char *name, struct ast_json **json);
/*!
* brief Convert mailboxes to json array
* \brief Convert mailboxes to json array
*
* \return JSON representation of the mailboxes
* \return \c NULL on error.
* \retval NULL on error.
*/
struct ast_json *stasis_app_mailboxes_to_json(void);
@ -70,8 +70,8 @@ struct ast_json *stasis_app_mailboxes_to_json(void);
* \param old_messages count of old (read) messages in the mailbox
* \param new_messages count of new (unread) messages in the mailbox
*
* \return 0 if successful
* \return -1 on internal error.
* \retval 0 if successful
* \retval -1 on internal error.
*/
int stasis_app_mailbox_update(
const char *name, int old_messages, int new_messages);

2
include/asterisk/tcptls.h
View File

@ -169,7 +169,7 @@ struct ast_tcptls_session_instance {
*/
struct ast_tcptls_session_instance *ast_tcptls_client_start(struct ast_tcptls_session_instance *tcptls_session);
/* \brief Creates a client connection's ast_tcptls_session_instance. */
/*! \brief Creates a client connection's ast_tcptls_session_instance. */
struct ast_tcptls_session_instance *ast_tcptls_client_create(struct ast_tcptls_session_args *desc);
void *ast_tcptls_server_root(void *);

30
include/asterisk/test.h
View File

@ -172,24 +172,17 @@ struct ast_json *ast_test_suite_get_blob(struct ast_test_suite_message_payload *
/*!
* \brief Notifies the test suite of a change in application state
*
* \details
* Raises a TestEvent manager event with a subtype of StateChange. Additional parameters
* The fmt parameter allows additional parameters to be added to the manager event using
* printf style statement formatting.
*
* \param state The state the application has changed to
* \param fmt The message with format parameters to add to the manager event
*
* \return Nothing
*/
void __ast_test_suite_event_notify(const char *file, const char *func, int line, const char *state, const char *fmt, ...)
__attribute__((format(printf, 5, 6)));
/*!
* \ref __ast_test_suite_event_notify()
* \param s The state the application has changed to
* \param f The message with format parameters to add to the manager event
*/
#define ast_test_suite_event_notify(s, f, ...) \
__ast_test_suite_event_notify(__FILE__, __PRETTY_FUNCTION__, __LINE__, (s), (f), ## __VA_ARGS__)
void __ast_test_suite_event_notify(const char *file, const char *func, int line, const char *state, const char *fmt, ...)
__attribute__((format(printf, 5, 6)));
#else
@ -292,7 +285,7 @@ typedef int (ast_test_cleanup_cb_t)(struct ast_test_info *info, struct ast_test
/*!
* \brief unregisters a test with the test framework
*
* \param test callback function (required)
* \param cb callback function (required)
*
* \retval 0 success
* \retval -1 failure
@ -302,7 +295,7 @@ int ast_test_unregister(ast_test_cb_t *cb);
/*!
* \brief registers a test with the test framework
*
* \param test callback function (required)
* \param cb callback function (required)
*
* \retval 0 success
* \retval -1 failure
@ -349,8 +342,6 @@ int ast_test_register_cleanup(const char *category, ast_test_cleanup_cb_t *cb);
*
* \param test Unit test control structure.
* \param fmt printf type format string.
*
* \return Nothing
*/
void ast_test_debug(struct ast_test *test, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
@ -368,19 +359,16 @@ void ast_test_set_result(struct ast_test *test, enum ast_test_result_state state
/*!
* \brief update test's status during testing.
*
* \param test currently executing test
* \param t currently executing test
* \param f printf type format string
*
* \retval 0 success
* \retval -1 failure
*/
#define ast_test_status_update(t, f, ...) __ast_test_status_update(__FILE__, __PRETTY_FUNCTION__, __LINE__, (t), (f), ## __VA_ARGS__)
int __ast_test_status_update(const char *file, const char *func, int line, struct ast_test *test, const char *fmt, ...)
__attribute__((format(printf, 5, 6)));
/*!
* \ref __ast_test_status_update()
*/
#define ast_test_status_update(t, f, ...) __ast_test_status_update(__FILE__, __PRETTY_FUNCTION__, __LINE__, (t), (f), ## __VA_ARGS__)
/*!
* \brief Check a test condition, failing the test if it's not true.
*

34
main/astmm.c
View File

@ -218,8 +218,6 @@ static void print_backtrace(struct ast_bt *bt, struct ast_cli_args *a)
* \internal
*
* \note If DO_CRASH is not defined then the function returns.
*
* \return Nothing
*/
static void my_do_crash(void)
{
@ -282,8 +280,6 @@ static void *__ast_alloc_region(size_t size, const enum func_type which, const c
* \brief Wipe the region payload data with a known value.
*
* \param reg Region block to be wiped.
*
* \return Nothing
*/
static void region_data_wipe(struct ast_region *reg)
{
@ -305,8 +301,6 @@ static void region_data_wipe(struct ast_region *reg)
* \brief Check the region payload data for memory corruption.
*
* \param reg Region block to be checked.
*
* \return Nothing
*/
static void region_data_check(struct ast_region *reg)
{
@ -334,8 +328,6 @@ static void region_data_check(struct ast_region *reg)
* \brief Flush the circular array of freed regions.
*
* \param freed Already freed region blocks storage.
*
* \return Nothing
*/
static void freed_regions_flush(struct ast_freed_regions *freed)
{
@ -361,8 +353,6 @@ static void freed_regions_flush(struct ast_freed_regions *freed)
*
* \param freed Already freed region blocks storage.
* \param reg Region block to be freed.
*
* \return Nothing
*/
static void region_free(struct ast_freed_regions *freed, struct ast_region *reg)
{
@ -393,7 +383,7 @@ static void region_free(struct ast_freed_regions *freed, struct ast_region *reg)
*
* \param ptr Region payload data pointer.
*
* \retval region on success.
* \return region on success.
* \retval NULL if not found.
*/
static struct ast_region *region_remove(void *ptr)
@ -426,8 +416,6 @@ static struct ast_region *region_remove(void *ptr)
* \brief Check the fences of a region.
*
* \param reg Region block to check.
*
* \return Nothing
*/
static void region_check_fences(struct ast_region *reg)
{
@ -457,8 +445,6 @@ static void region_check_fences(struct ast_region *reg)
/*!
* \internal
* \brief Check the fences of all regions currently allocated.
*
* \return Nothing
*/
static void regions_check_all_fences(void)
{
@ -808,8 +794,6 @@ static char *handle_memory_atexit_summary(struct ast_cli_entry *e, int cmd, stru
* \param selected_len Accumulated size of the selected allocations.
* \param cache_len Accumulated size of the allocations that are part of a cache.
* \param count Number of selected allocations.
*
* \return Nothing
*/
static void print_memory_show_common_stats(int fd,
unsigned int whales_len,
@ -1133,8 +1117,6 @@ static size_t mm_atexit_hash_list(struct region_list *list)
* \param list List to put into the allocated regions hash table.
*
* \note reglock must be locked before calling.
*
* \return Nothing
*/
static void mm_atexit_hash_restore(struct region_list *list)
{
@ -1205,8 +1187,6 @@ static int mm_atexit_cmp(struct ast_region *left, struct ast_region *right)
* \param list Merge sublists onto this list.
* \param sub1 First sublist to merge.
* \param sub2 Second sublist to merge.
*
* \return Nothing
*/
static void mm_atexit_list_merge(struct region_list *list, struct region_list *sub1, struct region_list *sub2)
{
@ -1242,8 +1222,6 @@ static void mm_atexit_list_merge(struct region_list *list, struct region_list *s
* \param num_lists Number of lists to remove from the source list.
* \param size Size of the sublists to remove.
* \param remaining Remaining number of elements on the source list.
*
* \return Nothing
*/
static void mm_atexit_list_split(struct region_list *list, struct region_list sub[], size_t num_lists, size_t size, size_t *remaining)
{
@ -1276,8 +1254,6 @@ static void mm_atexit_list_split(struct region_list *list, struct region_list su
*
* \param list Allocated regions list to sort.
* \param length Length of the list.
*
* \return Nothing
*/
static void mm_atexit_list_sort(struct region_list *list, size_t length)
{
@ -1320,8 +1296,6 @@ static void mm_atexit_list_sort(struct region_list *list, size_t length)
* \brief List all regions currently allocated.
*
* \param alloced regions list.
*
* \return Nothing
*/
static void mm_atexit_regions_list(struct region_list *alloced)
{
@ -1339,8 +1313,6 @@ static void mm_atexit_regions_list(struct region_list *alloced)
* \brief Summarize all regions currently allocated.
*
* \param alloced Sorted regions list.
*
* \return Nothing
*/
static void mm_atexit_regions_summary(struct region_list *alloced)
{
@ -1448,8 +1420,6 @@ static void mm_atexit_regions_summary(struct region_list *alloced)
* \brief Dump the memory allocations atexit.
*
* \note reglock must be locked before calling.
*
* \return Nothing
*/
static void mm_atexit_dump(void)
{
@ -1484,7 +1454,6 @@ static void mm_atexit_dump(void)
/*!
* \internal
* \return Nothing
*/
static void mm_atexit_final(void)
{
@ -1524,7 +1493,6 @@ void load_astmm_phase_1(void)
/*!
* \internal
* \return Nothing
*/
static void mm_atexit_ast(void)
{

2
main/astobj2_container.c
View File

@ -1030,8 +1030,6 @@ AST_THREADSTORAGE(ao2_out_buf);
*
* \param where User data pointer needed to determine where to put output.
* \param fmt printf type format string.
*
* \return Nothing
*/
static void cli_output(void *where, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
static void cli_output(void *where, const char *fmt, ...)

2
main/dns_recurring.c
View File

@ -39,7 +39,7 @@
#include <arpa/nameser.h>
/* \brief Delay between TTL expiration and the next DNS query, to make sure the
/*! \brief Delay between TTL expiration and the next DNS query, to make sure the
resolver cache really expired. */
#define EXTRA_TTL 2
#define MAX_TTL ((INT_MAX - EXTRA_TTL) / 1000)

38
main/dns_test.c
View File

@ -59,7 +59,7 @@ const char DNS_HEADER[] = {
*
* \param num_records The number of DNS records in this DNS response
* \param buf The buffer to write the header into
* \retval The number of bytes written to the buffer
* \return The number of bytes written to the buffer
*/
static int generate_dns_header(unsigned short num_records, char *buf)
{
@ -97,7 +97,7 @@ const char DNS_QUESTION [] = {
* than necessary for the tests.
*
* \param buf The buffer to write the question into
* \retval The number of bytes written to the buffer
* \return The number of bytes written to the buffer
*/
static int generate_dns_question(char *buf)
{
@ -129,8 +129,9 @@ const char NAPTR_ANSWER [] = {
* the data ourselves and have sized the buffer to be way larger
* than necessary for the tests.
*
* \param ttl Time to live
* \param buf The buffer to write the answer into
* \retval The number of bytes written to the buffer
* \return The number of bytes written to the buffer
*/
static int generate_dns_answer(int ttl, char *buf)
{
@ -145,20 +146,6 @@ static int generate_dns_answer(int ttl, char *buf)
return ARRAY_LEN(NAPTR_ANSWER);
}
/*!
* \brief Write a DNS string to a buffer
*
* This writes the DNS string to the buffer and returns the total
* number of bytes written to the buffer.
*
* There is no buffer size passed to this function since we provide
* the data ourselves and have sized the buffer to be way larger
* than necessary for the tests.
*
* \param string The string to write
* \param buf The buffer to write the string into
* \return The number of bytes written to the buffer
*/
int ast_dns_test_write_string(const struct ast_dns_test_string *string, char *buf)
{
uint8_t len = string->len;
@ -176,23 +163,6 @@ int ast_dns_test_write_string(const struct ast_dns_test_string *string, char *bu
return actual_len + 1;
}
/*!
* \brief Write a DNS domain to a buffer
*
* A DNS domain consists of a series of labels separated
* by dots. Each of these labels gets written as a DNS
* string. A DNS domain ends with a NULL label, which is
* essentially a zero-length DNS string.
*
*
* There is no buffer size passed to this function since we provide
* the data ourselves and have sized the buffer to be way larger
* than necessary for the tests.
*
* \param string The DNS domain to write
* \param buf The buffer to write the domain into
* \return The number of bytes written to the buffer
*/
int ast_dns_test_write_domain(const char *string, char *buf)
{
char *copy = ast_strdupa(string);

8
main/optional_api.c
View File

@ -88,7 +88,7 @@ static void optional_api_user_destroy(struct optional_api_user *user)
* \param module Name of the module requesting the API.
*
* \return New \ref optional_api_user.
* \return \c NULL on error.
* \retval NULL on error.
*/
static struct optional_api_user *optional_api_user_create(
ast_optional_fn *optional_ref, ast_optional_fn stub, const char *module)
@ -129,7 +129,7 @@ static void optional_api_destroy(struct optional_api *api)
*
* \param symname Name of the optional function.
* \return New \ref optional_api.
* \return \c NULL on error.
* \retval NULL on error.
*/
static struct optional_api *optional_api_create(const char *symname)
{
@ -151,9 +151,9 @@ static struct optional_api *optional_api_create(const char *symname)
/*!
* \brief Gets (or creates) the \ref optional_api for the given function.
*
* \param sysname Name of the function to look up.
* \param symname Name of the function to look up.
* \return Corresponding \ref optional_api.
* \return \c NULL on error.
* \retval NULL on error.
*/
static struct optional_api *get_api(const char *symname)
{

2
main/pbx.c
View File

@ -7061,7 +7061,7 @@ int ast_async_goto_by_name(const char *channame, const char *context, const char
* \param dst Destination buffer to copy src string.
* \param src Null terminated string to copy.
* \param dst_size Number of bytes in the dst buffer.
* \param nofluf Nonzero if '-' chars are not copied.
* \param nofluff Nonzero if '-' chars are not copied.
*
* \return Number of bytes written to dst including null terminator.
*/

2
main/stasis_message_router.c
View File

@ -82,8 +82,6 @@ static struct stasis_message_route *route_table_find(struct route_table *table,
* \brief route_table vector element cleanup.
*
* \param elem Element to cleanup
*
* \return Nothing
*/
#define ROUTE_TABLE_ELEM_CLEANUP(elem) ao2_cleanup((elem).message_type)

11
main/test.c
View File

@ -369,7 +369,7 @@ static void test_txt_entry(struct ast_test *test, FILE *f)
* \brief Executes registered unit tests
*
* \param name of test to run (optional)
* \param test category to run (optional)
* \param category category to run (optional)
* \param cli args for cli test updates (optional)
*
* \return number of tests executed.
@ -475,9 +475,9 @@ static int test_execute_multiple(const char *name, const char *category, struct
* \brief Generate test results.
*
* \param name of test result to generate (optional)
* \param test category to generate (optional)
* \param path to xml file to generate. (optional)
* \param path to txt file to generate, (optional)
* \param category category to generate (optional)
* \param xml_path path to xml file to generate (optional)
* \param txt_path path to txt file to generate (optional)
*
* \retval 0 success
* \retval -1 failure
@ -612,7 +612,8 @@ static int test_insert(struct ast_test *test)
* \internal
* \brief removes test from container
*
* \return ast_test removed from list on success, or NULL on failure
* \return ast_test removed from list on success
* \retval NULL on failure
*/
static struct ast_test *test_remove(ast_test_cb_t *cb)
{

2
menuselect/menuselect.c
View File

@ -1901,7 +1901,7 @@ static int sanity_check(void)
return insane ? -1 : 0;
}
/* \brief Set the forced default values if they exist */
/*! \brief Set the forced default values if they exist */
static void process_defaults(void)
{
struct category *cat;

2
menuselect/menuselect_curses.c
View File

@ -16,7 +16,7 @@
* at the top of the source tree.
*/
/*
/*!
* \file
*
* \author Russell Bryant <russell@digium.com>

2
menuselect/menuselect_gtk.c
View File

@ -16,7 +16,7 @@
* at the top of the source tree.
*/
/*
/*!
* \file
*
* \author Russell Bryant <russell@digium.com>

2
menuselect/menuselect_newt.c
View File

@ -16,7 +16,7 @@
* at the top of the source tree.
*/
/*
/*!
* \file
*
* \author Sean Bright <sean.bright@gmail.com>

2
menuselect/menuselect_stub.c
View File

@ -16,7 +16,7 @@
* at the top of the source tree.
*/
/*
/*!
* \file
*
* \author Russell Bryant <russell@digium.com>

2
pbx/pbx_dundi.c
View File

@ -4527,7 +4527,7 @@ static void build_mapping(const char *name, const char *value)
ast_log(LOG_WARNING, "Expected at least %d arguments in map, but got only %d\n", 4, x);
}
/* \note Called with the peers list already locked */
/*! \note Called with the peers list already locked */
static int do_register(const void *data)
{
struct dundi_ie_data ied;

7
pbx/pbx_lua.c
View File

@ -174,11 +174,12 @@ static int lua_pbx_findapp(lua_State *L)
* lua, don't call directly)
*
* \param L the lua_State to use
* \return nothing
*
* This funciton is executed as the '()' operator for apps accessed through the
* 'app' table.
*
* \return LUA error
*
* \code
* app.playback('demo-congrats')
* \endcode
@ -293,6 +294,8 @@ static int lua_pbx_exec(lua_State *L)
* 'get()' function in the following example as would be seen in
* extensions.lua.
*
* \return LUA error
*
* \code
* channel.variable:get()
* \endcode
@ -353,6 +356,8 @@ static int lua_get_variable_value(lua_State *L)
* This function is the 'set()' function in the following example as would be
* seen in extensions.lua.
*
* \return LUA error
*
* \code
* channel.variable:set("value")
* \endcode

2
res/res_odbc.c
View File

@ -861,7 +861,7 @@ unsigned int ast_odbc_get_max_connections(const char *name)
return max_connections;
}
/*
/*!
* \brief Determine if the connection has died.
*
* \param connection The connection to check

6
res/res_pjsip/config_transport.c
View File

@ -1174,8 +1174,8 @@ static int tls_method_to_str(const void *obj, const intptr_t *args, char **buf)
return 0;
}
/*! \brief Helper function which turns a cipher name into an identifier */
#if defined(PJ_HAS_SSL_SOCK) && PJ_HAS_SSL_SOCK != 0
/*! \brief Helper function which turns a cipher name into an identifier */
static pj_ssl_cipher cipher_name_to_id(const char *name)
{
pj_ssl_cipher ciphers[PJ_SSL_SOCK_MAX_CIPHERS];
@ -1202,7 +1202,7 @@ static pj_ssl_cipher cipher_name_to_id(const char *name)
* \internal
* \brief Add a new cipher to the transport's cipher list array.
*
* \param transport Which transport to add the cipher to.
* \param state Which transport to add the cipher to.
* \param name Cipher identifier name.
*
* \retval 0 on success.
@ -1240,8 +1240,8 @@ static int transport_cipher_add(struct ast_sip_transport_state *state, const cha
}
#endif
/*! \brief Custom handler for TLS cipher setting */
#if defined(PJ_HAS_SSL_SOCK) && PJ_HAS_SSL_SOCK != 0
/*! \brief Custom handler for TLS cipher setting */
static int transport_tls_cipher_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
{
struct ast_sip_transport *transport = obj;

1
res/res_xmpp.c
View File

@ -1218,7 +1218,6 @@ static void xmpp_pubsub_create_node(struct ast_xmpp_client *client, const char *
* \brief Delete a PubSub node
* \param client the configured XMPP client we use to connect to a XMPP server
* \param node_name the name of the node to delete
* return void
*/
static void xmpp_pubsub_delete_node(struct ast_xmpp_client *client, const char *node_name)
{

2
tests/test_astobj2.c
View File

@ -188,8 +188,6 @@ static int test_sort_cb(const void *obj_left, const void *obj_right, int flags)
* \param v_obj A pointer to the object we want the key printed.
* \param where User data needed by prnt to determine where to put output.
* \param prnt Print output callback function to use.
*
* \return Nothing
*/
static void test_prnt_obj(void *v_obj, void *where, ao2_prnt_fn *prnt)
{

6
tests/test_astobj2_thrash.c
View File

@ -73,13 +73,13 @@ static int is_timed_out(struct hash_test const *data) {
return ast_tvdiff_us(data->deadline, ast_tvnow()) < 0;
}
/*! /brief Free test element */
/*! \brief Free test element */
static void ht_delete(void *obj)
{
ast_atomic_fetchadd_int(&alloc_count, -1);
}
/*! /brief Create test element */
/*! \brief Create test element */
static char *ht_new(int i)
{
const int buflen = 12;
@ -94,7 +94,7 @@ static char *ht_new(int i)
return keybuf;
}
/*! /brief Grow the hash data as specified */
/*! \brief Grow the hash data as specified */
static void *hash_test_grow(void *d)
{
struct hash_test *data = d;

6
tests/test_hashtab_thrash.c
View File

@ -73,7 +73,7 @@ static int is_timed_out(struct hash_test const *data) {
return val;
}
/*! /brief Create test element */
/*! \brief Create test element */
static char *ht_new(int i)
{
const int buflen = 12;
@ -87,13 +87,13 @@ static char *ht_new(int i)
return keybuf;
}
/*! /brief Free test element */
/*! \brief Free test element */
static void ht_delete(void *obj)
{
ast_free(obj);
}
/*! /brief Grow the hash data as specified */
/*! \brief Grow the hash data as specified */
static void *hash_test_grow(void *d)
{
struct hash_test *data = d;