dect
/
asterisk
Archived
13
0
Fork 0
Commit Graph

9 Commits

Author SHA1 Message Date
eliel cbbfdc573c Implement a new element in AstXML for AMI actions documentation.
A new xml element was created to manage the AMI actions documentation,
using AstXML.
To register a manager action using XML documentation it is now possible
using ast_manager_register_xml().
The CLI command 'manager show command' can be used to show the parsed
documentation.

Example manager xml documentation:
<manager name="ami action name" language="en_US">
    <synopsis>
        AMI action synopsis.
    </synopsis>
    <syntax>
        <xi:include xpointer="xpointer(...)" /> <-- for ActionID
        <parameter name="header1" required="true">
	    <para>Description</para>
	</parameter>
	...
    </syntax>
    <description>
        <para>AMI action description</para>
    </description>
    <see-also>
    	...
    </see-also>
</manager>



git-svn-id: http://svn.digium.com/svn/asterisk/trunk@196308 f38db490-d61c-443f-a65b-d21fe96a405b
2009-05-22 17:52:35 +00:00
eliel 1de32a5a62 Allow to include sections of other parts of the xml documentation.
Avoid duplicating xml documentation by allowing to include other parts of
the xml documentation using XInclude.
Example:
   <xi:include xpointer="xpointer(/docs/function[@name='CHANNEL']/synopsis)" />
(Insert this line to include the synopsis of the CHANNEL function xml
documentation).

It is also possible to include documentation from other files in the
'documentation/' directory using the href="" attribute inside a xinclude
element.

(closes issue #15107)
Reported by: lmadsen

(issue #14444)
Reported by: ewieling



git-svn-id: http://svn.digium.com/svn/asterisk/trunk@194982 f38db490-d61c-443f-a65b-d21fe96a405b
2009-05-16 20:01:22 +00:00
eliel f2fc79c88e Allow to specify an enumlist inside an enum.
It was not possible to use an enumlist inside an enum:
<enumlist>
   <enum name="aa">
      <enumlist>
         ...
      </enumlist>
   </enum>
</enumlist>
Now we will be able to insert as many levels as we want.

(closes issue #15112)
Reported by: lmadsen



git-svn-id: http://svn.digium.com/svn/asterisk/trunk@194635 f38db490-d61c-443f-a65b-d21fe96a405b
2009-05-15 13:23:37 +00:00
russell ec97528d9c argsep is used as an attribute for an argument, as well
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@165145 f38db490-d61c-443f-a65b-d21fe96a405b
2008-12-17 17:56:25 +00:00
eliel 20313cb12e Introduce XML documentation for:
- MeetMe()
  - MeetMeCount()
  - MeetMeChannelAdmin()
  - MeetMeAdmin()
  - SLAStation()
  - SLATrunk()

- Add an attribute to optionlist 'hasparams' with the same functionality as the one
we have in <parameter> and <argument> (the DTD was updated)
- Fix a leak when getting an attribute while parsing an <optionlist>.


git-svn-id: http://svn.digium.com/svn/asterisk/trunk@156575 f38db490-d61c-443f-a65b-d21fe96a405b
2008-11-13 15:46:06 +00:00
eliel d6ee75c629 - Add 'database del', 'database put' and 'set music' AGI commands XML documentation.
- Add to the DTD the possibility to put a parameter inside an <enum>.


git-svn-id: http://svn.digium.com/svn/asterisk/trunk@156087 f38db490-d61c-443f-a65b-d21fe96a405b
2008-11-12 02:20:05 +00:00
eliel f4ab4abaf3 Implement AGI XML documentation parsing functions.
A new <agi> element is used to describe the XML documentation.
We have the usual synopsis,syntax,description and seealso for AGI commands.
The CLI 'agi show commands' command was changed to show all the documentation se
ctions.



git-svn-id: http://svn.digium.com/svn/asterisk/trunk@156051 f38db490-d61c-443f-a65b-d21fe96a405b
2008-11-12 00:17:43 +00:00
eliel e418546c18 We now can have a reference to a filename inside a <see-also> tag.
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@154617 f38db490-d61c-443f-a65b-d21fe96a405b
2008-11-05 13:54:21 +00:00
russell b1f91b97d2 Merge changes from team/group/appdocsxml
This commit introduces the first phase of an effort to manage documentation of the
interfaces in Asterisk in an XML format.  Currently, a new format is available for
applications and dialplan functions.  A good number of conversions to the new format
are also included.

For more information, see the following message to asterisk-dev:

http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html


git-svn-id: http://svn.digium.com/svn/asterisk/trunk@153365 f38db490-d61c-443f-a65b-d21fe96a405b
2008-11-01 21:10:07 +00:00