[Home]

Summary:ASTERISK-29773: progdocs: doxyref.h outdated
Reporter:Alexander Traud (traud)Labels:
Date Opened:2021-11-23 07:40:40.000-0600Date Closed:2021-11-29 08:54:02.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:
Description:When going for {{make prodocs}}, Doxygen is not able to resolve several references:
{code}
cdr/cdr_odbc.c:27: warning: unable to resolve reference to 'Config_cdr' for \ref command
cdr/cdr_pgsql.c:31: warning: unable to resolve reference to 'Config_cdr' for \ref command
cdr/cdr_syslog.c:26: warning: unable to resolve reference to 'Config_cdr' for \ref command
cdr/cdr_tds.c:22: warning: unable to resolve reference to 'Config_cdr' for \ref command
cel/cel_beanstalkd.c:29: warning: unable to resolve reference to 'AstCEL' for \ref command
cel/cel_custom.c:26: warning: unable to resolve reference to 'AstCEL' for \ref command
cel/cel_pgsql.c:35: warning: unable to resolve reference to 'Config_cel' for \ref command
cel/cel_radius.c:24: warning: unable to resolve reference to 'AstCEL' for \ref command
cel/cel_sqlite3_custom.c:31: warning: unable to resolve reference to 'AstCEL' for \ref command
cel/cel_tds.c:22: warning: unable to resolve reference to 'Config_cel' for \ref command
include/asterisk/doxyref.h:46: warning: unable to resolve reference to 'AJI_intro' for \ref command
include/asterisk/doxyref.h:50: warning: unable to resolve reference to 'AstENUM' for \ref command
include/asterisk/doxyref.h:52: warning: unable to resolve reference to 'AstSpeech' for \ref command
include/asterisk/doxyref.h:55: warning: unable to resolve reference to 'AstDebug' for \ref command
include/asterisk/doxyref.h:57: warning: unable to resolve reference to 'ConfigFiles' for \ref command
include/asterisk/doxyref.h:84: warning: unable to resolve reference to 'DataStores' for \ref command
include/asterisk/doxyref.h:86: warning: unable to resolve reference to 'AstDataRetrieval' for \ref command
include/asterisk/doxyref.h:166: warning: unable to resolve reference to 'Config_cdr' for \ref command
include/asterisk/doxyref.h:315: warning: unable to resolve reference to 'Config_cdr' for \ref command
{code}
In Asterisk 18 LTS, one additional warning appears:
{code}
cdr/cdr_syslog.c:26: warning: unable to resolve reference to 'Config_cdr' for \ref command
{code}
The causes for those are quite different. For example,
* {{AstDataRetrieval}} got removed for Asterisk 15 (see commit [325eece|https://github.com/asterisk/asterisk/commit/325eece])
* {{AJI_intro}} got removed for Asterisk 13 (see commit [6461d90|https://github.com/asterisk/asterisk/commit/6461d90] and [9783471|https://github.com/asterisk/asterisk/commit/9783471])
* {{AstCEL}} never existed  and probably {{Config_cel}} was meant.

The remaining pages got lost with commit [6461d90|https://github.com/asterisk/asterisk/commit/6c20cf2] back in the year 2012 already. I am not sure what was intended, whether that change was incomplete, work-in-progress, and more to come. Anyway, I removed all broken references to avoid any warning with Doxygen. If somebody knows alternatives for those, please, add them back. My main goal is to silence Doxygen for default user and developer installations, which is achieved with this change, at least as of today.
Comments:By: Asterisk Team (asteriskteam) 2021-11-23 07:40:41.545-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-29 08:54:03.091-0600

Change 17581 merged by Friendly Automation:
progdocs: Remove outdated references in doxyref.h.

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

By: Friendly Automation (friendly-automation) 2021-11-29 09:32:45.656-0600

Change 17575 merged by Friendly Automation:
progdocs: Remove outdated references in doxyref.h.

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

By: Friendly Automation (friendly-automation) 2021-11-29 09:34:11.845-0600

Change 17574 merged by Friendly Automation:
progdocs: Remove outdated references in doxyref.h.

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

By: Friendly Automation (friendly-automation) 2021-11-29 11:12:45.060-0600

Change 17580 merged by George Joseph:
progdocs: Remove outdated references in doxyref.h.

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