mirror of
https://github.com/boostorg/boostbook.git
synced 2025-05-09 15:03:57 +00:00
- Support nested classes
- Much improved handling of <purpose> elements in comments [SVN r17945]
This commit is contained in:
Douglas Gregor
parent
009796240f
commit
07fa70e531
@ -51,7 +51,8 @@
|
||||
"static-constant|typedef|enum|
|
||||
copy-assignment|constructor|destructor|method-group|
|
||||
free-function-group|function|method|overloaded-function|
|
||||
overloaded-method|data-member">
|
||||
overloaded-method|data-member|class|class-specialization|struct|
|
||||
struct-specialization|union|union-specialization">
|
||||
|
||||
<!ENTITY % boost.class.content
|
||||
"template?, inherit*, purpose?, description?,
|
||||
|
||||
@ -102,7 +102,7 @@
|
||||
|
||||
<xsl:template name="highlight-comment">
|
||||
<xsl:param name="text"/>
|
||||
<emphasis><xsl:value-of select="$text"/></emphasis>
|
||||
<emphasis><xsl:copy-of select="$text"/></emphasis>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="monospaced">
|
||||
|
||||
@ -77,19 +77,35 @@
|
||||
|
||||
<!-- Emit namespace reference -->
|
||||
<xsl:template match="namespace" mode="reference">
|
||||
<xsl:apply-templates select="class|class-specialization|
|
||||
struct|struct-specialization|
|
||||
union|union-specialization|
|
||||
namespace|typedef|enum|
|
||||
free-function-group"
|
||||
<xsl:apply-templates select="namespace|typedef|free-function-group"
|
||||
mode="reference">
|
||||
<xsl:with-param name="indentation" select="0"/>
|
||||
</xsl:apply-templates>
|
||||
<xsl:apply-templates select="enum|function|overloaded-function"
|
||||
<xsl:apply-templates select="class|class-specialization|
|
||||
struct|struct-specialization|
|
||||
union|union-specialization|enum|function|
|
||||
overloaded-function"
|
||||
mode="namespace-reference"/>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Eat extra documentation when in the synopsis or reference sections -->
|
||||
<xsl:template match="para|section" mode="synopsis"/>
|
||||
<xsl:template match="para|section" mode="reference"/>
|
||||
|
||||
<!-- Comment mode tries to wipe out any extra spacing in the output -->
|
||||
<xsl:template match="purpose" mode="comment">
|
||||
<xsl:apply-templates mode="comment"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="simpara|para" mode="comment">
|
||||
<xsl:apply-templates select="text()|*" mode="comment"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="text()" mode="comment">
|
||||
<xsl:value-of select="."/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="*" mode="comment">
|
||||
<xsl:apply-templates select="." mode="annotation"/>
|
||||
</xsl:template>
|
||||
</xsl:stylesheet>
|
||||
|
||||
305
xsl/type.xsl
305
xsl/type.xsl
@ -2,7 +2,7 @@
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
version="1.0">
|
||||
|
||||
<xsl:strip-space elements="inherit"/>
|
||||
<xsl:strip-space elements="inherit purpose"/>
|
||||
|
||||
<!-- When true, the stylesheet will emit compact definitions of
|
||||
enumerations when the enumeration does not have any detailed
|
||||
@ -266,27 +266,12 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
|
||||
<xsl:variable name="purpose">
|
||||
<xsl:choose>
|
||||
<xsl:when test="@comment">
|
||||
<xsl:message>
|
||||
<xsl:text>Warning: `comment' attribute of `typedef' element is deprecated. Use `purpose' element instead.</xsl:text>
|
||||
<xsl:call-template name="print.warning.context"/>
|
||||
</xsl:message>
|
||||
<xsl:value-of select="@comment"/>
|
||||
</xsl:when>
|
||||
<xsl:when test="purpose">
|
||||
<xsl:apply-templates select="purpose"/>
|
||||
</xsl:when>
|
||||
</xsl:choose>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:if test="@comment or purpose">
|
||||
<xsl:if test="purpose">
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:call-template name="highlight-comment">
|
||||
<xsl:with-param name="text">
|
||||
<xsl:text>// </xsl:text>
|
||||
<xsl:copy-of select="$purpose"/>
|
||||
<xsl:apply-templates select="purpose" mode="comment"/>
|
||||
</xsl:with-param>
|
||||
</xsl:call-template>
|
||||
</xsl:if>
|
||||
@ -351,7 +336,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
<xsl:call-template name="highlight-comment">
|
||||
<xsl:with-param name="text">
|
||||
<xsl:text>// </xsl:text>
|
||||
<xsl:apply-templates select="purpose/*|purpose/text()"/>
|
||||
<xsl:apply-templates select="purpose" mode="comment"/>
|
||||
</xsl:with-param>
|
||||
</xsl:call-template>
|
||||
</xsl:if>
|
||||
@ -463,16 +448,168 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
</xsl:call-template>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Emit class reference documentation -->
|
||||
<xsl:template match="class|class-specialization|
|
||||
struct|struct-specialization|
|
||||
union|union-specialization" mode="reference">
|
||||
<xsl:template name="class-type-synopsis">
|
||||
<xsl:param name="indentation" select="0"/>
|
||||
|
||||
<!-- The keyword used to declare this class type, e.g., class,
|
||||
struct, or union. -->
|
||||
<xsl:variable name="class-key">
|
||||
<xsl:call-template name="type.class.key"/>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:if test="ancestor::class|ancestor::class-specialization|
|
||||
ancestor::struct|ancestor::struct-specialization|
|
||||
ancestor::union|ancestor::union-specialization">
|
||||
<xsl:text> </xsl:text>
|
||||
|
||||
<!-- If this nested class has a "purpose" element, use it as a
|
||||
comment. -->
|
||||
<xsl:if test="purpose">
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-comment">
|
||||
<xsl:with-param name="text">
|
||||
<xsl:text>// </xsl:text>
|
||||
<xsl:apply-templates select="purpose" mode="comment"/>
|
||||
</xsl:with-param>
|
||||
</xsl:call-template>
|
||||
<xsl:text> </xsl:text>
|
||||
</xsl:if>
|
||||
</xsl:if>
|
||||
|
||||
<!-- Template header -->
|
||||
<xsl:if test="template">
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
</xsl:call-template>
|
||||
<xsl:apply-templates select="template" mode="reference">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:if>
|
||||
<xsl:text> </xsl:text>
|
||||
|
||||
<!-- Class name -->
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-keyword">
|
||||
<xsl:with-param name="keyword" select="$class-key"/>
|
||||
</xsl:call-template>
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:value-of select="@name"/>
|
||||
<xsl:apply-templates select="specialization"/>
|
||||
|
||||
<!-- Base class list -->
|
||||
<xsl:apply-templates select="inherit"/>
|
||||
|
||||
<!-- Opening brace and public designator -->
|
||||
<xsl:text> {</xsl:text>
|
||||
<xsl:if test="contains(local-name(.), 'class')">
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-keyword">
|
||||
<xsl:with-param name="keyword" select="'public'"/>
|
||||
</xsl:call-template>
|
||||
<xsl:text>:</xsl:text>
|
||||
</xsl:if>
|
||||
|
||||
<!-- Typedefs -->
|
||||
<xsl:if test="typedef">
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="$indentation + 2"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-comment">
|
||||
<xsl:with-param name="text" select="'// types'"/>
|
||||
</xsl:call-template>
|
||||
|
||||
<xsl:variable name="max-type-length">
|
||||
<xsl:call-template name="find-max-type-length"/>
|
||||
</xsl:variable>
|
||||
<xsl:variable name="max-name-length">
|
||||
<xsl:call-template name="find-max-type-length">
|
||||
<xsl:with-param name="want-name" select="true()"/>
|
||||
</xsl:call-template>
|
||||
</xsl:variable>
|
||||
<xsl:apply-templates select="typedef" mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="$indentation + 2"/>
|
||||
<xsl:with-param name="max-type-length"
|
||||
select="$max-type-length"/>
|
||||
<xsl:with-param name="max-name-length"
|
||||
select="$max-name-length"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:if>
|
||||
|
||||
<!-- Static constants -->
|
||||
<xsl:if test="static-constant">
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:if test="typedef">
|
||||
<xsl:text> </xsl:text>
|
||||
</xsl:if>
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="$indentation + 2"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-comment">
|
||||
<xsl:with-param name="text" select="'// static constants'"/>
|
||||
</xsl:call-template>
|
||||
<xsl:apply-templates select="static-constant" mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="$indentation + 2"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:if>
|
||||
|
||||
<!-- Nested classes/structs/unions -->
|
||||
<xsl:apply-templates select="class|class-specialization|
|
||||
struct|struct-specialization|
|
||||
union|union-specialization"
|
||||
mode="reference">
|
||||
<xsl:with-param name="indentation" select="$indentation + 2"/>
|
||||
</xsl:apply-templates>
|
||||
|
||||
<!-- Construct/Copy/Destruct -->
|
||||
<xsl:call-template name="construct-copy-destruct-synopsis">
|
||||
<xsl:with-param name="indentation" select="$indentation + 2"/>
|
||||
</xsl:call-template>
|
||||
|
||||
<!-- Member functions -->
|
||||
<xsl:apply-templates
|
||||
select="method-group|method|overloaded-method"
|
||||
mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="$indentation + 2"/>
|
||||
</xsl:apply-templates>
|
||||
|
||||
<!-- Data members -->
|
||||
<xsl:apply-templates select="data-member" mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="$indentation + 2"/>
|
||||
</xsl:apply-templates>
|
||||
|
||||
<!-- Closing brace -->
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
</xsl:call-template>
|
||||
<xsl:text>};</xsl:text>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Emit nested class reference documentation -->
|
||||
<xsl:template match="class|class-specialization|
|
||||
struct|struct-specialization|
|
||||
union|union-specialization" mode="reference">
|
||||
<xsl:param name="indentation"/>
|
||||
|
||||
<xsl:call-template name="class-type-synopsis">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
</xsl:call-template>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Emit namespace-level class reference documentation -->
|
||||
<xsl:template match="class|class-specialization|
|
||||
struct|struct-specialization|
|
||||
union|union-specialization" mode="namespace-reference">
|
||||
<xsl:param name="indentation" select="0"/>
|
||||
|
||||
<xsl:call-template name="separator"/>
|
||||
<xsl:call-template name="reference-documentation">
|
||||
<xsl:with-param name="refname">
|
||||
@ -491,112 +628,13 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
<xsl:call-template name="type.display.name"/>
|
||||
</xsl:with-param>
|
||||
<xsl:with-param name="synopsis">
|
||||
<!-- Template header -->
|
||||
<xsl:if test="template">
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="0"/>
|
||||
</xsl:call-template>
|
||||
<xsl:apply-templates select="template" mode="reference">
|
||||
<xsl:with-param name="indentation" select="0"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:if>
|
||||
<xsl:text> </xsl:text>
|
||||
|
||||
<!-- Class name -->
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="0"/>
|
||||
<xsl:call-template name="class-type-synopsis">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-keyword">
|
||||
<xsl:with-param name="keyword" select="$class-key"/>
|
||||
</xsl:call-template>
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:value-of select="@name"/>
|
||||
<xsl:apply-templates select="specialization"/>
|
||||
|
||||
<!-- Base class list -->
|
||||
<xsl:apply-templates select="inherit"/>
|
||||
|
||||
<!-- Opening brace and public designator -->
|
||||
<xsl:text> { </xsl:text>
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="0"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-keyword">
|
||||
<xsl:with-param name="keyword" select="'public'"/>
|
||||
</xsl:call-template>
|
||||
<xsl:text>:</xsl:text>
|
||||
|
||||
<!-- Typedefs -->
|
||||
<xsl:if test="typedef">
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="2"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-comment">
|
||||
<xsl:with-param name="text" select="'// types'"/>
|
||||
</xsl:call-template>
|
||||
|
||||
<xsl:variable name="max-type-length">
|
||||
<xsl:call-template name="find-max-type-length"/>
|
||||
</xsl:variable>
|
||||
<xsl:variable name="max-name-length">
|
||||
<xsl:call-template name="find-max-type-length">
|
||||
<xsl:with-param name="want-name" select="true()"/>
|
||||
</xsl:call-template>
|
||||
</xsl:variable>
|
||||
<xsl:apply-templates select="typedef" mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="2"/>
|
||||
<xsl:with-param name="max-type-length"
|
||||
select="$max-type-length"/>
|
||||
<xsl:with-param name="max-name-length"
|
||||
select="$max-name-length"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:if>
|
||||
|
||||
<!-- Static constants -->
|
||||
<xsl:if test="static-constant">
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:if test="typedef">
|
||||
<xsl:text> </xsl:text>
|
||||
</xsl:if>
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="2"/>
|
||||
</xsl:call-template>
|
||||
<xsl:call-template name="highlight-comment">
|
||||
<xsl:with-param name="text" select="'// static constants'"/>
|
||||
</xsl:call-template>
|
||||
<xsl:apply-templates select="static-constant" mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="2"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:if>
|
||||
|
||||
<!-- Construct/Copy/Destruct -->
|
||||
<xsl:call-template name="construct-copy-destruct-synopsis">
|
||||
<xsl:with-param name="indentation" select="2"/>
|
||||
</xsl:call-template>
|
||||
|
||||
<!-- Member functions -->
|
||||
<xsl:apply-templates
|
||||
select="method-group|method|overloaded-method"
|
||||
mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="2"/>
|
||||
</xsl:apply-templates>
|
||||
|
||||
<!-- Data members -->
|
||||
<xsl:apply-templates select="data-member" mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="2"/>
|
||||
</xsl:apply-templates>
|
||||
|
||||
<!-- Closing brace -->
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:call-template name="indent">
|
||||
<xsl:with-param name="indentation" select="0"/>
|
||||
</xsl:call-template>
|
||||
<xsl:text>};</xsl:text>
|
||||
|
||||
<!-- Associated free functions -->
|
||||
<xsl:apply-templates select="free-function-group" mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="0"/>
|
||||
<xsl:apply-templates select="ancestor-or-self::*/free-function-group"
|
||||
mode="synopsis">
|
||||
<xsl:with-param name="indentation" select="$indentation"/>
|
||||
<xsl:with-param name="class" select="@name"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:with-param>
|
||||
@ -610,7 +648,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
<xsl:apply-templates select="para" mode="annotation"/>
|
||||
</xsl:if>
|
||||
<xsl:apply-templates select="description"/>
|
||||
|
||||
|
||||
<xsl:call-template name="construct-copy-destruct-reference"/>
|
||||
<xsl:apply-templates
|
||||
select="method-group|method|overloaded-method"
|
||||
@ -618,7 +656,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
<xsl:apply-templates select="free-function-group" mode="reference">
|
||||
<xsl:with-param name="class" select="@name"/>
|
||||
</xsl:apply-templates>
|
||||
|
||||
|
||||
<!-- Specializations of this class -->
|
||||
<!-- TBD: fix this. We should key off the class name and match
|
||||
fully-qualified names -->
|
||||
@ -688,7 +726,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
<xsl:if
|
||||
test="(not (local-name(preceding-sibling::*[position()=1])=local-name(.))
|
||||
and (position() > 1)) or
|
||||
not (para or not ($boost.compact.enum=1))">
|
||||
not (para or description or not ($boost.compact.enum=1))">
|
||||
<xsl:text> </xsl:text>
|
||||
</xsl:if>
|
||||
|
||||
@ -702,7 +740,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
<!-- When there is a detailed description, we only put the
|
||||
declaration in the synopsis and will put detailed documentation
|
||||
in either a <refentry/> or in class documentation. -->
|
||||
<xsl:when test="para or not ($boost.compact.enum=1)">
|
||||
<xsl:when test="para or description or not ($boost.compact.enum=1)">
|
||||
<xsl:call-template name="highlight-keyword">
|
||||
<xsl:with-param name="keyword" select="'enum'"/>
|
||||
</xsl:call-template>
|
||||
@ -768,7 +806,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
|
||||
<!-- Enumeration reference at namespace level -->
|
||||
<xsl:template match="enum" mode="namespace-reference">
|
||||
<xsl:if test="para or not ($boost.compact.enum=1)">
|
||||
<xsl:if test="para or description or not ($boost.compact.enum=1)">
|
||||
<xsl:call-template name="reference-documentation">
|
||||
<xsl:with-param name="name">
|
||||
<xsl:call-template name="type.display.name"/>
|
||||
@ -794,9 +832,6 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
|
||||
</xsl:if>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Enumeration reference -->
|
||||
<xsl:template match="enum" mode="reference"/>
|
||||
|
||||
<!-- Output an enumeration along with its values -->
|
||||
<xsl:template name="type.enum.display">
|
||||
<!-- Spacing -->
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user