[asterisk-bugs] [JIRA] (ASTERISK-29732) progdocs: Fix grouping for latest Doxygen

[Asterisk Team (JIRA)]

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

Asterisk Team commented on ASTERISK-29732:
------------------------------------------

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/].

> progdocs: Fix grouping for latest Doxygen
> -----------------------------------------
>
>                 Key: ASTERISK-29732
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-29732
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Documentation
>    Affects Versions: 16.22.0, 18.8.0, 19.0.0
>            Reporter: Alexander Traud
>            Severity: Trivial
>
> Since Doxygen 1.8.16, opening and closing a group must not be done as C comment but as Doxygen [special comment block|https://www.doxygen.nl/manual/docblocks.html#specialblock]. In other words, not just one asterisk but also an explanation mark is required so that Doxygen finds a group. Because the previous behavior was just a coincidence, such a wrong grouping does not give any error or warning. The issue was found in another project which had totally broken HTML documentation because of this. Places in code were found with:
> {code}
> grep -r '[^/]/[/*]\s*@}'
> {code}
> While testing
> {code}
> sudo apt install doxygen
> make progdocs
> {code}
> the file {{doxygen.log}} is created. Warnings are not printed to the Terminal but only to that file. That revealed several further grouping errors, like a closed group without opening it, or a opened group which was never closed.
> {code}
> channels/chan_sip.c:886: warning: unbalanced grouping commands
> include/asterisk/app.h:1509: warning: unbalanced grouping commands
> include/asterisk/astmm.h:318: warning: end of file with unbalanced grouping commands
> include/asterisk/mwi.h:581: warning: end of file while inside a group
> include/asterisk/pbx.h:1404: warning: unbalanced grouping commands
> include/asterisk/pbx.h:1442: warning: unbalanced grouping commands
> include/asterisk/rtp_engine.h:2908: warning: end of file while inside a group
> include/asterisk/stasis_app_mailbox.h:92: warning: end of file with unbalanced grouping commands
> {code}
> The attached patch fixes all found (via grep) and reported (as warning) grouping issues.



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