Re: [boost] Summer of Code 2010

Subject: Re: [boost] Summer of Code 2010
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2010-03-09 05:11:54

> -----Original Message-----
> From: boost-bounces_at_[hidden] [mailto:boost-bounces_at_[hidden]] On
Behalf Of
> Daniel James
> Sent: Monday, March 08, 2010 6:27 PM
> To: boost_at_[hidden]
> Subject: Re: [boost] Summer of Code 2010
> 
> On 8 March 2010 17:52, Andrew Sutton <andrew.n.sutton_at_[hidden]> wrote:
> >
> >  I'm a big fan of Doxygen + Quickbook :) Is there a template floating around
> > that we give to students that will work once they're properly set up their
> > environments?
> 
> https://svn.boost.org/svn/boost/sandbox/example/

This is fine - as far as it goes - but it could use a lot of comments to explain
to the non-cognoscenti what is going on.

(It's written in the Outer Mongolian of computer languages don't forget!)

But it's very far from the Full Monty with all the tricks of the trade (black
arts!) to get the benefit from the full Doxygen and code snippets (not to
mention indexing - pioneered by John Maddock but not quite working well yet).

I've been working intermittently on a much fuller example, but keep getting
distracted.

(And every time I alter something it goes wrong :-(

Making the documentation process slicker could be a GSoC project?  Perhaps
improving the documentation for some existing Boost libraries (s) en route might
be good too.

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal, UK   LA8 8AB
[phone], mobile [phone]
pbristow_at_[hidden]