Re: [boost] Boost documentation format (was Re: Boost documentation)

From: Matias Capeletto (matias.capeletto_at_[hidden])
Date: 2007-06-25 17:04:55

On 6/25/07, Gennadiy Rozental <gennadiy.rozental_at_[hidden]> wrote:
>
> "Douglas Gregor" <dgregor_at_[hidden]> wrote in message
> news:468025D2.4050102_at_osl.iu.edu...
> > Gennadiy Rozental wrote:
> > The DocBook or BoostBook XML will be generated via Quickbook when
> > needed. Or do you want the DocBook/BoostBook XML to always be in the
> > source tree, even if it can be regenerated?
>
> Yes. Essentially  I should be able to generate docs for any library and know
> nothing about quickbook and it's tools whatsoever. And how you make this
> file - you own business.

I agree with Gennady.
It is better for now to separate quickbook from dockbook.

We may ask authors to provide:

libs/{lib_name}/doc/{lib_name}.xml
libs/{lib_name}/doc/--stringparam

I like .xml over .docbook but I have no strong opinions about this.
The --stringparam contains parameters that affects the chunker, that
have to be library independent.

Best regards
Matias