Please help me with document extraction.

[Max TenEyck Woodbury]

On 02/27/2011 02:49 PM, Alexandre Julliard wrote:
> Max TenEyck Woodbury<max at mtew.isa-geek.net>  writes:
>
>> P.S. to AJ et al.
>>
>> There is a _lot_ of documentation embedded in the wine code, but it is
>> hard to find at the moment. I'd like to see it indexed and this is the
>> program that does the extraction and indexing. Advice on making this
>> new version available and active are in order.
>
> This has already been discussed, but documentation on the Windows API
> doesn't belong in the source code. I've been accepting small amounts of
> function documentation (which IMHO is pretty much useless) along with
> implementations, but I'm not going to accept significantly more than
> that. This is why you were directed to do this as a separate project.
>
But it _does_ belong someplace in the repository and there is already a
lot of it embedded.

I'm also not sure that what is in there already can really be called
documentation of the _Windows_ API. Rather it is documentation of what
we _think_ the API is. That is a small but important difference.

I'd also like clarification on why you think it does _not_ belong in
the source code. Some projects insist that documentation _has_ to be
part of the source code so that it will be properly maintained.

Max