[asterisk-dev] Doxygen \since

Kevin Harwell kharwell at sangoma.com
Fri Feb 4 12:38:11 CST 2022


Thanks for the feedback everyone. It seems like generally speaking using
/since Doxygen command for the C API calls is not that useful and can be
left off.

A couple you brought up version documentation for public facing user API's
and protocols (AMI, ARI, dialplan functions etc...). AMI [1] and ARI [2]
have version numbers that get updated at Asterisk release time if a change
has occurred in either one.

I do agree too that having something like a /since value documented
somewhere for things like new or altered protocols would be helpful.
Unfortunately, we don't have a way to do that at this time, but would be
open to patches or simple ideas to include such. Especially if it could be
added to the automatic generation of documentation for such things.

[1]
https://wiki.asterisk.org/wiki/display/AST/Asterisk+Manager+Interface+%28AMI%29+Changes
[2] https://wiki.asterisk.org/wiki/display/AST/ARI+Versioning

>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20220204/5c7d3e86/attachment.html>


More information about the asterisk-dev mailing list