Summary:	ASTERISK-29762: channels: Fix for Doxygen
Reporter:	Alexander Traud (traud)	Labels:
Date Opened:	2021-11-19 03:45:25.000-0600	Date Closed:	2021-11-19 09:02:08.000-0600
Priority:	Trivial	Regression?
Status:	Closed/Complete	Components:	Channels/chan_dahdi Channels/chan_sip/General Documentation
Versions:	16.22.0 18.8.0 19.0.0	Frequency of Occurrence
Related Issues:
Environment:		Attachments:
Description:	If all {{WARN_}} are enabled in the file {{doc/asterisk-ng-doxygen.in}}, the following appears in the file {{doxygen.log}}: {code} channels/chan_dahdi.c:1805: warning: documented empty return type of dahdi_ami_channel_event channels/chan_dahdi.c:5336: warning: documented empty return type of dahdi_iflist_extract channels/chan_dahdi.c:5286: warning: documented empty return type of dahdi_iflist_insert channels/chan_dahdi.c:3469: warning: documented empty return type of dahdi_lock_sub_owner channels/chan_dahdi.c:9148: warning: The following parameters of 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) are not documented:  parameter 'i'  parameter 'state'  parameter 'startpbx'  parameter 'idx'  parameter 'law'  parameter 'assignedids'  parameter 'requestor'  parameter 'callid' channels/chan_dahdi.c:19342: warning: documented empty return type of deep_copy_dahdi_chan_conf channels/chan_dahdi.c:3296: warning: documented empty return type of notify_message channels/dahdi/bridge_native_dahdi.c:891: warning: documented empty return type of dahdi_native_unload channels/dahdi/bridge_native_dahdi.c:484: warning: documented empty return type of native_request_start channels/dahdi/bridge_native_dahdi.c:184: warning: documented empty return type of native_request_stop channels/dahdi/bridge_native_dahdi.c:140: warning: documented empty return type of native_stop channels/dahdi/bridge_native_dahdi.h:38: warning: documented empty return type of dahdi_native_unload {code} {code} channels/chan_sip.c:29: warning: unable to resolve link to 'Config_sip' for \link command channels/chan_sip.c:2845: warning: argument 'data' of command @param is not found in the argument list of check_message_integrity(struct ast_str **request, struct ast_str **overflow) channels/chan_sip.c:3298: warning: documented empty return type of ref_proxy channels/chan_sip.c:2923: warning: The following parameters of sip_tcptls_read(struct sip_request *req, struct ast_tcptls_session_instance *tcptls_session, int authenticated, time_t start) are not documented:  parameter 'authenticated'  parameter 'start' channels/sip/config_parser.c:93: warning: Found unknown command '@domain' channels/sip/config_parser.c:93: warning: Found unknown command '@host' channels/sip/config_parser.c:95: warning: Found unknown command '@domain' channels/sip/config_parser.c:100: warning: Found unknown command '@domain' channels/sip/config_parser.c:106: warning: Found unknown command '@domain' channels/sip/config_parser.c:112: warning: Found unknown command '@domain' channels/sip/config_parser.c:120: warning: Found unknown command '@domain' channels/sip/config_parser.c:129: warning: Found unknown command '@domain' channels/sip/config_parser.c:139: warning: Found unknown command '@domain' channels/sip/config_parser.c:93: warning: Found unknown command '@domain' channels/sip/config_parser.c:93: warning: Found unknown command '@host' channels/sip/config_parser.c:95: warning: Found unknown command '@domain' channels/sip/config_parser.c:100: warning: Found unknown command '@domain' channels/sip/config_parser.c:106: warning: Found unknown command '@domain' channels/sip/config_parser.c:112: warning: Found unknown command '@domain' channels/sip/config_parser.c:120: warning: Found unknown command '@domain' channels/sip/config_parser.c:129: warning: Found unknown command '@domain' channels/sip/config_parser.c:139: warning: Found unknown command '@domain' channels/sip/reqresp_parser.c:1684: warning: argument 'option' of command @param is not found in the argument list of parse_sip_options(const char *options, char *unsupported, size_t unsupported_len) channels/sip/include/reqresp_parser.h:185: warning: argument 'unsupported' from the argument list of parse_sip_options has multiple @param documentation sections channels/sip/route.c:115: warning: documented empty return type of sip_route_copy channels/sip/include/route.h:68: warning: Unsupported xml/html tag <brackets> found channels/sip/include/route.h:78: warning: documented empty return type of sip_route_copy channels/sip/include/route.h:68: warning: Unsupported xml/html tag <brackets> found {code} Because those changes are small, I combine both in one change about the section {{/channels}}. Not to confuse with the already fixed module {{main/channel}}.
Comments:	By: Asterisk Team (asteriskteam) 2021-11-19 03:45:27.634-0600 Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution. Please note that log messages and other files should not be sent to the Sangoma Asterisk Team unless explicitly asked for. All files should be placed on this issue in a sanitized fashion as needed. A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report. Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process]. Please note that once your issue enters an open state it has been accepted. As Asterisk is an open source project there is no guarantee or timeframe on when your issue will be looked into. If you need expedient resolution you will need to find and pay a suitable developer. Asking for an update on your issue will not yield any progress on it and will not result in a response. All updates are posted to the issue when they occur. Please note that by submitting data, code, or documentation to Sangoma through JIRA, you accept the Terms of Use present at [https://www.asterisk.org/terms-of-use/|https://www.asterisk.org/terms-of-use/]. By: Friendly Automation (friendly-automation) 2021-11-19 09:02:09.580-0600 Change 17513 merged by Friendly Automation: channels: Fix for Doxygen. [https://gerrit.asterisk.org/c/asterisk/+/17513|https://gerrit.asterisk.org/c/asterisk/+/17513] By: Friendly Automation (friendly-automation) 2021-11-19 09:07:52.608-0600 Change 17560 merged by Friendly Automation: channels: Fix for Doxygen. [https://gerrit.asterisk.org/c/asterisk/+/17560|https://gerrit.asterisk.org/c/asterisk/+/17560] By: Friendly Automation (friendly-automation) 2021-11-19 09:09:48.049-0600 Change 17559 merged by Friendly Automation: channels: Fix for Doxygen. [https://gerrit.asterisk.org/c/asterisk/+/17559|https://gerrit.asterisk.org/c/asterisk/+/17559] By: Friendly Automation (friendly-automation) 2021-11-19 09:11:49.987-0600 Change 17558 merged by Friendly Automation: channels: Fix for Doxygen. [https://gerrit.asterisk.org/c/asterisk/+/17558|https://gerrit.asterisk.org/c/asterisk/+/17558]