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/example.xml | |
| 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/example.xml')
| -rw-r--r-- | doc/vty/example.xml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/vty/example.xml b/doc/vty/example.xml new file mode 100644 index 00000000..400c6340 --- /dev/null +++ b/doc/vty/example.xml @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?> +<vtydoc xmlns="urn:osmocom:xml:libosmocore:vty:doc:1.0"> + <!-- test a nested hierachy --> + <node id="mgcp" name="MGCP Node"> + <!-- define a command --> + <command id="foo_cmd"> + <doc>General docs</doc> + <params> + <param name="do" doc="Explain do" /> + <param name="fo" doc="Explain foo" /> + </params> + </command> + <command id="foo_cmd"> + <doc>General docs</doc> + <params> + <param name="do" doc="Explain do" /> + <param name="fo" doc="Explain foo" /> + </params> + </command> + + </node> +</vtydoc> |