[asterisk-bugs] [JIRA] (ASTERISK-29743) bridges: Fix for Doxygen

[Friendly Automation (JIRA)]

    [ https://issues.asterisk.org/jira/browse/ASTERISK-29743?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=257028#comment-257028 ] 

Friendly Automation commented on ASTERISK-29743:
------------------------------------------------

Change 17392 merged by Friendly Automation:
bridges: Fix for Doxygen.

[https://gerrit.asterisk.org/c/asterisk/+/17392|https://gerrit.asterisk.org/c/asterisk/+/17392]

> bridges: Fix for Doxygen
> ------------------------
>
>                 Key: ASTERISK-29743
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-29743
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Bridges/bridge_holding, Bridges/bridge_softmix
>    Affects Versions: 16.22.0, 18.8.0, 19.0.0
>            Reporter: Alexander Traud
>            Assignee: 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}
> bridges/bridge_holding.c:416: warning: documented empty return type of deferred_action
> bridges/bridge_holding.c:116: warning: documented empty return type of participant_idle_mode_setup
> bridges/bridge_softmix.c:1043: warning: documented empty return type of clear_talking
> bridges/bridge_softmix.c:611: warning: argument 'participants' of command @param is not found in the argument list of sfu_topologies_on_join(struct ast_bridge *bridge, struct ast_bridge_channel *joiner)
> bridges/bridge_softmix.c:621: warning: The following parameter of sfu_topologies_on_join(struct ast_bridge *bridge, struct ast_bridge_channel *joiner) is not documented:
>   parameter 'bridge'
> bridges/bridge_softmix.c:1068: warning: documented empty return type of softmix_bridge_check_voice
> bridges/bridge_softmix.c:2131: warning: documented empty return type of softmix_bridge_stop
> bridges/bridge_softmix.c:1198: warning: documented empty return type of softmix_bridge_write_text
> bridges/bridge_softmix.c:890: warning: documented empty return type of softmix_bridge_write_video
> bridges/bridge_softmix.c:943: warning: documented empty return type of softmix_bridge_write_voice
> bridges/bridge_softmix.c:409: warning: documented empty return type of softmix_poke_thread
> {code}
> Beside those warning, there is a misuse of {{\retval}}: It allows a comma to give the same explanation to several return values. Therefore, if only one value is given, one may not use a comma after it. That issue was introduced more than 10 years ago with commit [7f23115|https://github.com/asterisk/asterisk/commit/7f23115].



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