Review Board 1.7.16


XML documentation for manager actions.

Review Request #250 - Created May 14, 2009 and submitted

Eliel SardaƱons
Reviewers
asterisk-dev
Asterisk
With this patch we allow to set manager actions documentation in xml format like we are already doing for applications/functions and agi commands.
It is possible to use both type of documentations (static and xml).
The patch was tested with xmldoc enabled and without xmldoc enabled (./configure --disable-xmldoc).
'core show application ....' -> tested
'core show function ...' -> tested
'agi show commands topic ...' -> tested

'manager show commands' -> tested
'manager show command Ping' -> tested
'manager show command Events' -> tested
/trunk/doc/appdocsxml.dtd
Revision 195447 New Change
1
  <!ELEMENT docs (application|function|agi)*>
1
  <!ELEMENT docs (application|function|agi|manager)*>
2
  <!ATTLIST docs xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude">
2
  <!ATTLIST docs xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude">
3

    
   
3

   
4
  <!ELEMENT xi:include (xi:fallback?) >
4
  <!ELEMENT xi:include (xi:fallback?) >
5
  <!ATTLIST xi:include 
5
  <!ATTLIST xi:include 
6
  xmlns:xi	CDATA       #FIXED    "http://www.w3.org/2001/XInclude"
6
  xmlns:xi	CDATA       #FIXED    "http://www.w3.org/2001/XInclude"
[+20] [20] 14 lines
[+20]
21

    
   
21

   
22
  <!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
22
  <!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
23
  <!ATTLIST agi name CDATA #REQUIRED>
23
  <!ATTLIST agi name CDATA #REQUIRED>
24
  <!ATTLIST agi language CDATA #REQUIRED>
24
  <!ATTLIST agi language CDATA #REQUIRED>
25

    
   
25

   

    
   
26
  <!ELEMENT manager (synopsis?,syntax?,description?,see-also?)>

    
   
27
  <!ATTLIST manager name CDATA #REQUIRED>

    
   
28
  <!ATTLIST manager language CDATA #REQUIRED>

    
   
29

   
26
  <!ELEMENT see-also (ref|xi:include)*>
30
  <!ELEMENT see-also (ref|xi:include)*>
27

    
   
31

   
28
  <!ELEMENT ref (#PCDATA)>
32
  <!ELEMENT ref (#PCDATA)>
29
  <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED>
33
  <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED>
30

    
   
34

   
[+20] [20] 52 lines
/trunk/include/asterisk/manager.h
Revision 195447 New Change
 
/trunk/include/asterisk/pbx.h
Revision 195447 New Change
 
/trunk/include/asterisk/xmldoc.h
Revision 195447 New Change
 
/trunk/main/features.c
Revision 195447 New Change
 
/trunk/main/manager.c
Revision 195447 New Change
 
/trunk/main/pbx.c
Revision 195447 New Change
 
/trunk/main/xmldoc.c
Revision 195447 New Change
 
/trunk/res/res_agi.c
Revision 195447 New Change
 
  1. /trunk/doc/appdocsxml.dtd: Loading...
  2. /trunk/include/asterisk/manager.h: Loading...
  3. /trunk/include/asterisk/pbx.h: Loading...
  4. /trunk/include/asterisk/xmldoc.h: Loading...
  5. /trunk/main/features.c: Loading...
  6. /trunk/main/manager.c: Loading...
  7. /trunk/main/pbx.c: Loading...
  8. /trunk/main/xmldoc.c: Loading...
  9. /trunk/res/res_agi.c: Loading...

https://reviewboard.asterisk.org/ runs on a server provided by Digium, Inc. and uses bandwidth donated to the open source Asterisk community by API Digital Communications in Huntsville, AL USA.
Please report problems with this site to asteriskteam@digium.com.