[Asterisk-code-review] chan_misdn: Fix for Doxygen. (asterisk[16])
Friendly Automation
asteriskteam at digium.com
Mon Nov 29 08:41:04 CST 2021
Friendly Automation has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/17567 )
Change subject: chan_misdn: Fix for Doxygen.
......................................................................
chan_misdn: Fix for Doxygen.
ASTERISK-29764
Change-Id: I6e5466cce03e25695c5c7d8b68c305184dcf5375
---
M channels/chan_misdn.c
M channels/misdn/isdn_lib.c
M channels/misdn/isdn_msg_parser.c
3 files changed, 14 insertions(+), 86 deletions(-)
Approvals:
George Joseph: Looks good to me, approved
Friendly Automation: Approved for Submit
diff --git a/channels/chan_misdn.c b/channels/chan_misdn.c
index 546bb2b..c05a5bc 100644
--- a/channels/chan_misdn.c
+++ b/channels/chan_misdn.c
@@ -245,7 +245,7 @@
/*! \brief CallLinkageID (valid when port determined) */
int linkage_id;
- /*! \breif CCBSReference (valid when activated is TRUE) */
+ /*! \brief CCBSReference (valid when activated is TRUE) */
int reference_id;
/*! \brief globalRecall(0), specificRecall(1) */
@@ -823,8 +823,6 @@
* destroyed. If this is the case, then the call completion events have
* already occurred and the appropriate channel variables have already been
* set on the original channel that requested call completion services.
- *
- * \return Nothing
*/
static void misdn_cc_ds_destroy(void *data)
{
@@ -879,8 +877,6 @@
*
* This function may be called from outside of the channel thread. It handles
* the fact that the peer channel may be hung up and destroyed at any time.
- *
- * \return nothing
*/
static void misdn_cc_set_peer_var(struct misdn_cc_caller *peer, const char *var,
const char *value)
@@ -1086,8 +1082,6 @@
*
* \param doomed Call completion record to destroy
*
- * \return Nothing
- *
* \note Assumes the misdn_cc_records_db lock is already obtained.
*/
static void misdn_cc_delete(struct misdn_cc_record *doomed)
@@ -1112,8 +1106,6 @@
* \internal
* \brief Delete all old call completion records
*
- * \return Nothing
- *
* \note Assumes the misdn_cc_records_db lock is already obtained.
*/
static void misdn_cc_remove_old(void)
@@ -1219,8 +1211,6 @@
/*!
* \internal
* \brief Destroy the call completion record database
- *
- * \return Nothing
*/
static void misdn_cc_destroy(void)
{
@@ -1237,8 +1227,6 @@
/*!
* \internal
* \brief Initialize the call completion record database
- *
- * \return Nothing
*/
static void misdn_cc_init(void)
{
@@ -1288,8 +1276,6 @@
* \param chan Asterisk channel to operate upon.
* \param wait_seconds Number of seconds to wait
* \param record_id Call completion record ID.
- *
- * \return Nothing
*/
static void misdn_cc_response_wait(struct ast_channel *chan, int wait_seconds, long record_id)
{
@@ -2392,8 +2378,6 @@
*
* \param party PartyNumber structure to fill in.
* \param id Information to put in PartyNumber structure.
- *
- * \return Nothing
*/
static void misdn_PartyNumber_fill(struct FacPartyNumber *party, const struct misdn_party_id *id)
{
@@ -2421,8 +2405,6 @@
*
* \param id Where to put extracted PartyNumber information
* \param party PartyNumber information to extract
- *
- * \return Nothing
*/
static void misdn_PartyNumber_extract(struct misdn_party_id *id, const struct FacPartyNumber *party)
{
@@ -2456,8 +2438,6 @@
*
* \param Address Address structure to fill in.
* \param id Information to put in Address structure.
- *
- * \return Nothing
*/
static void misdn_Address_fill(struct FacAddress *Address, const struct misdn_party_id *id)
{
@@ -2475,8 +2455,6 @@
*
* \param presented PresentedNumberUnscreened structure to fill in.
* \param id Information to put in PresentedNumberUnscreened structure.
- *
- * \return Nothing
*/
static void misdn_PresentedNumberUnscreened_fill(struct FacPresentedNumberUnscreened *presented, const struct misdn_party_id *id)
{
@@ -2492,8 +2470,6 @@
*
* \param id Where to put extracted PresentedNumberUnscreened information
* \param presented PresentedNumberUnscreened information to extract
- *
- * \return Nothing
*/
static void misdn_PresentedNumberUnscreened_extract(struct misdn_party_id *id, const struct FacPresentedNumberUnscreened *presented)
{
@@ -3377,8 +3353,6 @@
* \param size Buffer size of the main string (Includes null terminator).
*
* \note The str_main buffer size must be greater than one.
- *
- * \return Nothing
*/
static void misdn_prefix_string(const char *str_prefix, char *str_main, size_t size)
{
@@ -3420,8 +3394,6 @@
* \param number_type Type-of-number passed in.
* \param number Given number string to add prefix
* \param size Buffer size number string occupies.
- *
- * \return Nothing
*/
static void misdn_add_number_prefix(int port, enum mISDN_NUMBER_TYPE number_type, char *number, size_t size)
{
@@ -6131,8 +6103,6 @@
* \param id Party id information to send to the other side
* \param source Why are we sending this update
* \param cid_tag User tag to apply to the party id.
- *
- * \return Nothing
*/
static void misdn_queue_connected_line_update(struct ast_channel *ast, const struct misdn_party_id *id, enum AST_CONNECTED_LINE_UPDATE_SOURCE source, char *cid_tag)
{
@@ -6167,8 +6137,6 @@
* \param ast Current Asterisk channel
* \param id Remote party id information to update.
* \param cid_tag User tag to apply to the party id.
- *
- * \return Nothing
*/
static void misdn_update_caller_id(struct ast_channel *ast, const struct misdn_party_id *id, char *cid_tag)
{
@@ -6206,8 +6174,6 @@
* \param id Remote party id information to update.
* \param source Why are we sending this update
* \param cid_tag User tag to apply to the party id.
- *
- * \return Nothing
*/
static void misdn_update_remote_party(struct ast_channel *ast, const struct misdn_party_id *id, enum AST_CONNECTED_LINE_UPDATE_SOURCE source, char *cid_tag)
{
@@ -6222,8 +6188,6 @@
* \param ast Current Asterisk channel
* \param bc Associated B channel
* \param originator Who originally created this channel. ORG_AST or ORG_MISDN
- *
- * \return Nothing
*/
static void misdn_get_connected_line(struct ast_channel *ast, struct misdn_bchannel *bc, int originator)
{
@@ -6296,8 +6260,6 @@
* \param ast Current Asterisk channel
* \param bc Associated B channel
* \param originator Who originally created this channel. ORG_AST or ORG_MISDN
- *
- * \return Nothing
*/
static void misdn_update_connected_line(struct ast_channel *ast, struct misdn_bchannel *bc, int originator)
{
@@ -6378,8 +6340,6 @@
*
* \param bc Associated B channel
* \param ast Current Asterisk channel
- *
- * \return Nothing
*/
static void misdn_copy_redirecting_from_ast(struct misdn_bchannel *bc, struct ast_channel *ast)
{
@@ -6433,8 +6393,6 @@
* \param ast Current Asterisk channel
* \param redirect Associated B channel redirecting info
* \param tag Caller ID tag to set in the redirecting party fields
- *
- * \return Nothing
*/
static void misdn_copy_redirecting_to_ast(struct ast_channel *ast, const struct misdn_party_redirecting *redirect, char *tag)
{
@@ -6479,8 +6437,6 @@
* \param ast Current Asterisk channel
* \param bc Associated B channel
* \param originator Who originally created this channel. ORG_AST or ORG_MISDN
- *
- * \return Nothing
*/
static void misdn_update_redirecting(struct ast_channel *ast, struct misdn_bchannel *bc, int originator)
{
@@ -7788,8 +7744,6 @@
* \brief Destroy the chan_list object.
*
* \param obj chan_list object to destroy.
- *
- * \return Nothing
*/
static void chan_list_destructor(void *obj)
{
@@ -8490,8 +8444,6 @@
* \param ch Call channel record to release.
* \param bc Current B channel record associated with ch.
*
- * \return Nothing
- *
* \note The only valid thing to do with ch after calling is to chan_list_unref(ch, "").
*/
static void release_chan(struct chan_list *ch, struct misdn_bchannel *bc)
@@ -8556,8 +8508,6 @@
*
* \param ch Call channel record to release.
*
- * \return Nothing
- *
* \note The only valid thing to do with ch after calling is to chan_list_unref(ch, "").
*/
static void release_chan_early(struct chan_list *ch)
@@ -8904,8 +8854,6 @@
*
* \param port Logical port number.
* \param facility Facility ie contents.
- *
- * \return Nothing
*/
static void misdn_cc_handle_ccbs_status_request(int port, const struct FacParm *facility)
{
@@ -8950,8 +8898,6 @@
*
* \param record_id Call completion record ID
* \param notify Dialplan location to start processing.
- *
- * \return Nothing
*/
static void misdn_cc_pbx_notify(long record_id, const struct misdn_cc_notify *notify)
{
@@ -8990,8 +8936,6 @@
* \brief Handle the FACILITY CCBS_T_RemoteUserFree message.
*
* \param bc B channel control structure message came in on
- *
- * \return Nothing
*/
static void misdn_cc_handle_T_remote_user_free(struct misdn_bchannel *bc)
{
@@ -9032,8 +8976,6 @@
*
* \param port Logical port number.
* \param facility Facility ie contents.
- *
- * \return Nothing
*/
static void misdn_cc_handle_remote_user_free(int port, const struct FacParm *facility)
{
@@ -9061,8 +9003,6 @@
*
* \param port Logical port number.
* \param facility Facility ie contents.
- *
- * \return Nothing
*/
static void misdn_cc_handle_b_free(int port, const struct FacParm *facility)
{
@@ -9091,8 +9031,6 @@
* \param event Message type facility ie came in on
* \param bc B channel control structure message came in on
* \param ch Associated channel call record
- *
- * \return Nothing
*/
static void misdn_facility_ie_handler(enum event_e event, struct misdn_bchannel *bc, struct chan_list *ch)
{
@@ -11792,8 +11730,9 @@
* \internal
* \brief misdn_command(cc-b-free) subcommand handler
*
- * \details
- * misdn_command(cc-b-free,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ * \verbatim
+ misdn_command(cc-b-free,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ \endverbatim
* Set the dialplan location to notify when User-B is free and User-A is busy.
*
* \param chan Asterisk channel to operate upon.
@@ -11858,9 +11797,10 @@
* \internal
* \brief misdn_command(ccbs-request/ccnr-request) subcommand handler helper
*
- * \details
- * misdn_command(ccbs-request,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
- * misdn_command(ccnr-request,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ * \verbatim
+ misdn_command(ccbs-request,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ misdn_command(ccnr-request,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ \endverbatim
* Set the dialplan location to notify when User-B is free and User-A is free.
*
* \param chan Asterisk channel to operate upon.
@@ -12045,8 +11985,9 @@
* \internal
* \brief misdn_command(ccbs-request) subcommand handler
*
- * \details
- * misdn_command(ccbs-request,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ * \verbatim
+ misdn_command(ccbs-request,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ \endverbatim
* Set the dialplan location to notify when User-B is free and User-A is free.
*
* \param chan Asterisk channel to operate upon.
@@ -12071,8 +12012,9 @@
* \internal
* \brief misdn_command(ccnr-request) subcommand handler
*
- * \details
- * misdn_command(ccnr-request,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ * \verbatim
+ misdn_command(ccnr-request,${MISDN_CC_RECORD_ID},<notify-context>,<user-a-extension>,<priority>)
+ \endverbatim
* Set the dialplan location to notify when User-B is free and User-A is free.
*
* \param chan Asterisk channel to operate upon.
diff --git a/channels/misdn/isdn_lib.c b/channels/misdn/isdn_lib.c
index cb64106..8038800 100644
--- a/channels/misdn/isdn_lib.c
+++ b/channels/misdn/isdn_lib.c
@@ -596,8 +596,6 @@
* \param stack Which port stack B channel belongs.
* \param channel B channel to release. (Range 1-MAX_BCHANS representing B1-Bn)
*
- * \return Nothing
- *
* \note
* Must be called after clean_up_bc() to make sure that the media stream is
* no longer connected.
@@ -671,8 +669,6 @@
*
* \param bc B channel record to empty of most call data.
*
- * \return Nothing
- *
* \note
* Sets the last_used time and must be called before clearing bc->in_use.
*/
diff --git a/channels/misdn/isdn_msg_parser.c b/channels/misdn/isdn_msg_parser.c
index 0e0ceea..7b496b7 100644
--- a/channels/misdn/isdn_msg_parser.c
+++ b/channels/misdn/isdn_msg_parser.c
@@ -36,8 +36,6 @@
* \param display_format Display format enumeration
* \param name Name string to use
* \param number Number string to use
- *
- * \return Nothing
*/
static void build_display_str(char *display, size_t display_length, int display_format, const char *name, const char *number)
{
@@ -71,8 +69,6 @@
* \param msg General message structure
* \param fac Data to encode into the facility ie.
* \param nt TRUE if in NT mode.
- *
- * \return Nothing
*/
static void enc_ie_facility(unsigned char **ntmode, msg_t *msg, struct FacParm *fac, int nt)
{
@@ -114,8 +110,6 @@
* \param fac Where to put the decoded facility ie data if it is available.
* \param nt TRUE if in NT mode.
* \param bc Associated B channel
- *
- * \return Nothing
*/
static void dec_ie_facility(unsigned char *p, Q931_info_t *qi, struct FacParm *fac, int nt, struct misdn_bchannel *bc)
{
@@ -303,8 +297,6 @@
* \param setup Indexed setup message contents
* \param nt TRUE if in NT mode.
* \param bc Associated B channel
- *
- * \return Nothing
*/
static void extract_setup_Bc_Hlc_Llc(SETUP_t *setup, int nt, struct misdn_bchannel *bc)
{
@@ -1400,8 +1392,6 @@
* \param msg Received message contents
* \param bc Associated B channel
* \param nt TRUE if in NT mode.
- *
- * \return Nothing
*/
static void parse_register(struct isdn_msg msgs[], msg_t *msg, struct misdn_bchannel *bc, int nt)
{
--
To view, visit https://gerrit.asterisk.org/c/asterisk/+/17567
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings
Gerrit-Project: asterisk
Gerrit-Branch: 16
Gerrit-Change-Id: I6e5466cce03e25695c5c7d8b68c305184dcf5375
Gerrit-Change-Number: 17567
Gerrit-PatchSet: 2
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211129/8b396bd9/attachment-0001.html>
More information about the asterisk-code-review
mailing list