summaryrefslogtreecommitdiff
path: root/doc/dbus-introspect-docs.dtd
diff options
context:
space:
mode:
authorWilliam Jon McCann <mccann@jhu.edu>2007-03-13 03:42:04 -0400
committerWilliam Jon McCann <mccann@jhu.edu>2007-03-13 03:42:04 -0400
commit8b42a4928a0a266c3b3ae6bb13997764bc7f6405 (patch)
treeb1b1f06fdd18da4475c0dd773df364be3a0c9be0 /doc/dbus-introspect-docs.dtd
parent4595ab3d4953d6257a6fedfe5b294df67ff3581f (diff)
add the last bits of spec framework
The spec is the introspection format extended with docs. There are tools to build docbook and strip the docs to make dbus introspect xml.
Diffstat (limited to 'doc/dbus-introspect-docs.dtd')
-rw-r--r--doc/dbus-introspect-docs.dtd31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/dbus-introspect-docs.dtd b/doc/dbus-introspect-docs.dtd
new file mode 100644
index 0000000..ce7204e
--- /dev/null
+++ b/doc/dbus-introspect-docs.dtd
@@ -0,0 +1,31 @@
+<!-- DTD for D-Bus Introspection Documentation -->
+
+<!ELEMENT documentation (summary?,description?,errors?,permission?,since?,deprecated,seealso?)>
+
+<!ELEMENT summary (#PCDATA|ref)*>
+<!ELEMENT description (#PCDATA|para|example)*>
+<!ELEMENT errors (error)*>
+<!ELEMENT permission (#PCDATA|ref|para)*>
+<!ELEMENT since EMPTY>
+<!ATTLIST since version CDATA #REQUIRED>
+<!ELEMENT deprecated EMPTY>
+<!ATTLIST deprecated version CDATA #REQUIRED>
+<!ELEMENT seealso (ref+)>
+
+<!ELEMENT error (#PCDATA|para)*>
+<!ATTLIST error name CDATA #REQUIRED>
+<!ELEMENT para (#PCDATA|example|code|list|ref)*>
+<!ELEMENT example (#PCDATA|para|code|ref)*>
+<!ATTLIST language (c|glib|python|shell) #REQUIRED>
+<!ATTLIST title CDATA #IMPLIED>
+<!ELEMENT list (listheader?, item*)>
+<!ATTLIST list type (bullet|number|table) #REQUIRED>
+<!ELEMENT item (term|definition)*>
+<!ELEMENT term (#PCDATA|ref)*>
+<!ELEMENT definition (#PCDATA|para)*>
+
+<!ELEMENT code (#PCDATA)>
+<!ATTLIST code lang CDATA #IMPLIED>
+<!ELEMENT ref CDATA>
+<!ATTLIST ref type (parameter|arg|signal|method|interface) #REQUIRED>
+<!ATTLIST ref to CDATA #REQUIRED>