Re: [Boost-docs] [quickbook] Comments

Subject: Re: [Boost-docs] [quickbook] Comments
From: Paul A Bristow (pbristow_at_[hidden])
Date: 2007-07-29 12:51:12

>-----Original Message-----
>From: boost-docs-bounces_at_[hidden] 
>[mailto:boost-docs-bounces_at_[hidden]] On Behalf Of Joel de Guzman
>Sent: 29 July 2007 13:04
>To: Discussion of Boost Documentation
>Subject: Re: [Boost-docs] [quickbook] Comments
>
>Paul A Bristow wrote:
>> 
>> In particular, it breaks the [endsect][/section:overview 
>Quickbook Overview]
>> 
>> style that I have used to make clearer, especially to me, 
>the nesting of
>> sections.
>> 
>> So it would means LOTS of edits :-(
>
>Yeah :(
>
>Oh, BTW the proposed syntax for that is:
>
>     [endsect:overview Quickbook Overview]
>
>where ":overview Quickbook Overview" is optional and if present
>makes Qbk check for balanced section/endsect. How many times have
>you been bitten by this? Me, lots!

Well that is a BIG improvement - and worth the many edits.

The other big use of comments is copyright info like:

[/ 
  Copyright 2006 John Maddock and Paul A. Bristow.
  Distributed under the Boost Software License, Version 1.0.
  (See accompanying file LICENSE_1_0.txt or copy at
  http://www.boost.org/LICENSE_1_0.txt).
]

There SHOULD be quite a lot of these to edit too ;-))

And it might be useful to have some better way of doing this - the first few files I went to to get an example turned out not to
have a copyright - ooops!

Can we help automate this somehow?

Paul

---
Paul A Bristow
Prizet Farmhouse, Kendal, Cumbria UK LA8 8AB
[phone] & SMS, Mobile [phone] & SMS
pbristow_at_[hidden]