[Home]

Summary:ASTERISK-29734: progdocs: Use Doxygen \example correctly
Reporter:Alexander Traud (traud)Labels:patch
Date Opened:2021-11-12 13:15:58.000-0600Date Closed:2021-11-18 08:20:47.000-0600
Priority:TrivialRegression?
Status:Closed/CompleteComponents:Documentation
Versions:16.22.0 18.8.0 19.0.0 Frequency of
Occurrence
Related
Issues:
Environment:Attachments:( 0) doxygen_example.patch
Description:{code}
sudo apt install doxygen
make progdocs
{code}
gives a warning in the file {{doxygen.log}}:
{code}
include/asterisk/strings.h:1126: warning: Example include/asterisk/strings.h was already documented. Ignoring documentation found here.
{code}
because {{strings.h}} contains the command {{\example}} twice. In other words, Doxygen adds the (whole) current file verbatim as source code. This makes sense only once.

Actually, the author of that documentation made a typo and instead meant the command {{\code}}. This warning message revealed another code section which is not declared as such.

Furthermore, with a grep project wide, another {{\example}} vs. {{\code}} was found. Finally, the only valid use of {{\example}} turned out to be a misuse as well.

All this is fixed by the attached patch.
Comments:By: Asterisk Team (asteriskteam) 2021-11-12 13:15:59.567-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-18 08:20:48.033-0600

Change 17350 merged by Friendly Automation:
progdocs: Use Doxygen \example correctly.

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

By: Friendly Automation (friendly-automation) 2021-11-18 09:14:06.791-0600

Change 17351 merged by George Joseph:
progdocs: Use Doxygen \example correctly.

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

By: Friendly Automation (friendly-automation) 2021-11-18 09:14:30.466-0600

Change 17349 merged by George Joseph:
progdocs: Use Doxygen \example correctly.

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

By: Friendly Automation (friendly-automation) 2021-11-18 09:21:21.377-0600

Change 17338 merged by George Joseph:
progdocs: Use Doxygen \example correctly.

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