Re: [Boost-docs] \tparam do not seem to be appearing in Quickbook doxygen reference section

Subject: Re: [Boost-docs] \tparam do not seem to be appearing in Quickbook doxygen reference section
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2011-09-03 14:32:16

> -----Original Message-----
> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of
> Daniel James
> Sent: Tuesday, August 23, 2011 9:36 PM
> To: Discussion of Boost Documentation
> Subject: Re: [Boost-docs] \tparam do not seem to be appearing in Quickbook doxygen reference
section
> 
> On 23 August 2011 14:33, Paul A. Bristow <pbristow_at_[hidden]> wrote:
> > Steven Watanabe said
> >
> > "I've just committed basic \tparam support to the trunk."
> >
> > http://lists.boost.org/boost-docs/2011/04/4478.php
> 
> Looking at the test case
> (tools/boostbook/test/test/doxygen/boost/example.hpp), that was probably just for classes.
> 
> > autodoc-xml.doxygen file at
> 
> This is the xml output from doxygen combined into a single file. It hasn't been processed by us
yet.
> 
> > This is a quite recent Quickbook.exe build (though I am unable to
> > build the most current in trunk - some compile errors).
> 
> The quickbook version isn't relevant here, because you're looking at the doxygen to boostbook
> transformation.

Well that's what I thought, but wanted to be sure I was using the latest version anyway.

There appears to be some code in the XSL in \boost-trunk\tools\boostbook\xsl\doxygen\
doxygen2boostbook.xsl  to handle this (and some tests), but it doesn't seem to work for me (or
Pierre Talbot whose GSoC code Quickbook fully Doxygenated documentation is rather spoilt by the lack
of \tparam details in the C++ reference section).

namespace boost {
  namespace mylibrary {
    class myclass;
    template<typename T> class templatet;
    int donowt(int);
    template<int size> int nontype();
  }
}

Description

nontype template function that just returns the template value.
Requires:No preconditions.
Postconditions: No side effects.
Returns:constant integer size always.

I expect

  \tparam size is a constant integer template value.

to produce

  Parameter size is a constant integer template value.

Is there something I can be doing wrong?  Or could I be using the wrong version  (my boost-root is
trunk) ?

Paul

---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
[phone]  07714330204
pbristow_at_[hidden]