<p>Friendly Automation <strong>submitted</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/17558">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  George Joseph: Looks good to me, approved
  Friendly Automation: Approved for Submit

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">channels: Fix for Doxygen.<br><br>ASTERISK-29762<br><br>Change-Id: Ia8811ac12b93ff8c18164699c6fbc604cb0a23f7<br>---<br>M channels/chan_console.c<br>M channels/chan_dahdi.c<br>M channels/chan_iax2.c<br>M channels/chan_motif.c<br>M channels/chan_pjsip.c<br>M channels/chan_sip.c<br>M channels/dahdi/bridge_native_dahdi.c<br>M channels/iax2/codec_pref.c<br>M channels/iax2/include/firmware.h<br>M channels/sig_analog.c<br>M channels/sip/config_parser.c<br>M channels/sip/include/reqresp_parser.h<br>M channels/sip/include/route.h<br>M channels/sip/include/sip.h<br>M channels/sip/reqresp_parser.c<br>15 files changed, 94 insertions(+), 163 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/channels/chan_console.c b/channels/chan_console.c</span><br><span>index a5ee2db..1d1d94c 100644</span><br><span>--- a/channels/chan_console.c</span><br><span>+++ b/channels/chan_console.c</span><br><span>@@ -552,7 +552,7 @@</span><br><span>      return start_stream(pvt);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span>  * \brief Implementation of the ast_channel_tech read() callback</span><br><span>  *</span><br><span>  * Calling this function is harmless.  However, if it does get called, it</span><br><span>diff --git a/channels/chan_dahdi.c b/channels/chan_dahdi.c</span><br><span>index 8480775..96d540f 100644</span><br><span>--- a/channels/chan_dahdi.c</span><br><span>+++ b/channels/chan_dahdi.c</span><br><span>@@ -1799,8 +1799,6 @@</span><br><span>  *</span><br><span>  * \param p DAHDI private pointer</span><br><span>  * \param chan Channel associated with the private pointer</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_ami_channel_event(struct dahdi_pvt *p, struct ast_channel *chan)</span><br><span> {</span><br><span>@@ -1827,8 +1825,6 @@</span><br><span>  *</span><br><span>  * \param pvt DAHDI private pointer</span><br><span>  * \param chan Channel associated with the private pointer</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_ami_channel_event(void *pvt, struct ast_channel *chan)</span><br><span> {</span><br><span>@@ -2221,6 +2217,7 @@</span><br><span>  * \note this variant of dahdi should only be used in conjunction with ast_callid_threadstorage_auto()</span><br><span>  *</span><br><span>  * \param callid_created value returned from ast_callid_threadstorage_auto()</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param i, state, startpbx, idx, law, assignedids, requestor, callid</span><br><span>  */</span><br><span> static struct ast_channel *dahdi_new_callid_clean(struct dahdi_pvt *i, int state, int startpbx, int idx, int law, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, ast_callid callid, int callid_created);</span><br><span> </span><br><span>@@ -2306,8 +2303,6 @@</span><br><span>  * \since 1.8</span><br><span>  *</span><br><span>  * \param p Channel private control structure.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_pri_ss7_open_media(void *p)</span><br><span> {</span><br><span>@@ -2359,8 +2354,6 @@</span><br><span>  * \param dial_string String to pass to DAHDI to dial.</span><br><span>  *</span><br><span>  * \note The channel private lock needs to be held when calling.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_pri_dial_digits(void *p, const char *dial_string)</span><br><span> {</span><br><span>@@ -2819,8 +2812,6 @@</span><br><span>  *</span><br><span>  * \param pvt DAHDI private structure</span><br><span>  * \param caller Caller-id information to set.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_set_callerid(void *pvt, const struct ast_party_caller *caller)</span><br><span> {</span><br><span>@@ -2855,8 +2846,6 @@</span><br><span>  *</span><br><span>  * \param pvt DAHDI private structure</span><br><span>  * \param dnid Dialed Number Identifier string.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_set_dnid(void *pvt, const char *dnid)</span><br><span> {</span><br><span>@@ -2874,8 +2863,6 @@</span><br><span>  *</span><br><span>  * \param pvt DAHDI private structure</span><br><span>  * \param rdnis Redirecting Directory Number Information Service (RDNIS) string.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_set_rdnis(void *pvt, const char *rdnis)</span><br><span> {</span><br><span>@@ -2907,8 +2894,6 @@</span><br><span>  *</span><br><span>  * The routine will check to see if the ISDN channel restriction is already</span><br><span>  * in the original dialstring.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_pri_make_cc_dialstring(void *priv, char *buf, size_t buf_size)</span><br><span> {</span><br><span>@@ -2953,8 +2938,6 @@</span><br><span>  *</span><br><span>  * \param pri Asterisk D channel control structure.</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span>  * \note Assumes the pri->lock is already obtained.</span><br><span>  */</span><br><span> static void dahdi_pri_update_span_devstate(struct sig_pri_span *pri)</span><br><span>@@ -3018,8 +3001,6 @@</span><br><span>  * \internal</span><br><span>  * \brief Reference this module.</span><br><span>  * \since 1.8</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_module_ref(void)</span><br><span> {</span><br><span>@@ -3032,8 +3013,6 @@</span><br><span>  * \internal</span><br><span>  * \brief Unreference this module.</span><br><span>  * \since 1.8</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_module_unref(void)</span><br><span> {</span><br><span>@@ -3089,8 +3068,6 @@</span><br><span>  *</span><br><span>  * \param linkset Controlling linkset for the channel.</span><br><span>  * \param which Link index of the signaling channel.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_handle_link_exception(struct sig_ss7_linkset *linkset, int which)</span><br><span> {</span><br><span>@@ -3283,8 +3260,6 @@</span><br><span>  * \param thereornot This argument should simply be set to 1 or 0, to indicate</span><br><span>  *      whether there are messages waiting or not.</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- *  \return nothing</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span>  * This function does two things:</span><br><span>  *</span><br><span>  * 1) It generates an internal Asterisk event notifying any other module that</span><br><span>@@ -3463,8 +3438,6 @@</span><br><span>  * \note</span><br><span>  * Because deadlock avoidance may have been necessary, you need to confirm</span><br><span>  * the state of things before continuing.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_lock_sub_owner(struct dahdi_pvt *pvt, int sub_idx)</span><br><span> {</span><br><span>@@ -5280,8 +5253,6 @@</span><br><span>  * Any duplicates are inserted after the existing entries.</span><br><span>  *</span><br><span>  * \note The new interface must not already be in the list.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_iflist_insert(struct dahdi_pvt *pvt)</span><br><span> {</span><br><span>@@ -5330,8 +5301,6 @@</span><br><span>  * \note</span><br><span>  * The given interface structure can be either in the interface list or a stand alone</span><br><span>  * structure that has not been put in the list if the next and prev pointers are NULL.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_iflist_extract(struct dahdi_pvt *pvt)</span><br><span> {</span><br><span>@@ -5371,8 +5340,6 @@</span><br><span>  * Any duplicates are inserted after the existing entries.</span><br><span>  *</span><br><span>  * \note The new interface must not already be in the list.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_nobch_insert(struct sig_pri_span *pri, struct dahdi_pvt *pvt)</span><br><span> {</span><br><span>@@ -5424,8 +5391,6 @@</span><br><span>  * \note</span><br><span>  * The given interface structure can be either in the interface list or a stand alone</span><br><span>  * structure that has not been put in the list if the next and prev pointers are NULL.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_nobch_extract(struct sig_pri_span *pri, struct dahdi_pvt *pvt)</span><br><span> {</span><br><span>@@ -5459,8 +5424,6 @@</span><br><span>  * \since 1.8</span><br><span>  *</span><br><span>  * \param pvt chan_dahdi private interface structure to unlink.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_unlink_pri_pvt(struct dahdi_pvt *pvt)</span><br><span> {</span><br><span>@@ -5491,8 +5454,6 @@</span><br><span>  * \since 1.8</span><br><span>  *</span><br><span>  * \param pvt chan_dahdi private interface structure to unlink.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_unlink_ss7_pvt(struct dahdi_pvt *pvt)</span><br><span> {</span><br><span>@@ -5522,8 +5483,6 @@</span><br><span>  * \brief Unlink the channel interface from the MFC/R2 private pointer array.</span><br><span>  *</span><br><span>  * \param pvt chan_dahdi private interface structure to unlink.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_unlink_mfcr2_pvt(struct dahdi_pvt *pvt)</span><br><span> {</span><br><span>@@ -13129,8 +13088,6 @@</span><br><span>  * \param pri sig_pri PRI control structure.</span><br><span>  *</span><br><span>  * \note Assumes the pri->lock is already obtained.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void my_pri_init_config(void *priv, struct sig_pri_span *pri)</span><br><span> {</span><br><span>@@ -17503,8 +17460,6 @@</span><br><span>  * \details</span><br><span>  * The core will call this function upon completion</span><br><span>  * or failure of CC.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void dahdi_pri_cc_agent_destructor(struct ast_cc_agent *agent)</span><br><span> {</span><br><span>@@ -19336,8 +19291,6 @@</span><br><span>  *</span><br><span>  * \param dest Destination.</span><br><span>  * \param src Source.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void deep_copy_dahdi_chan_conf(struct dahdi_chan_conf *dest, const struct dahdi_chan_conf *src)</span><br><span> {</span><br><span>diff --git a/channels/chan_iax2.c b/channels/chan_iax2.c</span><br><span>index a7f6dd1..ecf5074 100644</span><br><span>--- a/channels/chan_iax2.c</span><br><span>+++ b/channels/chan_iax2.c</span><br><span>@@ -3099,7 +3099,7 @@</span><br><span>       return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span>  * \note Calling this function while holding another pvt lock can cause a deadlock.</span><br><span>  */</span><br><span> static int __find_callno(unsigned short callno, unsigned short dcallno, struct ast_sockaddr *addr, int new, int sockfd, int return_locked, int check_dcallno)</span><br><span>diff --git a/channels/chan_motif.c b/channels/chan_motif.c</span><br><span>index 8da2d16..5ec348d 100644</span><br><span>--- a/channels/chan_motif.c</span><br><span>+++ b/channels/chan_motif.c</span><br><span>@@ -328,7 +328,7 @@</span><br><span> </span><br><span> static struct ast_sched_context *sched; /*!< Scheduling context for RTCP */</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief Asterisk core interaction functions */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Asterisk core interaction functions */</span><br><span> static struct ast_channel *jingle_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause);</span><br><span> static int jingle_sendtext(struct ast_channel *ast, const char *text);</span><br><span> static int jingle_digit_begin(struct ast_channel *ast, char digit);</span><br><span>diff --git a/channels/chan_pjsip.c b/channels/chan_pjsip.c</span><br><span>index 3cbbc3b..e8fbb3d 100644</span><br><span>--- a/channels/chan_pjsip.c</span><br><span>+++ b/channels/chan_pjsip.c</span><br><span>@@ -83,7 +83,7 @@</span><br><span> {</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief Asterisk core interaction functions */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Asterisk core interaction functions */</span><br><span> static struct ast_channel *chan_pjsip_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause);</span><br><span> static struct ast_channel *chan_pjsip_request_with_stream_topology(const char *type,</span><br><span>        struct ast_stream_topology *topology, const struct ast_assigned_ids *assignedids,</span><br><span>diff --git a/channels/chan_sip.c b/channels/chan_sip.c</span><br><span>index 6757f51..99d461f 100644</span><br><span>--- a/channels/chan_sip.c</span><br><span>+++ b/channels/chan_sip.c</span><br><span>@@ -26,7 +26,7 @@</span><br><span>  * \arg \ref AstCREDITS</span><br><span>  *</span><br><span>  * Implementation of RFC 3261 - without S/MIME, and experimental TCP and TLS support</span><br><span style="color: hsl(0, 100%, 40%);">- * Configuration file \link Config_sip sip.conf \endlink</span><br><span style="color: hsl(120, 100%, 40%);">+ * Configuration file \ref sip.conf "Config_sip"</span><br><span>  *</span><br><span>  * ********** IMPORTANT *</span><br><span>  * \note TCP/TLS support is EXPERIMENTAL and WILL CHANGE. This applies to configuration</span><br><span>@@ -2306,7 +2306,7 @@</span><br><span>    return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span>  * \brief Determine what, if any, CC has been offered and queue a CC frame if possible</span><br><span>  *</span><br><span>  * After taking care of some formalities to be sure that this call is eligible for CC,</span><br><span>@@ -2406,7 +2406,7 @@</span><br><span> };</span><br><span> </span><br><span> /*! \brief Append to SIP dialog history</span><br><span style="color: hsl(0, 100%, 40%);">-        \return Always returns 0 */</span><br><span style="color: hsl(120, 100%, 40%);">+   \retval 0 always */</span><br><span> #define append_history(p, event, fmt , args... ) append_history_full(p, "%-15s " fmt, event, ## args)</span><br><span> </span><br><span> /*! \brief map from an integer value to a string.</span><br><span>@@ -2845,7 +2845,6 @@</span><br><span>  * 1) The message is a full SIP request</span><br><span>  * 2) The message is a partial SIP request</span><br><span>  * 3) The message contains a full SIP request along with another partial request</span><br><span style="color: hsl(0, 100%, 40%);">- * \param data The unparsed incoming SIP message.</span><br><span>  * \param request The resulting request with extra fragments removed.</span><br><span>  * \param overflow If the message contains more than a full request, this is the remainder of the message</span><br><span>  * \return The resulting integrity of the message</span><br><span>@@ -2912,10 +2911,13 @@</span><br><span> }</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \internal</span><br><span>  * \brief Read SIP request or response from a TCP/TLS connection</span><br><span>  *</span><br><span>  * \param req The request structure to be filled in</span><br><span>  * \param tcptls_session The TCP/TLS connection from which to read</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param authenticated 0 means unauthenticated</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param start timeout for unauthenticated server sessions</span><br><span>  * \retval -1 Failed to read data</span><br><span>  * \retval 0 Successfully read data</span><br><span>  */</span><br><span>@@ -3272,7 +3274,7 @@</span><br><span>     }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief Unlink all marked peers from ao2 containers */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Unlink all marked peers from ao2 containers */</span><br><span> static void unlink_marked_peers_from_tables(void)</span><br><span> {</span><br><span>      unlink_peers_from_tables(SIP_PEERS_MARKED);</span><br><span>@@ -3283,7 +3285,9 @@</span><br><span>  unlink_peers_from_tables(SIP_PEERS_ALL);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \brief maintain proper refcounts for a sip_pvt's outboundproxy</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief maintain proper refcounts for a sip_pvt's outboundproxy</span><br><span>  *</span><br><span>  * This function sets pvt's outboundproxy pointer to the one referenced</span><br><span>  * by the proxy parameter. Because proxy may be a refcounted object, and</span><br><span>@@ -3292,7 +3296,6 @@</span><br><span>  *</span><br><span>  * \param pvt The sip_pvt for which we wish to set the outboundproxy</span><br><span>  * \param proxy The sip_proxy which we will point pvt towards.</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Returns void</span><br><span>  */</span><br><span> static void ref_proxy(struct sip_pvt *pvt, struct sip_proxy *proxy)</span><br><span> {</span><br><span>@@ -4274,7 +4277,8 @@</span><br><span> /*!</span><br><span>  * \internal</span><br><span>  * \brief Transmit packet with retransmits</span><br><span style="color: hsl(0, 100%, 40%);">- * \return 0 on success, -1 on failure to allocate packet</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0 on success</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval -1 on failure to allocate packet.</span><br><span>  */</span><br><span> static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, uint32_t seqno, int resp, struct ast_str *data, int fatal, int sipmethod)</span><br><span> {</span><br><span>@@ -6040,7 +6044,8 @@</span><br><span> }</span><br><span> </span><br><span> /*! \brief Initialize RTP portion of a dialog</span><br><span style="color: hsl(0, 100%, 40%);">- * \return -1 on failure, 0 on success</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval -1 on failure.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0 on success.</span><br><span>  */</span><br><span> static int dialog_initialize_rtp(struct sip_pvt *dialog)</span><br><span> {</span><br><span>@@ -6134,7 +6139,8 @@</span><br><span>  *     This function copies data from peer to the dialog, so we don't have to look up the peer</span><br><span>  *       again from memory or database during the life time of the dialog.</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return -1 on error, 0 on success.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval -1 on error.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0 on success.</span><br><span>  *</span><br><span>  */</span><br><span> static int create_addr_from_peer(struct sip_pvt *dialog, struct sip_peer *peer)</span><br><span>@@ -6841,8 +6847,8 @@</span><br><span>  *</span><br><span>  * Thought: For realtime, we should probably update storage with inuse counter...</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return 0 if call is ok (no call limit, below threshold)</span><br><span style="color: hsl(0, 100%, 40%);">- *   -1 on rejection of call</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0 if call is ok (no call limit, below threshold).</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval -1 on rejection of call.</span><br><span>  *</span><br><span>  */</span><br><span> static int update_call_counter(struct sip_pvt *fup, int event)</span><br><span>@@ -8858,8 +8864,6 @@</span><br><span>  *</span><br><span>  * \param pvt SIP private structure to change callid</span><br><span>  * \param callid Specified new callid to use.  NULL if generate new callid.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void change_callid_pvt(struct sip_pvt *pvt, const char *callid)</span><br><span> {</span><br><span>@@ -9146,7 +9150,7 @@</span><br><span>     return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief arguments used for Request/Response to matching */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief arguments used for Request/Response to matching */</span><br><span> struct match_req_args {</span><br><span>     int method;</span><br><span>  const char *callid;</span><br><span>@@ -9173,7 +9177,7 @@</span><br><span>  SIP_REQ_FORKED, /* An outgoing request has been forked as result of receiving two differing 200ok responses. */</span><br><span> };</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span>  * \brief Match a incoming Request/Response to a dialog</span><br><span>  *</span><br><span>  * \retval enum match_req_res indicating if the dialog matches the arg</span><br><span>@@ -10050,7 +10054,8 @@</span><br><span> /*!</span><br><span>   \brief Determine whether a SIP message contains an SDP in its body</span><br><span>   \param req the SIP request to process</span><br><span style="color: hsl(0, 100%, 40%);">-  \return 1 if SDP found, 0 if not found</span><br><span style="color: hsl(120, 100%, 40%);">+  \retval 1 if SDP found.</span><br><span style="color: hsl(120, 100%, 40%);">+  \retval 0 if not found.</span><br><span> </span><br><span>   Also updates req->sdp_start and req->sdp_count to indicate where the SDP</span><br><span>   lives in the message body.</span><br><span>@@ -12779,7 +12784,9 @@</span><br><span> </span><br><span> /*!</span><br><span>  \brief Extract domain from SIP To/From header</span><br><span style="color: hsl(0, 100%, 40%);">- \return -1 on error, 1 if domain string is empty, 0 if domain was properly extracted</span><br><span style="color: hsl(120, 100%, 40%);">+ \retval -1 on error.</span><br><span style="color: hsl(120, 100%, 40%);">+ \retval 1 if domain string is empty.</span><br><span style="color: hsl(120, 100%, 40%);">+ \retval 0 if domain was properly extracted.</span><br><span>  \note TODO: Such code is all over SIP channel, there is a sense to organize</span><br><span>       this patern in one function</span><br><span> */</span><br><span>@@ -12885,8 +12892,6 @@</span><br><span>  * \brief Destroy all additional MESSAGE headers.</span><br><span>  *</span><br><span>  * \param pvt SIP private dialog struct.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void destroy_msg_headers(struct sip_pvt *pvt)</span><br><span> {</span><br><span>@@ -12904,8 +12909,6 @@</span><br><span>  * \param pvt SIP private dialog struct.</span><br><span>  * \param hdr_name Name of header for MESSAGE.</span><br><span>  * \param hdr_value Value of header for MESSAGE.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void add_msg_header(struct sip_pvt *pvt, const char *hdr_name, const char *hdr_value)</span><br><span> {</span><br><span>@@ -14124,7 +14127,7 @@</span><br><span> }</span><br><span> </span><br><span> /*! \brief Used for 200 OK and 183 early media</span><br><span style="color: hsl(0, 100%, 40%);">-      \return Will return XMIT_ERROR for network errors.</span><br><span style="color: hsl(120, 100%, 40%);">+    \retval XMIT_ERROR for network errors.</span><br><span> */</span><br><span> static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable, int oldsdp, int rpid)</span><br><span> {</span><br><span>@@ -14275,7 +14278,7 @@</span><br><span>        return send_request(p, &req, XMIT_CRITICAL, p->ocseq);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief Remove URI parameters at end of URI, not in username part though */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Remove URI parameters at end of URI, not in username part though */</span><br><span> static char *remove_uri_parameters(char *uri)</span><br><span> {</span><br><span>    char *atsign;</span><br><span>@@ -19979,7 +19982,9 @@</span><br><span> }</span><br><span> </span><br><span> /*! \brief  Report Peer status in character string</span><br><span style="color: hsl(0, 100%, 40%);">- *  \return 0 if peer is unreachable, 1 if peer is online, -1 if unmonitored</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0 if peer is unreachable.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 1 if peer is online.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval -1 if unmonitored.</span><br><span>  */</span><br><span> </span><br><span> </span><br><span>@@ -23060,7 +23065,7 @@</span><br><span> }</span><br><span> </span><br><span> /*! \brief  reply to authentication for outbound registrations</span><br><span style="color: hsl(0, 100%, 40%);">-\return     Returns -1 if we have no auth</span><br><span style="color: hsl(120, 100%, 40%);">+\retval  -1 if we have no auth</span><br><span> \note  This is used for register= servers in sip.conf, SIP proxies we register</span><br><span>      with  for receiving calls from.  */</span><br><span> static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod,  char *digest, int digest_len)</span><br><span>@@ -23136,7 +23141,7 @@</span><br><span> }</span><br><span> </span><br><span> /*! \brief  Build reply digest</span><br><span style="color: hsl(0, 100%, 40%);">-\return      Returns -1 if we have no auth</span><br><span style="color: hsl(120, 100%, 40%);">+\retval -1 if we have no auth</span><br><span> \note   Build digest challenge for authentication of registrations and calls</span><br><span>         Also used for authentication of BYE</span><br><span> */</span><br><span>@@ -23979,8 +23984,6 @@</span><br><span>  * \param cause Hangup cause to queue.  Zero if no cause.</span><br><span>  *</span><br><span>  * \pre p and p->owner are locked.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void sip_queue_hangup_cause(struct sip_pvt *p, int cause)</span><br><span> {</span><br><span>@@ -24564,7 +24567,7 @@</span><br><span>        }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief Handle SIP response in NOTIFY transaction</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Handle SIP response in NOTIFY transaction</span><br><span>        We've sent a NOTIFY, now handle responses to it</span><br><span>   */</span><br><span> static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno)</span><br><span>@@ -24618,7 +24621,7 @@</span><br><span>    }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief Handle SIP response in SUBSCRIBE transaction */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Handle SIP response in SUBSCRIBE transaction */</span><br><span> static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno)</span><br><span> {</span><br><span>        if (p->subscribed == CALL_COMPLETION) {</span><br><span>@@ -24705,7 +24708,7 @@</span><br><span>         }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief Handle SIP response in REFER transaction</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Handle SIP response in REFER transaction</span><br><span>    We've sent a REFER, now handle responses to it</span><br><span>   */</span><br><span> static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno)</span><br><span>@@ -25069,7 +25072,7 @@</span><br><span> /*!</span><br><span>  * \internal</span><br><span>  * \brief Handle auth requests to a MESSAGE request</span><br><span style="color: hsl(0, 100%, 40%);">- * \return TRUE if authentication failed.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval TRUE if authentication failed.</span><br><span>  */</span><br><span> static int do_message_auth(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno)</span><br><span> {</span><br><span>@@ -25652,8 +25655,8 @@</span><br><span> </span><br><span> /*! \brief Get tag from packet</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Returns the pointer to the provided tag buffer,</span><br><span style="color: hsl(0, 100%, 40%);">- *         or NULL if the tag was not found.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return pointer to the provided tag buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval NULL if the tag was not found.</span><br><span>  */</span><br><span> static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize)</span><br><span> {</span><br><span>@@ -26203,8 +26206,9 @@</span><br><span>     return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*</span><br><span style="color: hsl(0, 100%, 40%);">- * \internal \brief Check Session Timers for an INVITE request</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Check Session Timers for an INVITE request</span><br><span>  *</span><br><span>  * \retval 0 ok</span><br><span>  * \retval -1 failure</span><br><span>@@ -27247,7 +27251,7 @@</span><br><span>  * we may send out.</span><br><span>  *</span><br><span>  * \param chan The new outbound channel</span><br><span style="color: hsl(0, 100%, 40%);">- * \param user_data A blind_transfer_cb_data struct</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param user_data_wrapper A blind_transfer_cb_data struct</span><br><span>  * \param transfer_type Unused</span><br><span>  */</span><br><span> static void blind_transfer_cb(struct ast_channel *chan, struct transfer_channel_data *user_data_wrapper,</span><br><span>@@ -29378,7 +29382,8 @@</span><br><span> </span><br><span> /*! \brief Read data from SIP UDP socket</span><br><span> \note sipsock_read locks the owner channel while we are processing the SIP message</span><br><span style="color: hsl(0, 100%, 40%);">-\return 1 on error, 0 on success</span><br><span style="color: hsl(120, 100%, 40%);">+\retval 1 on error.</span><br><span style="color: hsl(120, 100%, 40%);">+\retval 0 on success.</span><br><span> \note Successful messages is connected to SIP call and forwarded to handle_incoming()</span><br><span> */</span><br><span> static int sipsock_read(int *id, int fd, short events, void *ignore)</span><br><span>@@ -29755,7 +29760,8 @@</span><br><span>  *  \note Both peer and associated sip_pvt must be unlocked prior to calling this function.</span><br><span>  *  It's possible that this function will get called during peer destruction as final messages</span><br><span>  *  are processed.  The peer will still be valid however.</span><br><span style="color: hsl(0, 100%, 40%);">- *  \returns -1 on failure, 0 on success</span><br><span style="color: hsl(120, 100%, 40%);">+ *  \retval -1 on failure.</span><br><span style="color: hsl(120, 100%, 40%);">+ *  \retval 0 on success.</span><br><span>  */</span><br><span> static int sip_send_mwi_to_peer(struct sip_peer *peer, int cache_only)</span><br><span> {</span><br><span>@@ -31074,7 +31080,7 @@</span><br><span> </span><br><span> /*!</span><br><span>   \brief Handle T.38 configuration options common to users and peers</span><br><span style="color: hsl(0, 100%, 40%);">-  \returns non-zero if any config options were handled, zero otherwise</span><br><span style="color: hsl(120, 100%, 40%);">+  \return non-zero if any config options were handled, zero otherwise</span><br><span> */</span><br><span> static int handle_t38_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v,</span><br><span>                         unsigned int *maxdatagram)</span><br><span>@@ -31119,7 +31125,7 @@</span><br><span>   \param flags array of three struct ast_flags</span><br><span>   \param mask array of three struct ast_flags</span><br><span>   \param v linked list of config variables to process</span><br><span style="color: hsl(0, 100%, 40%);">-  \returns non-zero if any config options were handled, zero otherwise</span><br><span style="color: hsl(120, 100%, 40%);">+  \return non-zero if any config options were handled, zero otherwise</span><br><span> */</span><br><span> static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v)</span><br><span> {</span><br><span>@@ -31353,8 +31359,6 @@</span><br><span>  * \brief Realm authentication container destructor.</span><br><span>  *</span><br><span>  * \param obj Container object to destroy.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void destroy_realm_authentication(void *obj)</span><br><span> {</span><br><span>@@ -31373,8 +31377,6 @@</span><br><span>  * \param credentials Realm authentication container to create/add authentication credentials.</span><br><span>  * \param configuration Credential configuration value.</span><br><span>  * \param lineno Line number in config file.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void add_realm_authentication(struct sip_auth_container **credentials, const char *configuration, int lineno)</span><br><span> {</span><br><span>diff --git a/channels/dahdi/bridge_native_dahdi.c b/channels/dahdi/bridge_native_dahdi.c</span><br><span>index 46fc726..73f2fcf 100644</span><br><span>--- a/channels/dahdi/bridge_native_dahdi.c</span><br><span>+++ b/channels/dahdi/bridge_native_dahdi.c</span><br><span>@@ -133,8 +133,6 @@</span><br><span>  *</span><br><span>  * \param bridge What to operate upon.</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span>  * \note On entry, bridge is already locked.</span><br><span>  */</span><br><span> static void native_stop(struct ast_bridge *bridge)</span><br><span>@@ -177,8 +175,6 @@</span><br><span>  *</span><br><span>  * \param bridge What to operate upon.</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span>  * \note On entry, bridge is already locked.</span><br><span>  */</span><br><span> static void native_request_stop(struct ast_bridge *bridge)</span><br><span>@@ -476,8 +472,6 @@</span><br><span>  *</span><br><span>  * \param bridge What to operate upon.</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span>  * \note On entry, bridge may or may not already be locked.</span><br><span>  * However, it can be accessed as if it were locked.</span><br><span>  */</span><br><span>@@ -885,8 +879,6 @@</span><br><span>  * \internal</span><br><span>  * \brief Destroy the DAHDI native bridge support.</span><br><span>  * \since 12.0.0</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> void dahdi_native_unload(void)</span><br><span> {</span><br><span>diff --git a/channels/iax2/codec_pref.c b/channels/iax2/codec_pref.c</span><br><span>index 684f921..cadc92f 100644</span><br><span>--- a/channels/iax2/codec_pref.c</span><br><span>+++ b/channels/iax2/codec_pref.c</span><br><span>@@ -395,8 +395,6 @@</span><br><span>  * \param pref Codec preference list to append the given bitfield.</span><br><span>  * \param bitfield Format bitfield to append.</span><br><span>  * \param framing Framing size of the codec.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void iax2_codec_pref_append_bitfield(struct iax2_codec_pref *pref, uint64_t bitfield, unsigned int framing)</span><br><span> {</span><br><span>diff --git a/channels/iax2/include/firmware.h b/channels/iax2/include/firmware.h</span><br><span>index a211c5d..fba1afb 100644</span><br><span>--- a/channels/iax2/include/firmware.h</span><br><span>+++ b/channels/iax2/include/firmware.h</span><br><span>@@ -32,8 +32,6 @@</span><br><span>  *</span><br><span>  * Searches the IAX firmware directory, adding new firmware that is available</span><br><span>  * and removing firmware that is no longer available.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> void iax_firmware_reload(void);</span><br><span> </span><br><span>@@ -95,8 +93,6 @@</span><br><span>  *</span><br><span>  * The \c callback function receives a pointer to the firmware header and the</span><br><span>  * value of the \c user_data argument that was passed in, which may be \c NULL.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> void iax_firmware_traverse(const char *prefix,</span><br><span>         int (*callback)(struct ast_iax2_firmware_header *header, void *user_data),</span><br><span>diff --git a/channels/sig_analog.c b/channels/sig_analog.c</span><br><span>index 33c2699..64f1114 100644</span><br><span>--- a/channels/sig_analog.c</span><br><span>+++ b/channels/sig_analog.c</span><br><span>@@ -595,8 +595,6 @@</span><br><span>  * \note</span><br><span>  * Because deadlock avoidance may have been necessary, you need to confirm</span><br><span>  * the state of things before continuing.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> static void analog_lock_sub_owner(struct analog_pvt *pvt, enum analog_sub sub_idx)</span><br><span> {</span><br><span>@@ -3994,8 +3992,6 @@</span><br><span>  * \since 1.8</span><br><span>  *</span><br><span>  * \param doomed Analog private structure to delete.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span>  */</span><br><span> void analog_delete(struct analog_pvt *doomed)</span><br><span> {</span><br><span>diff --git a/channels/sip/config_parser.c b/channels/sip/config_parser.c</span><br><span>index 64cb66a..b4d4fe5 100644</span><br><span>--- a/channels/sip/config_parser.c</span><br><span>+++ b/channels/sip/config_parser.c</span><br><span>@@ -90,7 +90,8 @@</span><br><span> </span><br><span>  ast_copy_string(buf, value, sizeof(buf));</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-   /*! register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]</span><br><span style="color: hsl(120, 100%, 40%);">+    /*</span><br><span style="color: hsl(120, 100%, 40%);">+     * register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]</span><br><span>     * becomes</span><br><span>    *   userpart => [peer?][transport://]user[@domain][:secret[:authuser]]</span><br><span>    *   hostpart => host[:port][/extension][~expiry]</span><br><span>@@ -105,7 +106,7 @@</span><br><span>           return -1;</span><br><span>   }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-   /*!</span><br><span style="color: hsl(120, 100%, 40%);">+   /*</span><br><span>    * pre1.peer => peer</span><br><span>       * pre1.userpart => [transport://]user[@domain][:secret[:authuser]]</span><br><span>        * hostpart => host[:port][/extension][~expiry]</span><br><span>@@ -116,7 +117,7 @@</span><br><span>             pre1.peer = NULL;</span><br><span>    }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-   /*!</span><br><span style="color: hsl(120, 100%, 40%);">+   /*</span><br><span>    * pre1.peer => peer</span><br><span>       * pre2.transport = transport</span><br><span>         * pre2.userpart => user[@domain][:secret[:authuser]]</span><br><span>@@ -135,7 +136,7 @@</span><br><span>               return -1;</span><br><span>   }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-   /*!</span><br><span style="color: hsl(120, 100%, 40%);">+   /*</span><br><span>    * pre1.peer => peer</span><br><span>       * pre2.transport = transport</span><br><span>         * user1.userpart => user[@domain]</span><br><span>@@ -145,7 +146,7 @@</span><br><span>   */</span><br><span>  AST_NONSTANDARD_RAW_ARGS(user1, pre2.userpart, ':');</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-        /*!</span><br><span style="color: hsl(120, 100%, 40%);">+   /*</span><br><span>    * pre1.peer => peer</span><br><span>       * pre2.transport = transport</span><br><span>         * user1.userpart => user[@domain]</span><br><span>@@ -156,7 +157,7 @@</span><br><span>   */</span><br><span>  AST_NONSTANDARD_RAW_ARGS(host1, hostpart, '~');</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-     /*!</span><br><span style="color: hsl(120, 100%, 40%);">+   /*</span><br><span>    * pre1.peer => peer</span><br><span>       * pre2.transport = transport</span><br><span>         * user1.userpart => user[@domain]</span><br><span>@@ -168,7 +169,7 @@</span><br><span>   */</span><br><span>  AST_NONSTANDARD_RAW_ARGS(host2, host1.hostpart, '/');</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-       /*!</span><br><span style="color: hsl(120, 100%, 40%);">+   /*</span><br><span>    * pre1.peer => peer</span><br><span>       * pre2.transport = transport</span><br><span>         * user1.userpart => user[@domain]</span><br><span>@@ -181,32 +182,32 @@</span><br><span>         */</span><br><span>  AST_NONSTANDARD_RAW_ARGS(host3, host2.hostpart, ':');</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-       /*!</span><br><span style="color: hsl(0, 100%, 40%);">-       * pre1.peer => peer</span><br><span style="color: hsl(0, 100%, 40%);">-          * pre2.transport = transport</span><br><span style="color: hsl(0, 100%, 40%);">-    * user2.user => user</span><br><span style="color: hsl(0, 100%, 40%);">-         * user2.domain => domain</span><br><span style="color: hsl(0, 100%, 40%);">-     * user1.secret => secret</span><br><span style="color: hsl(0, 100%, 40%);">-     * user1.authuser => authuser</span><br><span style="color: hsl(0, 100%, 40%);">-         * host3.host => host</span><br><span style="color: hsl(0, 100%, 40%);">-         * host3.port => port</span><br><span style="color: hsl(0, 100%, 40%);">-         * host2.extension => extension</span><br><span style="color: hsl(0, 100%, 40%);">-       * host1.expiry => expiry</span><br><span style="color: hsl(120, 100%, 40%);">+ /*</span><br><span style="color: hsl(120, 100%, 40%);">+     * pre1.peer => peer</span><br><span style="color: hsl(120, 100%, 40%);">+        * pre2.transport = transport</span><br><span style="color: hsl(120, 100%, 40%);">+  * user2.user => user</span><br><span style="color: hsl(120, 100%, 40%);">+       * user2.domain => domain</span><br><span style="color: hsl(120, 100%, 40%);">+   * user1.secret => secret</span><br><span style="color: hsl(120, 100%, 40%);">+   * user1.authuser => authuser</span><br><span style="color: hsl(120, 100%, 40%);">+       * host3.host => host</span><br><span style="color: hsl(120, 100%, 40%);">+       * host3.port => port</span><br><span style="color: hsl(120, 100%, 40%);">+       * host2.extension => extension</span><br><span style="color: hsl(120, 100%, 40%);">+     * host1.expiry => expiry</span><br><span>          */</span><br><span>  AST_NONSTANDARD_RAW_ARGS(user2, user1.userpart, '@');</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-       /*!</span><br><span style="color: hsl(0, 100%, 40%);">-       * pre1.peer => peer</span><br><span style="color: hsl(0, 100%, 40%);">-          * pre2.transport = transport</span><br><span style="color: hsl(0, 100%, 40%);">-    * user2.user => user</span><br><span style="color: hsl(0, 100%, 40%);">-         * user2.domain => domain</span><br><span style="color: hsl(0, 100%, 40%);">-     * user1.secret => secret</span><br><span style="color: hsl(0, 100%, 40%);">-     * user3.authuser => authuser</span><br><span style="color: hsl(0, 100%, 40%);">-         * user3.domainport => domainport</span><br><span style="color: hsl(0, 100%, 40%);">-     * host3.host => host</span><br><span style="color: hsl(0, 100%, 40%);">-         * host3.port => port</span><br><span style="color: hsl(0, 100%, 40%);">-         * host2.extension => extension</span><br><span style="color: hsl(0, 100%, 40%);">-       * host1.expiry => expiry</span><br><span style="color: hsl(120, 100%, 40%);">+ /*</span><br><span style="color: hsl(120, 100%, 40%);">+     * pre1.peer => peer</span><br><span style="color: hsl(120, 100%, 40%);">+        * pre2.transport = transport</span><br><span style="color: hsl(120, 100%, 40%);">+  * user2.user => user</span><br><span style="color: hsl(120, 100%, 40%);">+       * user2.domain => domain</span><br><span style="color: hsl(120, 100%, 40%);">+   * user1.secret => secret</span><br><span style="color: hsl(120, 100%, 40%);">+   * user3.authuser => authuser</span><br><span style="color: hsl(120, 100%, 40%);">+       * user3.domainport => domainport</span><br><span style="color: hsl(120, 100%, 40%);">+   * host3.host => host</span><br><span style="color: hsl(120, 100%, 40%);">+       * host3.port => port</span><br><span style="color: hsl(120, 100%, 40%);">+       * host2.extension => extension</span><br><span style="color: hsl(120, 100%, 40%);">+     * host1.expiry => expiry</span><br><span>          */</span><br><span>  AST_NONSTANDARD_RAW_ARGS(user3, user1.authuser, ':');</span><br><span> </span><br><span>diff --git a/channels/sip/include/reqresp_parser.h b/channels/sip/include/reqresp_parser.h</span><br><span>index a0634f6..67d9da4 100644</span><br><span>--- a/channels/sip/include/reqresp_parser.h</span><br><span>+++ b/channels/sip/include/reqresp_parser.h</span><br><span>@@ -85,7 +85,7 @@</span><br><span> /*!</span><br><span>  * \brief  Get caller id name from SIP headers, copy into output buffer</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval input string pointer placed after display-name field if possible</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return input string pointer placed after display-name field if possible</span><br><span>  */</span><br><span> const char *get_calleridname(const char *input, char *output, size_t outputsize);</span><br><span> </span><br><span>@@ -173,9 +173,9 @@</span><br><span>  * item is found that is not supported, it is copied to the unsupported</span><br><span>  * out buffer.</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param option list</span><br><span style="color: hsl(0, 100%, 40%);">- * \param unsupported out buffer (optional)</span><br><span style="color: hsl(0, 100%, 40%);">- * \param unsupported out buffer length (optional)</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param options list</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in,out] unsupported buffer (optional)</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in,out] unsupported_len buffer length</span><br><span>  *</span><br><span>  * \note Because this function can be called multiple times, it will append</span><br><span>  * whatever options are specified in \c options to \c unsupported. Callers</span><br><span>@@ -242,7 +242,7 @@</span><br><span>  */</span><br><span> struct sip_via *parse_via(const char *header);</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span>  * \brief Free parsed Via data.</span><br><span>  */</span><br><span> void free_via(struct sip_via *v);</span><br><span>diff --git a/channels/sip/include/route.h b/channels/sip/include/route.h</span><br><span>index 3221cce..13acd2c 100644</span><br><span>--- a/channels/sip/include/route.h</span><br><span>+++ b/channels/sip/include/route.h</span><br><span>@@ -57,7 +57,7 @@</span><br><span>  * \param len Length of hop not including null terminator</span><br><span>  * \param inserthead If true then inserted the new route to the top of the list</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval Pointer to null terminated copy of URI on success</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return Pointer to null terminated copy of URI on success</span><br><span>  * \retval NULL on error</span><br><span>  */</span><br><span> const char *sip_route_add(struct sip_route *route, const char *uri, size_t len, int inserthead);</span><br><span>@@ -65,15 +65,12 @@</span><br><span> /*!</span><br><span>  * \brief Add routes from header</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \note This procedure is for headers that require use of <brackets>.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \note This procedure is for headers that require use of \<brackets\>.</span><br><span>  */</span><br><span> void sip_route_process_header(struct sip_route *route, const char *header, int inserthead);</span><br><span> </span><br><span> /*!</span><br><span>  * \brief copy route-set</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval non-zero on failure</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval 0 on success</span><br><span>  */</span><br><span> void sip_route_copy(struct sip_route *dst, const struct sip_route *src);</span><br><span> </span><br><span>@@ -94,7 +91,7 @@</span><br><span>  * \param formatcli Add's space after comma's, print's N/A if list is empty.</span><br><span>  * \param skip Number of hops to skip</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval an allocated struct ast_str on success</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return an allocated struct ast_str on success</span><br><span>  * \retval NULL on failure</span><br><span>  */</span><br><span> struct ast_str *sip_route_list(const struct sip_route *route, int formatcli, int skip)</span><br><span>diff --git a/channels/sip/include/sip.h b/channels/sip/include/sip.h</span><br><span>index f5b7831..bcc1cf8 100644</span><br><span>--- a/channels/sip/include/sip.h</span><br><span>+++ b/channels/sip/include/sip.h</span><br><span>@@ -841,7 +841,7 @@</span><br><span>   unsigned int reqsipoptions; /*!< Items needed for Required header in responses */</span><br><span> };</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/* \brief given a sip_request and an offset, return the char * that resides there</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief given a sip_request and an offset, return the char * that resides there</span><br><span>  *</span><br><span>  * It used to be that rlpart1, rlpart2, and the header and line arrays were character</span><br><span>  * pointers. They are now offsets into the ast_str portion of the sip_request structure.</span><br><span>diff --git a/channels/sip/reqresp_parser.c b/channels/sip/reqresp_parser.c</span><br><span>index 37602d6..c72c322 100644</span><br><span>--- a/channels/sip/reqresp_parser.c</span><br><span>+++ b/channels/sip/reqresp_parser.c</span><br><span>@@ -690,7 +690,7 @@</span><br><span> </span><br><span> /*! \brief  Get caller id name from SIP headers, copy into output buffer</span><br><span>  *</span><br><span style="color: hsl(0, 100%, 40%);">- *  \retval input string pointer placed after display-name field if possible</span><br><span style="color: hsl(120, 100%, 40%);">+ *  \return input string pointer placed after display-name field if possible</span><br><span>  */</span><br><span> const char *get_calleridname(const char *input, char *output, size_t outputsize)</span><br><span> {</span><br><span>@@ -1685,10 +1685,6 @@</span><br><span>  * builds a bit field representing all the SIP options in that field. When an</span><br><span>  * item is found that is not supported, it is copied to the unsupported</span><br><span>  * out buffer.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param options list</span><br><span style="color: hsl(0, 100%, 40%);">- * \param unsupported out buffer (optional)</span><br><span style="color: hsl(0, 100%, 40%);">- * \param unsupported_len out buffer length (optional)</span><br><span>  */</span><br><span> unsigned int parse_sip_options(const char *options, char *unsupported, size_t unsupported_len)</span><br><span> {</span><br><span></span><br></pre><div style="white-space:pre-wrap"></div><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/17558">change 17558</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/17558"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 19 </div>
<div style="display:none"> Gerrit-Change-Id: Ia8811ac12b93ff8c18164699c6fbc604cb0a23f7 </div>
<div style="display:none"> Gerrit-Change-Number: 17558 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: Alexander Traud <pabstraud@compuserve.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>