boost_mirror/boostbook
1
0
Fork 0
mirror of https://github.com/boostorg/boostbook.git synced 2025-05-09 15:03:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Boostbook: Support doxygen warning tag.

Browse Source 
Thanks to Tim. Refs #5740.

Unfortunately doxygen puts it inside a paragraph. But the generated
documentation seems good enough.

[SVN r73419]
This commit is contained in:
Daniel James 2011-07-28 22:35:53 +00:00
parent 70aadf5edf
commit 130a1bd0a8
3 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
test/doxygen/autodoc.gold
View File

@ -3,7 +3,8 @@
<template-type-parameter name="TypeParameter"><purpose><para>A template parameter </para></purpose></template-type-parameter> <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-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-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> <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> </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> <listitem><para>Arg1 first argument. </para></listitem>

2
test/doxygen/boost/example.hpp
View File

@ -68,6 +68,8 @@ namespace example
/** /**
* Test some doxygen markup * Test some doxygen markup
* *
* \warning This is just an example.
*
* Embedded docbook list: * Embedded docbook list:
* *
* \xmlonly * \xmlonly

10
xsl/doxygen/doxygen2boostbook.xsl
View File

@ -1276,7 +1276,9 @@
not (@kind='return') and not (@kind='return') and
not (@kind='post') and not (@kind='post') and
not (@kind='attention') and not (@kind='attention') and
not (@kind='see')"> not (@kind='see') and
not (@kind='warning')
">
<xsl:apply-templates mode="passthrough"/> <xsl:apply-templates mode="passthrough"/>
</xsl:if> </xsl:if>
</xsl:template> </xsl:template>
@ -1287,6 +1289,12 @@
</note> </note>
</xsl:template> </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"> <xsl:template match="para/simplesect[@kind='par']" mode="passthrough">
<formalpara> <formalpara>
<xsl:apply-templates mode="passthrough"/> <xsl:apply-templates mode="passthrough"/>