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>
This commit is contained in:
Bill Spitzak 2015-01-02 18:29:22 -08:00 committed by Bryce Harrington
parent d90fd15ee4
commit 6750538455

View file

@ -147,7 +147,27 @@
</xsl:template> </xsl:template>
<!-- Request/event list --> <!-- 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" />
<xsl:if test="description/@summary">
- <xsl:value-of select="description/@summary" />
</xsl:if>
</title>
<para>
<variablelist>
<xsl:apply-templates select="arg"/>
</variablelist>
</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}"> <section id="protocol-spec-{../@name}-{name()}-{@name}">
<title> <title>
<xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" />
@ -158,20 +178,12 @@
<xsl:call-template name="break"> <xsl:call-template name="break">
<xsl:with-param name="text" select="description" /> <xsl:with-param name="text" select="description" />
</xsl:call-template> </xsl:call-template>
<xsl:if test="arg"> <variablelist>
<variablelist> <xsl:apply-templates select="entry"/>
<title><xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> arguments</title> </variablelist>
<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>
</section> </section>
</xsl:template> </xsl:template>
</xsl:stylesheet> </xsl:stylesheet>
<!-- vim: set expandtab shiftwidth=2: --> <!-- vim: set expandtab shiftwidth=2: -->