tasklwIP - A Lightweight TCP/IP stack - Tasks: task #1549, lwIP function documentation

 
 

You are not allowed to post comments on this tracker with your current authentication level.

task #1549: lwIP function documentation

Submitter:  Leon Woestenberg <likewise>
Submitted:  -
Votes: 8
 
Category:  Documentation Should Start On:  Fri 18 Oct 2002 10:00:00 PM UTC
Should be Finished on:  Fri 04 Apr 2003 10:00:00 PM UTC Priority:  6
Status:  Done Privacy:  Public
Assigned to:  None Percent Complete:  100%
Open/Closed:  Closed Planned Release:  None
Effort:  200.00

Jump to the original submission

Fri 26 Mar 2010 04:45:36 PM UTC, comment #14: 

After more than 2 years now, I'm OK with the function documentation status we have reached.

Simon Goldschmidt <goldsimon>
Group administrator
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 ;-)

Simon Goldschmidt <goldsimon>
Group administrator
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?

Frédéric Bernon <fbernon>
Group Member
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...

Simon Goldschmidt <goldsimon>
Group administrator
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...


Frédéric Bernon <fbernon>
Group Member
Fri 10 Aug 2007 09:54:37 AM UTC, comment #9: 

Update of Doxygen documentation (RTF+PDF) ~145pages


(file #13640)

Frédéric Bernon <fbernon>
Group Member
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.

Kieran Mansley <kieranm>
Group Member
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!

Simon Goldschmidt <goldsimon>
Group administrator
Sat 09 Jun 2007 04:14:21 PM UTC, comment #6: 

Thanks. I only hope they are right, hehe!

Simon Goldschmidt <goldsimon>
Group administrator
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 !!!

Frédéric Bernon <fbernon>
Group Member
Fri 08 Jun 2007 08:14:03 PM UTC, comment #4: 

@done:
- src/netif

Simon Goldschmidt <goldsimon>
Group administrator
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 ;-)

Simon Goldschmidt <goldsimon>
Group administrator
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!

Simon Goldschmidt <goldsimon>
Group administrator
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.

Kieran Mansley <kieranm>
Group Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attached Files
file #13640:  lwip-doc.CVS_HEAD.zip added by fbernon (475KiB - application/zip)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by fbernon (Posted a comment)
  • -email is unavailable- added by goldsimon (Posted a comment)
  • -email is unavailable- added by kieranm (Posted a comment)
  •  

    There are 8 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 13 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2010-03-26 goldsimon StatusNone Done
        Percent Complete70% 100%
        Open/ClosedOpen Closed
    2007-08-10 fbernon Attached File- Added lwip-doc.CVS_HEAD.zip, #13640
    2007-06-18 goldsimon Percent Complete50% 70%
    2007-06-08 goldsimon Percent Complete40% 50%
    2007-06-08 goldsimon Percent Complete0% 40%
    2007-03-05 kieranm Percent Complete5 (Error - Not Found) 0%
    2006-07-18 sduyan Carbon-Copy- Added -email is unavailable-
        Carbon-Copy- Added sduyan
    2002-11-29 likewise Percent Complete15 (Error - Not Found) None
    2002-11-29 likewise Percent CompleteNone None
        end_date1034978400

    Back to the top

    Powered by Savane 3.13-3230.
    Corresponding source code