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

[Kaloyan Kovachev]

> > > I've already suggested that the documentation be parsed and embedded
> > > directly within the module.  Then there is no confusion whatsoever about
> > > which documention should be sourced, or even if there is documentation at
> > > all.  If it's embedded, there is no confusion.  I realize that means you
> > > can't update it without recompiling, but then again, who really ever does
> > > that?
> >
> > What about having embeded in the module doc name and version and later look
> > in the docs folder for ${name}_${version}_${lang}.xml? We then may have
> > version 1.6.0 with the options for 1.6.0 and later when in 1.6.1 there are
> > new options (but the module is still compatible) loading the new module
> > will come with it's own docs. The version should be changed only when the
> > docs are changed (1.6.8 may still use 1.6.0 docs) and if 1.6.1 is missing
> > older minor version (1.6.0) may be used instead, but will issue a warning.
> > If the app is not from core, but localy modified or some other place the
> > name could be used like 'myCustom-Dial_1.6.0.34_en.xml'.
> 
> How does Asterisk know which version to display?  Worse, if there are multiple
> competing implementations (as with app_speak), which custom documentation
> should be used?
> 

Sorry i wasn't clear enough - the name and version are variables provided from
the module itself during module registration. This is what i meant with
'embeded in the module'

> -- 
> Tilghman
> 
> _______________________________________________
> --Bandwidth and Colocation Provided by http://www.api-digital.com--
> 
> AstriCon 2008 - September 22 - 25 Phoenix, Arizona
> Register Now: http://www.astricon.net
> 
> asterisk-dev mailing list
> To UNSUBSCRIBE or update options visit:
>    http://lists.digium.com/mailman/listinfo/asterisk-dev