Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r70874 - in trunk/tools/boostbook: test/doxygen test/doxygen/boost xsl/doxygen
From: steven_at_[hidden]
Date: 2011-04-02 14:07:22


Author: steven_watanabe
Date: 2011-04-02 14:07:21 EDT (Sat, 02 Apr 2011)
New Revision: 70874
URL: http://svn.boost.org/trac/boost/changeset/70874

Log:
Handle \see
Text files modified:
   trunk/tools/boostbook/test/doxygen/Jamfile.v2 | 2 +-
   trunk/tools/boostbook/test/doxygen/autodoc.gold | 3 ++-
   trunk/tools/boostbook/test/doxygen/boost/example.hpp | 2 ++
   trunk/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl | 11 ++++++++++-
   4 files changed, 15 insertions(+), 3 deletions(-)

Modified: trunk/tools/boostbook/test/doxygen/Jamfile.v2
==============================================================================
--- trunk/tools/boostbook/test/doxygen/Jamfile.v2 (original)
+++ trunk/tools/boostbook/test/doxygen/Jamfile.v2 2011-04-02 14:07:21 EDT (Sat, 02 Apr 2011)
@@ -25,7 +25,7 @@
 {
     actions compare
     {
- diff -u $(>[1]) $(>[2]) && echo "Stamped" >$(<)
+ diff -u -w $(>[1]) $(>[2]) && echo "Stamped" >$(<)
     }
 }
 

Modified: trunk/tools/boostbook/test/doxygen/autodoc.gold
==============================================================================
--- trunk/tools/boostbook/test/doxygen/autodoc.gold (original)
+++ trunk/tools/boostbook/test/doxygen/autodoc.gold 2011-04-02 14:07:21 EDT (Sat, 02 Apr 2011)
@@ -19,5 +19,6 @@
 </para></description></struct><enum name="namespace_enum"><enumvalue name="enumerator"/></enum><data-member name="namespace_integer"><type>int</type></data-member><data-member name="namespace_static_integer" specifiers="static"><type>int</type></data-member><data-member name="namespace_const_integer"><type>const int</type></data-member><data-member name="namespace_static_const_integer" specifiers="static"><type>const int</type></data-member><function name="namespace_func"><type>int</type><parameter name="i"><paramtype>int</paramtype><description><para>A function parameter </para></description></parameter><parameter name="j"><paramtype>int</paramtype><description><para>Another </para></description></parameter><description><para>
 
 
-This is a test function. <classname alt="example::example">Link to class</classname> <classname alt="example::example_template">Link to class template</classname> <note><para>This is a note. </para></note>
+This is a test function. <classname alt="example::example">Link to class</classname> <classname alt="example::example_template">Link to class template</classname> <note><para>This is a note.</para></note>
+<para><emphasis role="bold">See Also:</emphasis><para><classname alt="example::example">example::example</classname> and <classname alt="example::example_template">example_template</classname> </para></para>
 </para></description><requires><para>i &gt; j</para></requires><returns><para>The answer </para></returns></function></namespace><macro name="EXAMPLE" kind="functionlike"><macro-parameter name="m"/><purpose>Documentation for macro example. </purpose></macro></header></library-reference>

Modified: trunk/tools/boostbook/test/doxygen/boost/example.hpp
==============================================================================
--- trunk/tools/boostbook/test/doxygen/boost/example.hpp (original)
+++ trunk/tools/boostbook/test/doxygen/boost/example.hpp 2011-04-02 14:07:21 EDT (Sat, 02 Apr 2011)
@@ -108,6 +108,8 @@
      * \ref example::example "Link to class"
      * \ref example_template "Link to class template"
      * \note This is a note.
+ *
+ * \see example::example and example_template
      */
     int namespace_func(int i, int j);
 }

Modified: trunk/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl
==============================================================================
--- trunk/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl (original)
+++ trunk/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl 2011-04-02 14:07:21 EDT (Sat, 02 Apr 2011)
@@ -1276,7 +1276,7 @@
                   not (@kind='return') and
                   not (@kind='post') and
                   not (@kind='attention') and
- not (@kind='note')">
+ not (@kind='see')">
       <xsl:apply-templates mode="passthrough"/>
     </xsl:if>
   </xsl:template>
@@ -1293,6 +1293,15 @@
     </formalpara>
   </xsl:template>
 
+ <xsl:template match="para/simplesect[@kind='see']" mode="passthrough">
+ <para>
+ <emphasis role="bold">
+ <xsl:text>See Also:</xsl:text>
+ </emphasis>
+ <xsl:apply-templates mode="passthrough"/>
+ </para>
+ </xsl:template>
+
   <xsl:template match="simplesectsep" mode="passthrough">
     <xsl:apply-templates mode="passthrough"/>
   </xsl:template>


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