Re: [boost] Improving Documentation

Subject: Re: [boost] Improving Documentation
From: Niall Douglas (s_sourceforge_at_[hidden])
Date: 2013-10-10 18:13:11

On 10 Oct 2013 at 14:58, Robert Ramey wrote:

> > Documentation like this is generated by preprocessing Doxygen XML
> > output  to integrate it into Boostbook and have a good look for C++
> > references.
> 
> > It has most of what you can expect from Doxygen + the Boostbook stuff
> > which gives better cross-referencing than simple Doxygen.
> 
> Hmm - I looked at DOxygen and found it lacking for what I wanted.  I'm
> also disappointed in the Doxygen generated documentation in boost which
> to me mostly parrots the source code.  On the other hand, I think the
> approach (literate programming) has promise but it seemed to me that
> one would have to add a lot to Doxygen to generate what I would like
> to see.  Maybe the "missing magic" is already in on our web site somewhere.
> Basically I don't see where we can coordinate Boostbook with Doxygen.
> Perhaps you could include the link which explains this.

Boost.Geometry contains a utility called doxygen_xml2qbk which 
converts Doxygen XML into Quickbook.

AFIO uses a patched modified copy of that utiliy for its docs. Here 
is a sample of its output:

https://ci.nedprod.com/view/All/job/Boost.AFIO%20Build%20Peer%20Review
%20Documentation/Boost.AFIO_Documentation/doc/html/afio/reference/clas
ses/async_file_io_dispatcher_base/read_1_batch.html

I think that's okay?

Niall

-- 
Currently unemployed and looking for work.
Work Portfolio: http://careers.stackoverflow.com/nialldouglas/