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

Subject: [Boost-docs] \tparam do not seem to be appearing in Quickbook doxygen reference section
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2011-08-23 13:33:54

Steven Watanabe said

"I've just committed basic \tparam support to the trunk."

http://lists.boost.org/boost-docs/2011/04/4478.php

but I've just come to try to use it (as has Pierre Talbot, GSoC student just completing his
documentation on the Checks project).

Attached are snips from the output from Doxygen standalone, showing the template parameters, and
then the Quickbook Doxygen reference output - this is  using mylibrary, a docs template at

I:\boost-sandbox\guild\mylibrary\libs\mylibrary\doc\ 

(This is easily and quickly rebuilt).

The code contains this example of using a \tparam command

 /*!
       nontype template function that just returns the template value.
      \tparam size is a constant integer argument.                  <<<<<<<<<<<<<<<<<<<<<<< template
parameter
      \returns constant integer size always.
      \pre No preconditions.
      \post No side effects.
  */
  template <int size>
  int nontype()
  {
    return size;
  }

I've inspected the 

autodoc-xml.doxygen file at

I:\boost-sandbox\guild\mylibrary\libs\mylibrary\doc\bin\msvc-10.0\debug\auto-index-internal-on\auto-
index-verbose-on\auto-index-on\threading-multi

and this contains this

        </inbodydescription>
        <location file="I:/boost-sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp" line="134"
bodyfile="I:/boost-sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp" bodystart="133"
bodyend="142"/>
      </memberdef>
      <memberdef kind="function" id="namespaceboost_1_1mylibrary_1a8ed0bbd6b6765624970840fd1927aba8"
prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>int</type>
            <declname>size</declname>
            <defname>size</defname>
          </param>
        </templateparamlist>
        <type>int</type>
        <definition>int boost::mylibrary::nontype</definition>
        <argsstring>()</argsstring>
        <name>nontype</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>nontype template function that just returns the template value. <parameterlist
kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>size</parametername>
</parameternamelist>

<parameterdescription>
<para>is a constant integer argument. </para></parameterdescription>

</parameteritem>
</parameterlist>

I think I'd expect to see a line like

<simplesect kind="templateparam"><para> is a constant integer argument. </para></simplesect>

here, before these expected lines.

<simplesect kind="return"><para>constant integer size always. </para></simplesect>
<simplesect kind="pre"><para>No preconditions. </para></simplesect>
<simplesect kind="post"><para>No side effects. </para></simplesect>
</para>

This is a quite recent Quickbook.exe build (though I am unable to build the most current in trunk -
some compile errors).

Is there something else I should be doing?  Or am doing wrong?

Paul

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