[Home]

Summary:ASTERISK-29741: tests: Fix for Doxygen
Reporter:Alexander Traud (traud)Labels:
Date Opened:2021-11-15 07:34:43.000-0600Date Closed:2021-11-18 10:19:18.000-0600
Priority:TrivialRegression?
Status:Closed/CompleteComponents:Documentation Tests/General
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}
tests/test_voicemail_api.c:289: warning: End of list marker found without any preceding list items
tests/test_devicestate.c:243: warning: unable to resolve reference to 'result_states' for \ref command
tests/test_dns_naptr.c:47: warning: argument 'string' of command @param is not found in the argument list of generate_naptr_record(void *dns_record, char *buf)
tests/test_dns_naptr.c:58: warning: The following parameter of generate_naptr_record(void *dns_record, char *buf) is not documented:
 parameter 'dns_record'
tests/test_message.c:58: warning: unable to resolve reference to 'test_message_handler' for \ref command
tests/test_voicemail_api.c:411: warning: argument 'snapshot' of command @param is not found in the argument list of test_vm_api_create_voicemail_folder(const char *folder_path)
tests/test_voicemail_api.c:419: warning: The following parameter of test_vm_api_create_voicemail_folder(const char *folder_path) is not documented:
 parameter 'folder_path'
tests/test_voicemail_api.c:618: warning: Found unknown command '@default'
tests/test_voicemail_api.c:619: warning: Found unknown command '@default'
tests/test_voicemail_api.c:620: warning: Found unknown command '@default'
tests/test_voicemail_api.c:621: warning: Found unknown command '@default'
{code}
The most interesting warning is the first one: In test_voicemail_api.c, there are three dots at the (very) end of the line. Doxygen thinks that is part of a list. Although caused by commit [e47d3db|https://github.com/asterisk/asterisk/commit/e47d3db], I have no idea how something like that can happen. It happened nowhere in the source again.
Comments:By: Asterisk Team (asteriskteam) 2021-11-15 07:34:45.495-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 10:19:18.770-0600

Change 17364 merged by Friendly Automation:
tests: Fix for Doxygen.

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

By: Friendly Automation (friendly-automation) 2021-11-18 10:19:56.204-0600

Change 17384 merged by Friendly Automation:
tests: Fix for Doxygen.

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

By: Friendly Automation (friendly-automation) 2021-11-18 10:38:42.446-0600

Change 17385 merged by George Joseph:
tests: Fix for Doxygen.

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

By: Friendly Automation (friendly-automation) 2021-11-18 10:38:54.610-0600

Change 17386 merged by George Joseph:
tests: Fix for Doxygen.

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