Re: [Boost-docs] Doxygen /tparam tag not working?

Subject: Re: [Boost-docs] Doxygen /tparam tag not working?
From: Steven Watanabe (watanabesj_at_[hidden])
Date: 2011-03-31 16:10:28


On 03/31/2011 09:01 AM, John Maddock wrote:
>>> Folks, I'm trying to get to grips with the "Doxygenated" Pool lib docs
>>> (in the sandbox) and notice that template params documented with \tparam
>>> don't appear in the output. Is this a known issue? Or is there some
>>> other way we should be documentating class template params?
>> As it happens, I ran into this a few days ago too.
>> I fixed it locally, unfortunately, the BoostBook
>> template-parameter element can only have a <purpose>,
>> not a <description>, so I'm not entirely happy
>> with it.
> Any old definition-list would work for me ;-)

With the current BoostBook stylesheets, purpose
ends up as a comment in the synopsis (just as
with typedefs). I don't really like this, since
it clutters the synopsis if the description is
more than a few words. (Okay, it didn't even wrap
properly. I had to fix it to indent and add //
when it started a new line.).

In Christ,
Steven Watanabe

This archive was generated by hypermail 2.1.7 : 2017-11-11 08:50:41 UTC