[asterisk-bugs] [JIRA] (ASTERISK-29773) progdocs: doxyref.h outdated

[Alexander Traud (JIRA)]

Alexander Traud created ASTERISK-29773:
------------------------------------------

             Summary: progdocs: doxyref.h outdated
                 Key: ASTERISK-29773
                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-29773
             Project: Asterisk
          Issue Type: Bug
      Security Level: None
          Components: Documentation
    Affects Versions: 19.0.0, 18.8.0, 16.22.0
            Reporter: Alexander Traud
            Severity: Trivial


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.



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