Where is the main documentation on for channels on docs.asterisk.org?

Development Documentation
1

I was grousing in another thread about local channel documentation being hard to find, and realized I should be the change and do something about it. Problem is: I can’t find where it’s supposed to be.

I see the channels in asterisk/channels at master · asterisk/asterisk · GitHub have inline documentation comments, but I don’t see them on API Documentation - Asterisk Documentation Are they missing or am I looking in the wrong place?

I found the chan_local source in asterisk/main/core_local.c at master · asterisk/asterisk · GitHub, but again I’m not sure where that’s rendered into the docs site. So same question as the channel docs.

2

Re-reading GitHub - asterisk/documentation: The Asterisk Documentation Project. I see channels and core are absent from that list. I’m assuming it’s a gap.

If that assumption is correct, is there a reason that’s omitted? I can look into making a PR but I don’t want to burn a lot of time figuring it out if there’s a reason for the gap.

3

XML documentation embedded in source code is rendered into the documentation site. You linked to core_local, which has documentation only for manager events. Those would appear in the manager events part of the API documentation.

The only reason for gaps in documentation is because noone has written any.

4

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.