[lwip-users] Re: [lwip] lwIP source code documentation proposal

[Adam Dunkels]

Hi!

On Wednesday 08 May 2002 11.36, address@hidden wrote:
> Adam, welcome back :)

Thanks! :-)

> There have been some discussions on documentation on lwIP.
>
> What do you guys thinks of self-documenting source code?
>
> I have recently been using the JavaDoc standard to document my own C
> sources, that can be easily extracted and neatly formatted HTML, PDF,
> whatever is generated by open-source tools such as doxygen(.org).
>
> I feel that especially the function calls to lwIP need more documentation
> in
> order for newbies to understand how to use the stack.
>
> Choosing self-documenting source code (and a format,; JavaDoc) would
> help us submit not only code, but also documentation.

Definately a good idea! Can doxygen work directly with JavaDoc comments?

/adam
-- 
Adam Dunkels <address@hidden>
http://www.sics.se/~adam

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