[asterisk-dev] XML documentation of apps/functions/the_rest_of_the_world

[Michiel van Baak]

On 12:22, Tue 08 Jul 08, Tilghman Lesher wrote:
> On Tuesday 08 July 2008 11:30:42 Michiel van Baak wrote:
> > Hi all,
> >
> > Olle already mentioned it briefly, but I wanted to devote a whole post
> > to it:
> > We are currently working on defining and implementing an XML format for
> > apps/function/etc documentation.
> >
> > The goal of this project is to convert the static documentation in the
> > sourcecode into a parseable format that will be loaded at runtime.
> > Right now, the apps for example, have a static char description that
> > documents all the options etc. This info can only be used inside
> > asterisk on the CLI with 'core show application FOO'
> 
> XML is fine for documentation, but I'd prefer to see it parsed at build time,
> not at runtime.  There is no good reason to shift that parsing to runtime.

It's loaded at the same place where the *descrip for an application is
loaded right now.

This way we only have the documentation loaded for the applications and
function that are actually loaded into asterisk.
For example, I dont need the MeetMe documentation loaded when app_meetme
is not loaded (because of no dahdi for example)

Maybe because I'm not a native english speaker there is some confusion.
The whole documentation.xml is generated on build time.
The module that is loaded by the loader will grab it's documentation
from this file.

If you want the details, have a look at ast_register_application2 in
main/pbx.c

-- 

Michiel van Baak
michiel at vanbaak.eu
http://michiel.vanbaak.eu
GnuPG key: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x71C946BD

"Why is it drug addicts and computer aficionados are both called users?"