progdocs: Fix for Doxygen, the hidden parts.

ASTERISK-29779

Change-Id: If338163488498f65fa7248b60e80299c0a928e4b
This commit is contained in:
Alexander Traud
2021-11-28 11:29:53 +01:00
committed by Kevin Harwell
parent 751bbf4b97
commit f946b92553
49 changed files with 121 additions and 383 deletions

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.

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);

View File

@@ -73,7 +73,7 @@ struct misdn_stack {
/*! \brief D Channel mISDN driver stack ID (Parent stack ID) */
int d_stid;
/*! /brief Number of B channels supported by this port */
/*! \brief Number of B channels supported by this port */
int b_num;
/*! \brief B Channel mISDN driver stack IDs (Child stack IDs) */

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)
{

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;
/*!

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)
{