[asterisk-dev] XML documentation of apps/functions/the_rest_of_the_world
Leif Madsen
leif.madsen at asteriskdocs.org
Wed Jul 9 09:48:17 CDT 2008
Michiel van Baak wrote:
> On 23:52, Tue 08 Jul 08, Jared Smith wrote:
>>
>> I'd rather see the parameter list look something like the following
>> pseudo-code:
>>
>> <parameter name="Technology/Resource" required="true" argsep="&">
>> The technology and resource of the device(s) to attempt to call.
>> </parameter>
>> <parameter name="Timeout" required="false">
>> The number of seconds to let the phone ring before continuing on to
>> the next priority in the current extension
>> </parameter>
>> <parameter name="Options" required="false">
>> <option name="name="A">
>> <argument name="x" required="true">
>> The file to play to the called party
>> </argument>
>> Play an announcement to the called party, using
>> <replaceable>x</replaceable> as the name of the file to play
>> </option>
>> <option name="C">
>> Reset the CDR for this call
>> </option>
>> ...
>> </parameter>
>> <parameter name="URL" required="false">
>> An optional URL that can be sent to the endpoint, if the endpoint
>> supports it
>> </parameter>
>
> at least this is more consistent.
> If others agree, I'll update the docs and app_dial.c
I really like the way this works as well. First time through I
understood what Jared was trying to accomplish, and it makes sense.
--
Leif Madsen
http://www.leifmadsen.com
http://www.oreilly.com/catalog/asterisk
More information about the asterisk-dev
mailing list