Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r54917 - trunk/libs/asio/doc
From: chris_at_[hidden]
Date: 2009-07-12 23:40:51


Author: chris_kohlhoff
Date: 2009-07-12 23:40:50 EDT (Sun, 12 Jul 2009)
New Revision: 54917
URL: http://svn.boost.org/trac/boost/changeset/54917

Log:
Show explicit keyword when necessary. Fix hyperlinks between classes.

Text files modified:
   trunk/libs/asio/doc/reference.xsl | 96 +++++++++++++++++++++++++++++++--------
   1 files changed, 76 insertions(+), 20 deletions(-)

Modified: trunk/libs/asio/doc/reference.xsl
==============================================================================
--- trunk/libs/asio/doc/reference.xsl (original)
+++ trunk/libs/asio/doc/reference.xsl 2009-07-12 23:40:50 EDT (Sun, 12 Jul 2009)
@@ -10,6 +10,7 @@
 
 <xsl:output method="text"/>
 <xsl:strip-space elements="*"/>
+<xsl:preserve-space elements="para"/>
 
 
 <xsl:variable name="newline">
@@ -251,11 +252,6 @@
 </xsl:template>
 
 
-<xsl:template match="ref" mode="markup">
-<xsl:apply-templates mode="markup-nested"/>
-</xsl:template>
-
-
 <xsl:template match="title" mode="markup">
   <xsl:variable name="title">
     <xsl:value-of select="."/>
@@ -342,7 +338,7 @@
 </xsl:template>
 
 
-<xsl:template match="emphasis" mode="markup">[*<xsl:value-of select="."/>] </xsl:template>
+<xsl:template match="emphasis" mode="markup">[*<xsl:value-of select="."/>]</xsl:template>
 
 
 <xsl:template match="parameterlist" mode="markup">
@@ -498,10 +494,12 @@
     <xsl:value-of select="."/>
   </xsl:variable>
   <xsl:choose>
- <xsl:when test="contains($name, 'asio::')">
+ <xsl:when test="contains(@refid, 'asio') or contains($name, 'asio::')">
+ <xsl:variable name="dox-ref-id" select="@refid"/>
       <xsl:variable name="ref-name">
         <xsl:call-template name="strip-asio-ns">
- <xsl:with-param name="name" select="$name"/>
+ <xsl:with-param name="name"
+ select="(/doxygen//compounddef[@id=$dox-ref-id])[1]/compoundname"/>
         </xsl:call-template>
       </xsl:variable>
       <xsl:variable name="ref-id">
@@ -509,13 +507,68 @@
           <xsl:with-param name="name" select="$ref-name"/>
         </xsl:call-template>
       </xsl:variable>
-[link boost_asio.reference.<xsl:value-of select="$ref-id"/><xsl:text> </xsl:text><xsl:value-of
- select="$ref-name"/>]</xsl:when>
- <xsl:otherwise><xsl:value-of select="."/></xsl:otherwise>
+ <xsl:text>[link boost_asio.reference.</xsl:text>
+ <xsl:value-of select="$ref-id"/>
+ <xsl:text> `</xsl:text>
+ <xsl:value-of name="text" select="$ref-name"/>
+ <xsl:text>`]</xsl:text>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:text>`</xsl:text>
+ <xsl:value-of select="."/>
+ <xsl:text>`</xsl:text>
+ </xsl:otherwise>
   </xsl:choose>
 </xsl:template>
 
 
+<xsl:template match="ref[@kindref='compound']" mode="markup-nested">
+ <xsl:variable name="name">
+ <xsl:value-of select="."/>
+ </xsl:variable>
+ <xsl:choose>
+ <xsl:when test="contains(@refid, 'asio') or contains($name, 'asio::')">
+ <xsl:variable name="dox-ref-id" select="@refid"/>
+ <xsl:variable name="ref-name">
+ <xsl:call-template name="strip-asio-ns">
+ <xsl:with-param name="name"
+ select="(/doxygen//compounddef[@id=$dox-ref-id])[1]/compoundname"/>
+ </xsl:call-template>
+ </xsl:variable>
+ <xsl:variable name="ref-id">
+ <xsl:call-template name="make-id">
+ <xsl:with-param name="name" select="$ref-name"/>
+ </xsl:call-template>
+ </xsl:variable>
+ <xsl:text>[link boost_asio.reference.</xsl:text>
+ <xsl:value-of select="$ref-id"/>
+ <xsl:text> `</xsl:text>
+ <xsl:value-of name="text" select="$ref-name"/>
+ <xsl:text>`]</xsl:text>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:text>`</xsl:text>
+ <xsl:value-of select="."/>
+ <xsl:text>`</xsl:text>
+ </xsl:otherwise>
+ </xsl:choose>
+</xsl:template>
+
+
+<xsl:template match="ref[@kindref='member']" mode="markup">
+ <xsl:text>`</xsl:text>
+ <xsl:value-of select="."/>
+ <xsl:text>`</xsl:text>
+</xsl:template>
+
+
+<xsl:template match="ref[@kindref='member']" mode="markup-nested">
+ <xsl:text>`</xsl:text>
+ <xsl:value-of select="."/>
+ <xsl:text>`</xsl:text>
+</xsl:template>
+
+
 <xsl:template name="header-requirements">
   <xsl:param name="file"/>
   <xsl:value-of select="$newline"/>
