[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [lwip-devel] rawapi documentation update
From: |
Sylvain Rochet |
Subject: |
Re: [lwip-devel] rawapi documentation update |
Date: |
Tue, 22 Sep 2015 00:15:17 +0200 |
User-agent: |
Mutt/1.5.21 (2010-09-15) |
Hi Sergio,
On Sun, Sep 13, 2015 at 07:15:12PM -0300, Sergio R. Caprile wrote:
> Hi Sylvain,
> For what is worth, me and other non-oficial developers have discovered
> that and maintained a separate volunteered documentation in the wiki.
> http://lwip.wikia.com/wiki/Raw/native_API
> For your particular comment:
> http://lwip.wikia.com/wiki/Raw/TCP
Well, I'm not very fan of wiki for documentation, they tend to get
either out of sync with the current codebase or if they are updated they
lost the documentation which applies to previous software version.
The wiki doesn't seem to contain that much data, I started merging the
threading part into the rawapi.txt documentation file. What do you think
about populating the lwIP doc/ with a checked and updated content from
the wiki ?
If necessary we can switch the documentation itself to doxygen (or any
other documentation system, I don't care) so we will be able to generate
plaintext and more human friendly html/pdf outputs.
Sylvain
signature.asc
Description: Digital signature