Re: [boost] [GSoC] [Boost.Hana] Formal review request

Subject: Re: [boost] [GSoC] [Boost.Hana] Formal review request
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2014-07-29 13:44:27

> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Louis Dionne
> Sent: 29 July 2014 18:03
> To: boost_at_[hidden]
> Subject: Re: [boost] [GSoC] [Boost.Hana] Formal review request
> Is it mandatory for a Boost library to have BoostBook documentation?
> I'd like to stay as mainstream as possible in the tools I use and reduce
> the number of steps in the build/documentation process for the sake of
> simplicity. Is there a gain in generating the documentation in BoostBook?

It certainly isn't compulsory, but it gives it a Boosty look'n'feel that will
probably make it easier for Boost users to navigate.

For Boost, Quickbook, Boostbook, Doxygen *is* mainstream ;-)

IMO, the nicest docs start with Quickbook, an easy but very powerful 'markup
language'.

You can use all your Doxygen comments in your code to provide a C++ reference
section with no extra work.

And you can prepare automatic indexes that help user find their way around.

Tell me if I can help.

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal UK LA8 8AB
[phone]