Re: [boost] Improving Documentation

Subject: Re: [boost] Improving Documentation
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2013-10-16 05:27:45

> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Niall Douglas
> Sent: Tuesday, October 15, 2013 7:00 PM
> To: boost_at_[hidden]
> Subject: Re: [boost] Improving Documentation
> 
> On 15 Oct 2013 at 18:46, Mathias Gaunard wrote:
> 
> > > New versions of Doxygen also uses clang.
> >
> > I'm looking at this right now.
> > Looks like you need to specify CLANG_ASSISTED_PARSING to YES and then
> > you can pass options with CLANG_OPTIONS.
> 
> Last time I looked doxygen wasn't using libclang in the right way (i.e. via the json database for
compile
> flags), and all that was going to be ripped out and replaced with the right way of invocation.
> Until that happens, I'd wait.

Agreed.

By using Doxygen, all that we are really deciding to do now is to use the Doxygen *comments syntax*
to describe our functions, classes etc.

In future, I see the compiler associating comments and links with functions and classes etc.

But the compiler is still far too stupid to write the descriptive comments that make sense to
humans. (It might help with pre and post conditions.)  So the author still has work to do.

Paul

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