[asterisk-bugs] [JIRA] (ASTERISK-29762) channels: Fix for Doxygen

Alexander Traud (JIRA) noreply at issues.asterisk.org
Fri Nov 19 03:46:50 CST 2021


Alexander Traud created ASTERISK-29762:
------------------------------------------

             Summary: channels: Fix for Doxygen
                 Key: ASTERISK-29762
                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-29762
             Project: Asterisk
          Issue Type: Bug
      Security Level: None
          Components: Channels/chan_dahdi, Channels/chan_sip/General, Documentation
    Affects Versions: 19.0.0, 18.8.0, 16.22.0
            Reporter: Alexander Traud
            Severity: Trivial


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}}.



--
This message was sent by Atlassian JIRA
(v6.2#6252)



More information about the asterisk-bugs mailing list