Mon 05 Nov 2007 04:32:25 PM UTC, comment #13:
I just think something like
>>> snip >>>
etharp_hdr Struct Reference
#include <etharp.h>
Detailed Description
the ARP message
<<< snap <<<
is not very helpful ;-)
|
Sun 04 Nov 2007 12:49:18 PM UTC, comment #12:
>Besides, I'm still not satisfied with the Doxygen output, while the functions are quite OK, structs and files could need some attention.
Can you give me a sample of structs & files causing problems?
|
Sun 04 Nov 2007 11:41:00 AM UTC, comment #11:
I think it doesn't hurt to leave this task open, maybe rename it to PPP/IPv6 function documentation?
Besides, I'm still not satisfied with the Doxygen output, while the functions are quite OK, structs and files could need some attention...
|
Fri 02 Nov 2007 07:29:03 PM UTC, comment #10:
Since now, http://lwip.scribblewiki.com seems to be accessible to most of users, and since most of active developers have an account on it, I propose to close this task to avoid to have multiple place to centralize the documentation. No objections?
More, like Kieran, I don't think there will be any volunteers for PPP, IPv6 or SNMP...
|
Fri 10 Aug 2007 09:54:37 AM UTC, comment #9:
Update of Doxygen documentation (RTF+PDF) ~145pages
(file #13640)
|
Fri 13 Jul 2007 12:09:40 PM UTC, comment #8:
Thanks Simon - very helpful. I doubt we'll get volunteers for PPP or ipv6 as we don't have anyone developing those areas.
|
Mon 18 Jun 2007 07:55:23 PM UTC, comment #7:
Also done src/api (except for sockets.c, that is pretty self-explaining for people who know sockets. I think we should point to a good explanation instead of writing our own!)
What remains is
- src/netif/ppp
- src/core/ipv6
- src/core/snmp
and I don't think I'll do them!
|
Sat 09 Jun 2007 04:14:21 PM UTC, comment #6:
Thanks. I only hope they are right, hehe!
|
Sat 09 Jun 2007 11:55:08 AM UTC, comment #5:
I don't have read all the comments, but it's a good job !!!
|
Fri 08 Jun 2007 08:14:03 PM UTC, comment #4:
@done:
- src/netif
|
Fri 08 Jun 2007 12:55:49 PM UTC, comment #3:
@done:
- src/core
- src/core/ipv4
still todo:
- src/api
- src/core/ipv6 ???
- src/core/snmp
- src/netif
- src/netif/ppp ???
??? means I don't use that code so I don't think I will comment it any time ;-)
|
Mon 21 May 2007 05:04:27 PM UTC, comment #2:
@todo: document that sockets don't get informed if their local address change. (an exception [in contrast to linux] is TCP)
-> we've got no file (sequentialapi.txt) to put that, yet!
|
Mon 05 Mar 2007 09:16:55 AM UTC, comment #1:
Hmm, someone recently volunteered to do some documentation - if only I could remember who, I could assign this to them.
|