Boost logo

Boost :

Subject: Re: [boost] [Documentation] Does Boost-Build support Doxygen documentation for tutorials (rather then quickbook)
From: Mathias Gaunard (mathias.gaunard_at_[hidden])
Date: 2010-12-13 07:39:21

On 13/12/2010 09:25, Artyom wrote:
> Hello,
> I would like to know if boost-build supports writing tutorials
> using Doxygen rather that using HTML or its own "quickbook" tool.

Both quickbook and doxygen can be transformed to boostbook, and several
boostbook documents can be linked together.

Note this has little to do with boost build. The documentation system
and the build system are separate things.

> At this point I have Boost.Locale documentation written with Markdown
> and I want to transfer it to other tool. I want to use Doxygen for
> it as Boost.Locale reference is already documented using Doxygen
> so converting the tutorials from markdown to Doxygen format
> seems to me much better idea then using "internal" boost documentation
> format.
> Rationale:
> - Doxygen is more widely available tool then quickbook.
> - It is independent from boost itself.
> - It is useful for non-boost project
> - Documentation generation is much simpler (requires running Doxygen)
> rather then using complicated tool-chain of boost-build.

Most boost libraries already use doxygen for their "reference" part,
while they use quickbook for the parts which are mostly text.

Boost list run by bdawes at, gregod at, cpdaniel at, john at