Re: [boost] Reference documentation: one approach

From: David Abrahams (dave_at_[hidden])
Date: 2002-10-30 16:33:35

Douglas Gregor <gregod_at_[hidden]> writes:

> On Wednesday 30 October 2002 12:29 pm, Jeff Garland wrote:
> > Well I had given up on generation, but maybe I was premature.  One topic we
> > might discuss is the format for putting these sorts of comments in the
> > code.
> 
> I wouldn't give up on generation just yet, but we can't _require_ generation. 
> Well, I can't use generation, because there is no way that any program is 
> going to take function/function_template.hpp as input and come back with 
> sensible documentation.

I wouldn't count on it. I am getting _reasonable_ results for
preprocessor-generated portions of Boost.Python, and with suitable
annotation in comments I believe we could even generate the _desired_
results.

-- 
                    David Abrahams
dave_at_[hidden] * http://www.boost-consulting.com