diff options
| author | Holger Hans Peter Freyther <zecke@selfish.org> | 2011-11-18 23:14:24 +0100 |
|---|---|---|
| committer | Holger Hans Peter Freyther <zecke@selfish.org> | 2012-07-25 11:58:58 +0200 |
| commit | 8297c819e985ba0d46752971b274b174098afceb (patch) | |
| tree | 51ac1f236957dfa6c1ce45574f25c6b875eef822 /doc/vty/vtydoc.xsd | |
| parent | aa5d0e88944fe3258260aedfbce9101301e35b44 (diff) | |
vty: Add xsd and a command that can generate the documentation.
When building the doxygen documentation do not remove the other
VTY documentation files in the doc/vty folder. Create a command
that can be installed to dump all nodes and commands as XML on
the given VTY. Create a schema for the XML file and a XSL-T script
that can merge the generated file with additional information.
Diffstat (limited to 'doc/vty/vtydoc.xsd')
| -rw-r--r-- | doc/vty/vtydoc.xsd | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/vty/vtydoc.xsd b/doc/vty/vtydoc.xsd new file mode 100644 index 00000000..53a67a36 --- /dev/null +++ b/doc/vty/vtydoc.xsd @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xs:schema + xmlns="urn:osmocom:xml:libosmocore:vty:doc:1.0" + xmlns:xs="http://www.w3.org/2001/XMLSchema" + targetNamespace="urn:osmocom:xml:libosmocore:vty:doc:1.0" + elementFormDefault="qualified" + attributeFormDefault="unqualified"> + + <xs:complexType name="ParamType"> + <xs:attribute name="name" type="xs:string" use="required" /> + <xs:attribute name="doc" type="xs:string" use="required" /> + </xs:complexType> + + <xs:complexType name="ParamsType"> + <xs:sequence> + <xs:element name="param" type="ParamType" maxOccurs="unbounded" /> + </xs:sequence> + </xs:complexType> + + <xs:complexType name="CommandType"> + <xs:sequence> + <xs:element name="doc" type="xs:string" minOccurs="0" maxOccurs="1" /> + <xs:element name="params" type="ParamsType" minOccurs="1" maxOccurs="1"/> + <xs:element name="enter" type="xs:string" minOccurs="0" maxOccurs="unbounded" /> + </xs:sequence> + <xs:attribute name="id" type="xs:string" use="required" /> + </xs:complexType> + + <xs:complexType name="NodeType"> + <xs:sequence> + <xs:element name="command" type="CommandType" minOccurs="0" maxOccurs="unbounded"/> + </xs:sequence> + <xs:attribute name="id" type="xs:anyURI"/> + <xs:attribute name="name" type="xs:string"/> + </xs:complexType> + + <!-- the main entry --> + <xs:element name="vtydoc"> + <xs:complexType> + <xs:sequence> + <xs:element name="node" type="NodeType" minOccurs="0" maxOccurs="unbounded"/> + </xs:sequence> + </xs:complexType> + </xs:element> +</xs:schema> + |