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

[Tzafrir Cohen]

On Tue, Jul 08, 2008 at 07:22:48PM +0200, Michiel van Baak wrote:
> On 12:11, Tue 08 Jul 08, Russell Bryant wrote:
> > Tzafrir Cohen wrote:
> > > Where is the documentation stored? How is it generated? What about
> > > external modules? What about modules of which an original version exists
> > > in the tree but I load a different version from elsewhere?
> > 
> > The documentation is stored in the source for convenience, and extracted 
> > in the same way that the menuselect related data is extracted, by using 
> > a small awk script.
> > 
> > After it is generated, the XML documentation would be installed so that 
> > i can be loaded at runtime.
> > 
> > I'd like to see a directory for this documentation, so that for external 
> > modules, additional documentation can easily be installed.
> 
> Good idea.
> Something like ${ASTVARLIBDIR}/documentation/* ?

${ASTDATADIR}/doc

So what happens if I load a module from my working copy or whatever that
has different documentation?

Docuemntation is now the version carried with the system, as opposed to
the version loaded from the module.

-- 
               Tzafrir Cohen
icq#16849755              jabber:tzafrir.cohen at xorcom.com
+972-50-7952406           mailto:tzafrir.cohen at xorcom.com
http://www.xorcom.com  iax:guest at local.xorcom.com/tzafrir