Boost C++ Libraries: Ticket #3309: Passthrough mode in doxygen2boostbook is not pass-through and ignores doxygen references https://svn.boost.org/trac10/ticket/3309 <p> The passthrough mode in doxygen2boostbook is not pass-through at all since it doesn't allow arbitrary xml to be left as-is, which can be useful to directly insert boostbook from descriptions in doxygen. </p> <p> The passthrough mode is also ignoring &lt;ref&gt; elements doxygen provides. </p> <p> The attached patch fixes both issues. </p> en-us Boost C++ Libraries /htdocs/site/boost.png https://svn.boost.org/trac10/ticket/3309 Trac 1.4.3 Mathias Gaunard <loufoque@…> Sat, 01 Aug 2009 16:38:16 GMT attachment set https://svn.boost.org/trac10/ticket/3309 https://svn.boost.org/trac10/ticket/3309 <ul> <li><strong>attachment</strong> → <span class="trac-field-new">doxygen_passthrough.diff</span> </li> </ul> Ticket Daniel James Sat, 01 Aug 2009 18:08:20 GMT owner, status changed https://svn.boost.org/trac10/ticket/3309#comment:1 https://svn.boost.org/trac10/ticket/3309#comment:1 <ul> <li><strong>owner</strong> changed from <span class="trac-author">Matias Capeletto</span> to <span class="trac-author">Daniel James</span> </li> <li><strong>status</strong> <span class="trac-field-old">new</span> → <span class="trac-field-new">assigned</span> </li> </ul> <p> Can you give some examples of how this is used? Such as: some xml that it currently doesn't support, an example of why <code>initializer</code> elements are ignored and an example of how <code>\ref</code> is used. </p> Ticket Mathias Gaunard <loufoque@…> Sat, 01 Aug 2009 19:25:51 GMT <link>https://svn.boost.org/trac10/ticket/3309#comment:2 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/3309#comment:2</guid> <description> <p> 1) </p> <pre class="wiki">/** The argument must model the \c \xmlonly&lt;conceptname&gt;Foo&lt;/conceptname&gt;\endxmlonly concept. */ template&lt;typename T&gt; void use_foo(T&amp; t); </pre><p> Without this patch, &lt;conceptname&gt; will simply be ignored. </p> <p> 2) I had to special case initializer elements so that they don't match *, but unfortunately my code is wrong, they certainly should not be ignored. This is the correct code: </p> <pre class="wiki"> &lt;xsl:template match="initializer" mode="passthrough"&gt; &lt;xsl:apply-templates mode="passthrough"/&gt; &lt;/xsl:template&gt; </pre><p> 3) doxygen provides some useful &lt;ref&gt; in the following scenario: </p> <pre class="wiki">/** This function uses an instance of \c thingy */ void bar(); </pre><p> with "thingy" a type doxygen knows about, this will generate the following xml : </p> <pre class="wiki">&lt;detaileddescription&gt;&lt;para&gt; This function uses an instance of &lt;computeroutput&gt;&lt;ref refid="..." kindref="compound"&gt;thingy&lt;/ref&gt;&lt;/computeroutput&gt; &lt;/para&gt;&lt;/detaileddescription&gt; </pre> </description> <category>Ticket</category> </item> <item> <dc:creator>Daniel James</dc:creator> <pubDate>Sun, 02 Aug 2009 18:15:45 GMT</pubDate> <title/> <link>https://svn.boost.org/trac10/ticket/3309#comment:3 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/3309#comment:3</guid> <description> <p> I'm going to do this in two parts because for a lot of the existing documentation, doxygen converts words to refs that probably shouldn't be refs. Do you know if there's a way to stop it? </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Daniel James</dc:creator> <pubDate>Sun, 02 Aug 2009 18:18:16 GMT</pubDate> <title/> <link>https://svn.boost.org/trac10/ticket/3309#comment:4 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/3309#comment:4</guid> <description> <p> (In <a class="changeset" href="https://svn.boost.org/trac10/changeset/55370" title="Pass through more elements in doxygen2boostbook. Refs #3309.">[55370]</a>) Pass through more elements in doxygen2boostbook. Refs <a class="closed ticket" href="https://svn.boost.org/trac10/ticket/3309" title="#3309: Bugs: Passthrough mode in doxygen2boostbook is not pass-through and ignores ... (closed: fixed)">#3309</a>. </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Daniel James</dc:creator> <pubDate>Tue, 18 Aug 2009 07:54:19 GMT</pubDate> <title>milestone changed https://svn.boost.org/trac10/ticket/3309#comment:5 https://svn.boost.org/trac10/ticket/3309#comment:5 <ul> <li><strong>milestone</strong> <span class="trac-field-old">Boost 1.40.0</span> → <span class="trac-field-new">Boost 1.41.0</span> </li> </ul> Ticket Daniel James Sat, 10 Oct 2009 14:53:49 GMT <link>https://svn.boost.org/trac10/ticket/3309#comment:6 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/3309#comment:6</guid> <description> <p> (In <a class="changeset" href="https://svn.boost.org/trac10/changeset/56702" title="Merge some documentation changes and inspect fixes. Merged revisions ...">[56702]</a>) Merge some documentation changes and inspect fixes. </p> <p> Merged revisions 55370,55729,56440,56570-56571,56603,56697-56699 via svnmerge from <a class="ext-link" href="https://svn.boost.org/svn/boost/trunk"><span class="icon">​</span>https://svn.boost.org/svn/boost/trunk</a> </p> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/55370" title="Pass through more elements in doxygen2boostbook. Refs #3309.">r55370</a> | danieljames | 2009-08-02 19:18:14 +0100 (Sun, 02 Aug 2009) | 1 line </p> </blockquote> <p> </p> <blockquote> <p> Pass through more elements in doxygen2boostbook. Refs <a class="closed ticket" href="https://svn.boost.org/trac10/ticket/3309" title="#3309: Bugs: Passthrough mode in doxygen2boostbook is not pass-through and ignores ... (closed: fixed)">#3309</a>. </p> </blockquote> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/55729" title="Add depencies on doxygen documentation to standalone documentation ...">r55729</a> | danieljames | 2009-08-23 11:07:25 +0100 (Sun, 23 Aug 2009) | 3 lines </p> </blockquote> <p> </p> <blockquote> <p> Add depencies on doxygen documentation to standalone documentation targets. </p> </blockquote> <p> </p> <blockquote> <p> This seems to be needed for building pdfs. </p> </blockquote> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/56440" title="Fix silly error in doxygen test file.">r56440</a> | danieljames | 2009-09-27 20:11:39 +0100 (Sun, 27 Sep 2009) | 1 line </p> </blockquote> <p> </p> <blockquote> <p> Fix silly error in doxygen test file. </p> </blockquote> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/56570" title="Clean up some unordered TODOs.">r56570</a> | danieljames | 2009-10-04 11:37:36 +0100 (Sun, 04 Oct 2009) | 1 line </p> </blockquote> <p> </p> <blockquote> <p> Clean up some unordered TODOs. </p> </blockquote> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/56571" title="Detab.">r56571</a> | danieljames | 2009-10-04 11:37:56 +0100 (Sun, 04 Oct 2009) | 1 line </p> </blockquote> <p> </p> <blockquote> <p> Detab. </p> </blockquote> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/56603" title="Various inspect fixes.">r56603</a> | danieljames | 2009-10-05 22:29:39 +0100 (Mon, 05 Oct 2009) | 1 line </p> </blockquote> <p> </p> <blockquote> <p> Various inspect fixes. </p> </blockquote> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/56697" title="Add forwarding html file for accumulators.">r56697</a> | danieljames | 2009-10-10 14:00:28 +0100 (Sat, 10 Oct 2009) | 1 line </p> </blockquote> <p> </p> <blockquote> <p> Add forwarding html file for accumulators. </p> </blockquote> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/56698" title="Missing newline.">r56698</a> | danieljames | 2009-10-10 14:01:14 +0100 (Sat, 10 Oct 2009) | 1 line </p> </blockquote> <p> </p> <blockquote> <p> Missing newline. </p> </blockquote> <p> ........ </p> <blockquote> <p> <a class="changeset" href="https://svn.boost.org/trac10/changeset/56699" title="Add copyright to boostbook reference xml.">r56699</a> | danieljames | 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) | 1 line </p> </blockquote> <p> </p> <blockquote> <p> Add copyright to boostbook reference xml. </p> </blockquote> <p> ........ </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Daniel James</dc:creator> <pubDate>Mon, 28 Feb 2011 22:51:06 GMT</pubDate> <title/> <link>https://svn.boost.org/trac10/ticket/3309#comment:7 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/3309#comment:7</guid> <description> <p> Resolving as fixed. If anyone wants to deal with <code>&lt;ref&gt;</code> I created <a class="new ticket" href="https://svn.boost.org/trac10/ticket/5243" title="#5243: Feature Requests: Support doxygen &lt;ref&gt; elements in passthrough mode. (new)">#5243</a>. No example of why <code>&lt;initializer&gt;</code> support is needed, so I can't do anything there. </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Daniel James</dc:creator> <pubDate>Mon, 28 Feb 2011 22:52:00 GMT</pubDate> <title>status changed; resolution set https://svn.boost.org/trac10/ticket/3309#comment:8 https://svn.boost.org/trac10/ticket/3309#comment:8 <ul> <li><strong>status</strong> <span class="trac-field-old">assigned</span> → <span class="trac-field-new">closed</span> </li> <li><strong>resolution</strong> → <span class="trac-field-new">fixed</span> </li> </ul> <p> Resolving properly this time. </p> Ticket