[asterisk-dev] Feedback requested for future 1.6 API documentation

[Jeff Peeler]

On Tue, Mar 3, 2009 at 11:02 AM, Tzafrir Cohen <tzafrir.cohen at xorcom.com>wrote:

> On Tue, Mar 03, 2009 at 10:53:04AM -0600, Jeff Peeler wrote:
>
> > To summarize these threads, it appears that most are in favor of using
> > Doxygen in some fashion. Also, developers in the future will be
> responsible
> > as they make the API change to also change the associated documentation.
> To
> > get the process flowing, I'll find all the changes from 1.6.0 -> 1.6.1
> and
> > post it on Review Board. I hope posting it will help ensure the exact
> format
> > and content expected will stand for all future uses.
>
> I'd feel comfortable with doxygen if I know how this will look like. Can
> anybody give a short demonstration of how this document will be?


I'm starting to think the original API document does not serve as a good
model for what should be documented. Really, we should be able to use mostly
what we already have unless somebody objects. I think the key difference can
be use of the \version command (seems like tag would be a better name, but
they say command). Then whenever an API is created or modified the \version
information can be updated to the next version to be released. I'm assuming
Doxygen supports parsing of specific tags, but if not a simple script could
do so.

-- 
Jeff Peeler
Digium, Inc. | Software Developer
445 Jan Davis Drive NW - Huntsville, AL 35806 - USA
Check us out at www.digium.com & www.asterisk.org
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.digium.com/pipermail/asterisk-dev/attachments/20090303/e46b6848/attachment.htm