Re: [Boost-build] Documentation nitpicks

From: Vladimir Prus (ghost_at_[hidden])
Date: 2006-04-24 10:41:08

Can any Quickbook gurus comment on the following issues? The report refers to 
tools/jam/doc/bjam.qbk 
Thanks in advance!

On Monday 03 April 2006 21:00, Richard Peters wrote:
> These are the documentation nitpicks of boost.jam. I've tried to
> correct most of them myself, and the results are in the attached diff.txt
> (and available on http://rpeters.org/jamdiff.txt ), but since I'm not at
> all familiar with the quickbook format, I didn't apply changes that affect
> quickbook syntax, but described here what the changes are:
>
> line 268: =bjam\[.exe\]= generates literally bjam\[.exe\], including the
> backslashes. I'm not familiar with the quickbook format. Can these simply
> be removed?
...
> line 441: A backslash (\): the backslash is not visible in the generated
> documentation. Should probably be escaped with another backslash.
....
> line 457: Same as in line 268, backslashes are displayed four times.
...
> line 918: [^=] is expected to generate = but doesn't do it. Instead, it
> causes ] to display and makes the rest of the line use the wrong font.
> [^+=] later in the line has the same problem.

- Volodya

-- 
Vladimir Prus
http://vladimir_prus.blogspot.com
Boost.Build V2: http://boost.org/boost-build2