[Boost-commit] svn:boost r73419 - in trunk/tools/boostbook: test/doxygen test/doxygen/boost xsl/doxygen

Subject: [Boost-commit] svn:boost r73419 - in trunk/tools/boostbook: test/doxygen test/doxygen/boost xsl/doxygen
From: dnljms_at_[hidden]
Date: 2011-07-28 18:35:54

Author: danieljames
Date: 2011-07-28 18:35:53 EDT (Thu, 28 Jul 2011)
New Revision: 73419
URL: http://svn.boost.org/trac/boost/changeset/73419

Log:
Boostbook: Support doxygen warning tag.

Thanks to Tim. Refs #5740.

Unfortunately doxygen puts it inside a paragraph. But the generated
documentation seems good enough.
Text files modified: 
   trunk/tools/boostbook/test/doxygen/autodoc.gold         |     3 ++-                                     
   trunk/tools/boostbook/test/doxygen/boost/example.hpp    |     2 ++                                      
   trunk/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl |    10 +++++++++-                              
   3 files changed, 13 insertions(+), 2 deletions(-)

Modified: trunk/tools/boostbook/test/doxygen/autodoc.gold
==============================================================================
--- trunk/tools/boostbook/test/doxygen/autodoc.gold	(original)
+++ trunk/tools/boostbook/test/doxygen/autodoc.gold	2011-07-28 18:35:53 EDT (Thu, 28 Jul 2011)
@@ -3,7 +3,8 @@
       <template-type-parameter name="TypeParameter"><purpose><para>A template parameter </para></purpose></template-type-parameter>
       <template-nontype-parameter name="NonTypeParameter"><type>int</type><purpose><para>This is a non-type template parameter </para></purpose></template-nontype-parameter>
       <template-type-parameter name="TypeParameterWithDefault"><default>int</default><purpose><para>This is a template parameter with a default argument </para></purpose></template-type-parameter>
-    </template><description><para>Test some doxygen markup</para><para>Embedded docbook list:</para><para> 
+    </template><description><para>Test some doxygen markup</para><para><warning><para>This is just an example.</para></warning>
+Embedded docbook list:</para><para> 
  <orderedlist><listitem><simpara>1</simpara></listitem><listitem><simpara>2</simpara></listitem></orderedlist>
  </para><para><emphasis>Special</emphasis> <emphasis role="bold">Bold</emphasis> <computeroutput>Typewriter</computeroutput> <emphasis>Italics</emphasis> <emphasis>emphasis</emphasis> <computeroutput>parameter</computeroutput> </para><para><itemizedlist>
 <listitem><para>Arg1 first argument. </para></listitem>

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-07-28 18:35:53 EDT (Thu, 28 Jul 2011)
@@ -68,6 +68,8 @@
     /**
      * Test some doxygen markup
      *
+     * \warning This is just an example.
+     *
      * Embedded docbook list:
      *
      * \xmlonly

Modified: trunk/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl
==============================================================================
--- trunk/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl	(original)
+++ trunk/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl	2011-07-28 18:35:53 EDT (Thu, 28 Jul 2011)
@@ -1276,7 +1276,9 @@
                   not (@kind='return') and 
                   not (@kind='post') and
                   not (@kind='attention') and
-                  not (@kind='see')">
+                  not (@kind='see') and
+                  not (@kind='warning') 
+                  ">
       <xsl:apply-templates mode="passthrough"/>
     </xsl:if>
   </xsl:template>
@@ -1287,6 +1289,12 @@
     </note>
   </xsl:template>
 
+  <xsl:template match="para/simplesect[@kind='warning']" mode="passthrough">
+    <warning>
+      <xsl:apply-templates mode="passthrough"/>
+    </warning>
+  </xsl:template>
+
   <xsl:template match="para/simplesect[@kind='par']" mode="passthrough">
     <formalpara>
       <xsl:apply-templates mode="passthrough"/>