spec: Allow <annotation> in <arg> elements in introspection XML

This is widely used in practice (especially by GLib — just look at files
in /usr/share/dbus-1/interfaces/), and there is no reason not to allow
it. Update the specification, introspection DTD and XSL file to allow
and represent it.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=86162
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>

diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index b747c0bfee106465e68e1f4cf526c597e078f560..ca4f8699017d231f34a1a36b22215a4df90e0a11 100644 (file)
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -4045,7 +4045,7 @@
       </itemizedlist>
     </para>
     <para>
-        Method, interface, property, and signal elements may have
+        Method, interface, property, signal, and argument elements may have
         "annotations", which are generic key/value pairs of metadata.
         They are similar conceptually to Java's annotations and C# attributes.
         Well-known annotations:

diff --git a/doc/introspect.dtd b/doc/introspect.dtd
index ba263d326075c491f1a3ce350e88da4d72f0aa5c..4d396f987a554987c0bb19dd8644f6b39546b310 100644 (file)
--- a/doc/introspect.dtd
+++ b/doc/introspect.dtd
@@ -16,7 +16,7 @@
 <!ELEMENT signal (arg|annotation)*>
 <!ATTLIST signal name CDATA #REQUIRED>
 
-<!ELEMENT arg EMPTY>
+<!ELEMENT arg (annotation)*>
 <!ATTLIST arg name CDATA #IMPLIED>
 <!ATTLIST arg type CDATA #REQUIRED>
 <!-- Method arguments SHOULD include "direction",

diff --git a/doc/introspect.xsl b/doc/introspect.xsl
index 52604a5c52357847913e19eeba6c5613ac95eee8..89b6844180c86f917d7e17baa40de2597cc80370 100644 (file)
--- a/doc/introspect.xsl
+++ b/doc/introspect.xsl
@@ -80,6 +80,12 @@
                       
                       <span class="type"><xsl:value-of select="@type"/></span><xsl:text> </xsl:text>
                       <span class="symbol"><xsl:value-of select="@name"/></span><xsl:text> </xsl:text>
+
+                      <xsl:if test="annotation">
+                        <ul>
+                          <xsl:apply-templates select="annotation"/>
+                        </ul>
+                      </xsl:if>
                     </li>
                   </xsl:for-each>
                 </ul>