[lwip-users] Re: [lwip] Suggestion: javadoc

[Kieran Mansley]

On Tue, 20 Aug 2002, Jani Monoses wrote:

> Well code with no documentation is worse.
> I think that some 'to the point' documentation through the
> lwip sources is more than welcome.
> Nobody said anything about explaining HOW the code works in the comments.
> A short WHAT especially in the functions which are supposed to be called by 
> apps
> is enough.

Quite.  Everyone agrees that it would help those new to lwIP to have more
documentation.  Even if this is simply documenting the APIs and explaining
how functions should be called, rather than explaining the details of the
algorithms.  I don't mind how this is done, and here is not the place to
discuss the relative merits of in-source or seperate documentation.
However, when discussed previously we came to the conclusion that javadoc
style comments are compatible with a large number of tools (they seem to
be an de facto standard) and have many supporters among those using lwIP.
This would seem to make that syntax a good choice.

Kieran


[This message was sent through the lwip discussion list.]