@@ -562,7 +615,7 @@
   <xsl:variable name="class-file" select="location/@file"/>
 [section:<xsl:value-of select="$class-id"/><xsl:text> </xsl:text><xsl:value-of select="$class-name"/>]
 
-<xsl:value-of select="briefdescription"/><xsl:text>
+<xsl:apply-templates select="briefdescription" mode="markup"/><xsl:text>
 
 </xsl:text>
 
@@ -921,19 +974,22 @@
 <xsl:value-of select="$class-name"/>
 <xsl:text>] </xsl:text>
 
-<xsl:value-of select="briefdescription"/><xsl:text>
+<xsl:apply-templates select="briefdescription" mode="markup"/><xsl:text>
 </xsl:text>
 
 <xsl:for-each select="../memberdef[name = $name]">
 <xsl:if test="position() &gt; 1 and not(briefdescription = preceding-sibling::*/briefdescription)">
   <xsl:value-of select="$newline"/>
- <xsl:value-of select="briefdescription"/>
+ <xsl:apply-templates select="briefdescription" mode="markup"/>
   <xsl:value-of select="$newline"/>
 </xsl:if>
 <xsl:text>
 </xsl:text><xsl:apply-templates select="templateparamlist" mode="class-detail"/>
-<xsl:text> </xsl:text><xsl:if test="@static='yes'">static </xsl:if><xsl:if
- test="string-length(type) > 0"><xsl:value-of select="type"/><xsl:text> </xsl:text>
+<xsl:text> </xsl:text>
+ <xsl:if test="@explicit='yes'">explicit </xsl:if>
+ <xsl:if test="@static='yes'">static </xsl:if>
+ <xsl:if test="string-length(type) > 0">
+ <xsl:value-of select="type"/><xsl:text> </xsl:text>
 </xsl:if>``[link boost_asio.reference.<xsl:value-of select="$class-id"/>.<xsl:value-of
  select="$id"/>.overload<xsl:value-of select="position()"/><xsl:text> </xsl:text><xsl:value-of
  select="name"/>]``(<xsl:apply-templates select="param"
@@ -970,7 +1026,7 @@
   <xsl:text>] </xsl:text>
 </xsl:if>
 
-<xsl:value-of select="briefdescription"/><xsl:text>
+<xsl:apply-templates select="briefdescription" mode="markup"/><xsl:text>
 </xsl:text>
 
   <xsl:choose>
@@ -1250,12 +1306,12 @@
 <xsl:choose>
   <xsl:when test="count(/doxygen/compounddef[@kind='group' and compoundname=$name]) &gt; 0">
     <xsl:for-each select="/doxygen/compounddef[@kind='group' and compoundname=$name]">
- <xsl:value-of select="briefdescription"/><xsl:text>
+ <xsl:apply-templates select="briefdescription" mode="markup"/><xsl:text>
       </xsl:text>
     </xsl:for-each>
   </xsl:when>
   <xsl:otherwise>
- <xsl:value-of select="briefdescription"/><xsl:text>
+ <xsl:apply-templates select="briefdescription" mode="markup"/><xsl:text>
     </xsl:text>
   </xsl:otherwise>
 </xsl:choose>
@@ -1296,7 +1352,7 @@
   <xsl:text>] </xsl:text>
 </xsl:if>
 
-<xsl:value-of select="briefdescription"/><xsl:text>
+<xsl:apply-templates select="briefdescription" mode="markup"/><xsl:text>
 </xsl:text>
 
   <xsl:choose>


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk