[PATCH] doc: Use enum argument type to make links in protocol documentation

spitzak at gmail.com spitzak at gmail.com
Fri Nov 6 08:30:22 PST 2015


From: Bill Spitzak <spitzak at gmail.com>

Small difference in my version from the one pushed. The argument docs
are produced by their own section rather than an if statement, and
include the interface name along with the enum name.
---
 doc/publican/protocol-to-docbook.xsl | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

diff --git a/doc/publican/protocol-to-docbook.xsl b/doc/publican/protocol-to-docbook.xsl
index fad207a..5344442 100644
--- a/doc/publican/protocol-to-docbook.xsl
+++ b/doc/publican/protocol-to-docbook.xsl
@@ -102,12 +102,6 @@
     <term><xsl:value-of select="@name"/></term>
     <listitem>
         <simpara>
-          <xsl:if test="@enum">
-            <link linkend="protocol-spec-{../../@name}-enum-{@enum}">
-              <xsl:value-of select="@enum"/>
-            </link>
-	    <xsl:text> </xsl:text>
-          </xsl:if>
           <xsl:value-of select="@type"/>
           <xsl:if test="@summary" >
             - <xsl:value-of select="@summary"/>
@@ -152,6 +146,24 @@
   </varlistentry>
 </xsl:template>
 
+<!-- enum and bitfield arguemnts -->
+<xsl:template match="arg[@enum]">
+  <varlistentry>
+    <term><xsl:value-of select="@name"/></term>
+    <listitem>
+        <simpara>
+          <link linkend="protocol-spec-{../../@name}-enum-{@enum}">
+            <xsl:value-of select="../../@name"/>::<xsl:value-of select="@enum"/>
+          </link>
+          (<xsl:value-of select="@type"/>)
+          <xsl:if test="@summary" >
+            - <xsl:value-of select="@summary"/>
+          </xsl:if>
+        </simpara>
+    </listitem>
+  </varlistentry>
+</xsl:template>
+
 <!-- Request/event list -->
 <xsl:template match="request|event">
   <section id="protocol-spec-{../@name}-{name()}-{@name}">
@@ -174,7 +186,7 @@
 
 <!-- Enumeration -->
 <xsl:template match="enum">
-  <section id="protocol-spec-{../@name}-{name()}-{@name}">
+  <section id="protocol-spec-{../@name}-enum-{@name}">
     <title>
       <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" />
       <xsl:if test="@bitfield">
-- 
1.9.1



More information about the wayland-devel mailing list