Boost logo

Boost :

Subject: Re: [boost] Summer of Code 2010
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2010-03-08 12:46:09


> -----Original Message-----
> From: boost-bounces_at_[hidden] [mailto:boost-bounces_at_[hidden]] On
Behalf Of
> Jake Voytko
> Sent: Monday, March 08, 2010 4:20 PM
> To: boost_at_[hidden]
> Subject: Re: [boost] Summer of Code 2010
>
> On Mon, Mar 8, 2010 at 8:15 AM, Andrew Sutton <andrew.n.sutton_at_[hidden]>
wrote:
> >
> > Were you generating full releases each weak? I can certainly see how that
> > policy can be used to measure progress. That's actually a good idea since it
> > forces the student to think about end product as much as the code.
>
> Yes. There were exceptions: sometimes the documentation lagged behind,
> but overall the project advanced in lock-step once a week.

Yes - it did!

And Jake got the documentation working at an early stage.

We could use a Quickbook template to get GSoC people off the ground immediately,
even before they write any C++.

In retrospect it would have been even better to document the source using
Doxygen as it was written.

This was a massively tedious job afterwards :-(

The reference section produced by Doxygen for Quickbook saves a lot of tedious
work, and most important, is updated as the code changes.

So I would say that not only the C++ stuff but the docs should be uploaded very
often - each time some section is working at all, and probably more frequently
than weekly. Warts and all!

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal, UK   LA8 8AB
+44 1539 561830, mobile +44 7714330204
pbristow_at_[hidden]

Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk