Re: [Boost-users] Quickbook quick start

Subject: Re: [Boost-users] Quickbook quick start
From: Peng Yu (pengyu.ut_at_[hidden])
Date: 2009-05-03 17:32:33

On Sun, May 3, 2009 at 3:34 PM, tom fogal <tfogal_at_[hidden]> wrote:
> Peng Yu <PengYu.UT_at_[hidden]> writes:
>> I wan to use Quickbook to generate documentation for my code to be
>> submit to boost. I understand that Quickbook could help make the code
>> and the documentation consistent. But there is no a tutorial webpage
>> that describes how I can get started with Quickbook.
>
> Getting started:
>
>  http://www.boost.org/doc/libs/1_39_0/doc/html/quickbook/install.html
>
> Documenting:
>
>  http://www.boost.org/doc/libs/1_39_0/doc/html/quickbook/syntax.html

I am looking for some example files so that I can run quickbook on it
and generate some test documentation.

I see the example at the end of the page the second link points to.
But it is hard to see it if you didn't point that page to me. Would
you please let me know what command I should use to generate a
documentation page from that file?

http://www.boost.org/doc/libs/1_39_0/tools/quickbook/test/stub.cpp

BTW, I still think that the quickbook document should provide some
easy example files so that I try.

Regards,
Peng