[Date Prev][Date Next][Thread Prev][Thread Next]
[Date Index]
[Thread Index]
- Subject: Re: [ANN] LuaDoc 3.0 Released
- From: David Kastrup <dak@...>
- Date: Wed, 15 Aug 2007 07:27:51 +0200
Ralph Hempel <rhempel@hempeldesigngroup.com> writes:
> Miles Bader wrote:
>>
>> I've noticed that a lot of these "automatic" doc systems seem to
>> yield similar results, e.g., doxygen "docs" which exhaustively
>> "document" every function, class, and variable, but give no useful
>> information whatsoever...
>
> Which is why a good source browser is useful. The source is after
> all the best and most current documentation :-)
Ths source suffers even worse from the problem: it gives information
at the wrong scale if you want to get a view of the bug picture.
> While I'm at it, every project should look at the Lua Reference
> Manual for system and API docs done right, IMHO.
And do you think that this manual could reasonably have been assembled
using a source comment extractor?
--
David Kastrup, Kriemhildstr. 15, 44793 Bochum