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

 
 
Show feedback again

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

task #1549: lwIP function documentation

Submitted by:  Leon Woestenberg <likewise>
Submitted on:  -  
Votes:  8  
 
Category: DocumentationShould Start On: Fri 18 Oct 2002 10:00:00 PM UTC
Should be Finished on: Fri 04 Apr 2003 10:00:00 PM UTCPriority: 6
Status: NonePrivacy: Public
Percent Complete: 70%Assigned to: None
Open/Closed: OpenPlanned Release: None
Effort: 200.00

(Jump to the original submission Jump to the original submission)

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>
Project Member
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>
Project 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>
Project Member
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>
Project 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>
Project 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>
Project Administrator
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>
Project Member
Sat 09 Jun 2007 04:14:21 PM UTC, comment #6:

Thanks. I only hope they are right, hehe!

Simon Goldschmidt <goldsimon>
Project Member
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>
Project Member
Fri 08 Jun 2007 08:14:03 PM UTC, comment #4:

@done:
- src/netif

Simon Goldschmidt <goldsimon>
Project Member
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>
Project Member
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>
Project Member
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>
Project Administrator

 

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

 

Depends on the following items: None found

Items that depend on this one: None found

 

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

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 8 encouragements so far.

    Only logged-in users can vote.

     

    Please enter 421 here (basic anti-spam test):

     

     

    Follow 10 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Fri 10 Aug 2007 09:54:37 AM UTCfbernonAttached File-=>Added lwip-doc.CVS_HEAD.zip, #13640
    Mon 18 Jun 2007 07:55:23 PM UTCgoldsimonPercent Complete50%=>70%
    Fri 08 Jun 2007 08:14:03 PM UTCgoldsimonPercent Complete40%=>50%
    Fri 08 Jun 2007 12:55:49 PM UTCgoldsimonPercent Complete0%=>40%
    Mon 05 Mar 2007 09:16:55 AM UTCkieranmPercent Complete5(Error - Not Found)=>0%
    Tue 18 Jul 2006 08:07:31 AM UTCsduyanCarbon-Copy-=>Added -unavailable-
      Carbon-Copy-=>Added sduyan
    Fri 29 Nov 2002 09:06:52 AM UTClikewisePercent Complete15(Error - Not Found)=>(Error - Not Found)
    Fri 29 Nov 2002 09:06:37 AM UTClikewisePercent Complete0(Error - Not Found)=>(Error - Not Found)
      end_date1034978400=>
    Show feedback again

    Back to the top


    Powered by Savane 3.1-cleanup