|
|
Boost : |
Subject: Re: [boost] Improving Documentation
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2013-10-14 13:39:59
> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Mathias Gaunard
> Sent: Monday, October 14, 2013 10:55 AM
> To: boost_at_[hidden]
> Subject: Re: [boost] Improving Documentation
>
> On 12/10/13 19:59, Eric Niebler wrote:
>
> > I've also been frustrated by the poor support for concepts in our
> > documentation toolchain. "Just write your docs in Boostbook XML" is
> > like telling people to program in assembly -- if assembly were extremely verbose.
>
> Maybe Quickbook could be extended to be able to output the required XML for concepts?
What is required that is not already provided by Doxygen comments of type
\tparam \param \pre \post \returns etc?
If we have a concept like
template <class T>
struct DefaultConstructable;
It will be possible to get a link to this from \tparam description
\tparam The type of the elements stored in the circular_buffer. T has to be DefaultConstructible.
In the C++ reference section this will produce
Template Parameters
typename T
The type of the elements stored in the circular_buffer.
T has to be DefaultConstructible
(and circular_buffer and DefaultConstructible will both automatically be hyperlinks - this is what
Doxygen really does for you).
Similarly for preconditions \pre and \post conditions and \returns...
Paul
--- Paul A. Bristow, Prizet Farmhouse, Kendal LA8 8AB UK +44 1539 561830 07714330204 pbristow_at_[hidden]
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk