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

[Tzafrir Cohen]

On Thu, Jul 17, 2008 at 12:02:54AM +0200, Michiel van Baak wrote:
> On 16:43, Wed 16 Jul 08, Russell Bryant wrote:
> > bkruse wrote:
> > > This message is geared towards coming up with a way to access and store 
> > > the documentation,
> > > and not so much the functionality of using the XML to do cool stuff like 
> > > language support, dialplan
> > > validiation, dialplan generation (based on schema), etc.
> > 
> > After some thought and discussion, I really think we should shelve the 
> > debate about the storage method of this information.
> > 
> > Right now, I think we should focus on the format of the data, and the 
> > Asterisk code that makes use of it.  We can leave the mechanics related 
> > to storage and distribution as an implementation detail to be decided 
> > upon before merging.
> > 
> > That decision really shouldn't affect all of the conversions of existing 
> > documentation, and most of the Asterisk code that uses it, which are the 
> > most important parts of this project.
> 
> I agree.
> 
> After some discussion we found out we have 1 case to cover, and then we
> can start doing all the /*** DOCUMENTATION ***/ stuff:
> 
> *If applications/functions
> 
> Take ExecIf as example.
> We have three seperators here: ?:,
> 
> Anyone has any idea how to put that into the xml format we have now ?

','?

IIRC ',' should be replaced with a generic "parameters separator", as
its value is not known at compile time (,/|).

So what we have here are groups of parameters? 

But do we really want a full syntax tree there?

-- 
               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