diff options
| author | Bill Spitzak <spitzak@gmail.com> | 2015-01-02 18:29:22 -0800 |
|---|---|---|
| committer | Bryce Harrington <bryce@osg.samsung.com> | 2015-01-23 18:45:03 -0800 |
| commit | 6750538455a5bfdbaff3635233c227670ec9b27f (patch) | |
| tree | afe2e185bd78102cb7af81a888b7f95a96e3ce22 | |
| parent | d90fd15ee4950f1ea5849e784dc592466de7b90b (diff) | |
| download | wayland-6750538455a5bfdbaff3635233c227670ec9b27f.tar.gz | |
doc: remove redundant subtitles
Put the argument lists next to the event/message title, which I
think makes it a lot easier to understand, and remove redundant
"values" title from enumerations.
Reviewed-by: Derek Foreman <derekf@osg.samsung.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
| -rw-r--r-- | doc/publican/protocol-to-docbook.xsl | 38 |
1 files changed, 25 insertions, 13 deletions
diff --git a/doc/publican/protocol-to-docbook.xsl b/doc/publican/protocol-to-docbook.xsl index ca1308f..a886b7f 100644 --- a/doc/publican/protocol-to-docbook.xsl +++ b/doc/publican/protocol-to-docbook.xsl @@ -147,7 +147,7 @@ </xsl:template> <!-- Request/event list --> -<xsl:template match="request|event|enum"> +<xsl:template match="request|event"> <section id="protocol-spec-{../@name}-{name()}-{@name}"> <title> <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> @@ -155,23 +155,35 @@ - <xsl:value-of select="description/@summary" /> </xsl:if> </title> - <xsl:call-template name="break"> - <xsl:with-param name="text" select="description" /> - </xsl:call-template> - <xsl:if test="arg"> + <para> <variablelist> - <title><xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> arguments</title> <xsl:apply-templates select="arg"/> </variablelist> - </xsl:if> - <xsl:if test="entry"> - <variablelist> - <title><xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> values</title> - <xsl:apply-templates select="entry"/> - </variablelist> - </xsl:if> + </para> + <xsl:call-template name="break"> + <xsl:with-param name="text" select="description" /> + </xsl:call-template> + </section> +</xsl:template> + +<!-- Enumeration --> +<xsl:template match="enum"> + <section id="protocol-spec-{../@name}-{name()}-{@name}"> + <title> + <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> + <xsl:if test="description/@summary"> + - <xsl:value-of select="description/@summary" /> + </xsl:if> + </title> + <xsl:call-template name="break"> + <xsl:with-param name="text" select="description" /> + </xsl:call-template> + <variablelist> + <xsl:apply-templates select="entry"/> + </variablelist> </section> </xsl:template> + </xsl:stylesheet> <!-- vim: set expandtab shiftwidth=2: --> |