Dirk Ziegelmeier
94ad523357
Update lwip.Doxyfile to doxygen 1.8.13
2018-01-12 15:01:14 +01:00
Dirk Ziegelmeier
004b13ca09
Work on task #14780 : Add debug helper asserts to ensure threading/locking requirements are met
...
Update documentation
2018-01-02 21:45:30 +01:00
Dirk Ziegelmeier
c20d50acec
Update cache handling in ZeroCopyRx.c - invalidate is faster than flushing
2018-01-02 08:40:23 +01:00
Dirk Ziegelmeier
e77099673c
Add flushing CPU cache to zero-copy RX code example
2017-12-24 13:12:32 +01:00
Dirk Ziegelmeier
27ca731242
Improve cache handling notes from my last commit some more
2017-12-24 13:07:35 +01:00
Dirk Ziegelmeier
8f6b876ef9
Common pitfalls document: Add note that lwip writes to ethernet RX buffers (caching issue!)
2017-12-24 13:02:30 +01:00
Dirk Ziegelmeier
1e0501c31a
Improve HTTPD documentation
2017-11-17 10:08:35 +01:00
Dirk Ziegelmeier
ddcf9cc764
Move all rawapi.txt to appropriate doxygen docs
2017-10-20 21:40:23 +02:00
Dirk Ziegelmeier
33ce04019d
Move API description text from rawapi.txt to doxygen docs
2017-10-20 18:44:58 +02:00
Dirk Ziegelmeier
a8edee8268
Move all text from sys_arch.txt to appropriate doxygen places
2017-10-20 18:23:06 +02:00
Dirk Ziegelmeier
8a46a853d2
Improve system abstraction layer doxygen docs by moving documentation from sys_arch.txt to sys.c
2017-10-17 22:38:18 +02:00
Dirk Ziegelmeier
26b2628f01
Improve system abstraction layer doxygen docs by moving documentation from sys_arch.txt to the corresponding functions
2017-10-17 22:30:51 +02:00
Dirk Ziegelmeier
33f29af0b6
Improve ZeroCopyRx.c code
2017-10-17 22:05:15 +02:00
Dirk Ziegelmeier
84b2a0f55b
Remove raw API TCP/UDP function documentation from rawapi.txt - it is now integrated in doxygen docs.
...
This avoid having a second description for the same stuff that is "bit-rotting" because noone remembers to update this file.
Also remove outdated and misleading zero-copy TX information.
2017-10-17 21:59:34 +02:00
Dirk Ziegelmeier
558bd73a6d
Fix comment indent in main_page.h
2017-10-16 23:27:00 +02:00
Dirk Ziegelmeier
001e1f1127
Improve lwIP doxygen documentation by copying several passages from rawapi.txt to the corresponding doxygen places
2017-10-16 23:24:52 +02:00
Dirk Ziegelmeier
921f601b5d
Improve lwIP doxygen documentation by copying several passages from rawapi.txt to the corresponding function documentation
2017-10-16 23:14:28 +02:00
Dirk Ziegelmeier
653a1e7778
Fix bug #52113 : recv callback: To free or not to free pbuf when returning ERR_ABRT?
...
Change the text according to Ambroz' suggestion
2017-10-16 10:01:45 +02:00
Our Air Quality
f934ca7a03
[PATCH] Deprecate sys_arch_sem_wait and sys_arch_mbox_fetch returning the time waited
...
These are now defined to return != SYS_ARCH_TIMEOUT on success rather than the time
waiting. The returned times were unused by lwip and this simplifies at
least some implementations.
Signed-off-by: goldsimon <goldsimon@gmx.de>
2017-07-20 22:04:34 +02:00
Our Air Quality
66a84cb2ef
Clarify that sys_arch_protect() always has a matching unprotect.
...
This is to allow an implementation to use a nesting counter, or a
recursive mutex. Also clarify that the value returned by
sys_arch_protect() is opaque to lwip and implementation dependent.
Signed-off-by: goldsimon <goldsimon@gmx.de>
2017-07-20 21:22:35 +02:00
goldsimon
8db0001e32
Adjust pbuf reuse documentation a bit: pbufs should never be reused after transmit
2017-05-18 09:19:08 +02:00
Adrey Vinogradov
46f2e25ce0
Fixed bug #51002
...
Signed-off-by: goldsimon <goldsimon@gmx.de>
2017-05-11 20:51:41 +02:00
Dirk Ziegelmeier
a09a8e4a06
Some documentation updates and fixes
...
Dedicated Zero-copy RX page
Fix doxygen warnings
2017-04-27 12:41:08 +02:00
Dirk Ziegelmeier
3266511ebb
Improve documentation, add TLS stuff
2017-03-28 21:25:49 +02:00
Dirk Ziegelmeier
ab736a4764
Add altcp to doxygen docs
2017-03-22 23:32:32 +01:00
Dirk Ziegelmeier
59fba75cd8
Update doxygen version to 2.0.3 as in init.h
2017-03-17 09:55:04 +01:00
Dirk Ziegelmeier
b9a40a5163
Fix coding style NO_SYS example code
2017-03-15 20:16:52 +01:00
Dirk Ziegelmeier
da0714d7cb
Fix starting DHCP in NO_SYS example code
2017-03-15 20:09:39 +01:00
Dirk Ziegelmeier
d9b279d150
Cleanup documentation a bit: rename "Addons" to "NETIFs" - its a more appropriate name
2017-03-15 20:03:55 +01:00
goldsimon
15918d8971
mdns.txt: changed the LWIP_MDNS_STRNCASECMP text again to reflect the fact that there are 2 names for 1 function...
2017-03-11 20:35:58 +01:00
goldsimon
681951c175
mdns.txt: LWIP_MDNS_STRNCASECMP -> lwip_strnicmp
2017-03-10 23:03:45 +01:00
Dirk Ziegelmeier
e4b356f08c
Add netif extended callback to doxygen docs
2017-02-26 09:56:16 +01:00
Dirk Ziegelmeier
a826b1aeeb
Add IPv6 scopes to documentation
2017-02-09 13:21:19 +01:00
goldsimon
48d2243845
Clarify/add LWIP_PROVIDE_ERRNO comments
2017-01-31 12:38:53 +01:00
Dirk Ziegelmeier
ee3154999a
Add CHANGELOG to lwIP HTML documentation
2017-01-24 11:45:51 +01:00
Dirk Ziegelmeier
861dab5b22
Set lwIP version to 2.0.2 in doxygen script
2017-01-15 09:22:33 +01:00
Axel Lin
7b40d1eb6f
doc: mqtt_client: Update example code after adding port parameter to mqtt_client_connect()
...
Signed-off-by: Axel Lin <axel.lin@ingics.com>
2016-12-24 15:10:56 +01:00
Dirk Ziegelmeier
6e219b6b11
Change signature of mqtt_client_connect() to take an IP addr instead of a string
2016-12-21 09:36:28 +01:00
Dirk Ziegelmeier
ec1450bac4
Add mqtt documentation from Erik Anderson, rev 4b84fff
2016-12-21 09:29:47 +01:00
Dirk Ziegelmeier
a2ad9d36ca
Improve documentation: Refer to compiler/platform abstraction in NO_SYS mode description
2016-12-08 15:25:38 +01:00
Dirk Ziegelmeier
33bdf9fa76
Doxygen: Fix project description text
2016-12-08 13:38:17 +01:00
Dirk Ziegelmeier
55fd567a84
Adapt doxygen docs version number
2016-12-08 13:37:01 +01:00
Joel Cunningham
7d0aeaf539
Doc: correct minor mis-spelling in sys_arch.txt
...
This corrects a minor mis-spelling where "by" was mis-spelled as "ny"
2016-11-30 10:28:38 -06:00
Richard Sailer
2ed755764e
doxygen/generate.sh: Add shebang line
...
This file had the x bit set.
But executing it produced an error, since it was
missing the "#!/bin/sh" line.
This patch adds the "#!/bin/sh" line and makes generate.sh directly executable.
2016-11-25 09:12:40 +01:00
Axel Lin
e040132d92
PPP, documentation: Fix example code
...
Fix the example code in status_cb() because dns_getserver() returns
const ip_addr_t *.
Signed-off-by: Axel Lin <axel.lin@ingics.com>
2016-10-23 10:00:54 +02:00
Dirk Ziegelmeier
5477aa5a42
Minor: Documentation update
2016-10-09 09:41:26 +02:00
Dirk Ziegelmeier
13fb616bb2
Cleanup hton*/ntoh* function handling and platform abstraction
...
Let lwip use functions/macros prefixed by lwip_ internally to avoid naming clashes with external #includes.
Remove over-complicated #define handling in def.h
Make functions easier to override in cc.h. The following is sufficient now (no more LWIP_PLATFORM_BYTESWAP):
#define lwip_htons(x) <your_htons>
#define lwip_htonl(x) <your_htonl>
2016-10-06 12:55:57 +02:00
Dirk Ziegelmeier
d7f8d33506
Minor: update NO_SYS_SampleCode.c for IPv6
2016-09-30 09:35:27 +02:00
Dirk Ziegelmeier
db9c866fff
Minor: Documentation update
2016-09-30 09:05:33 +02:00
Dirk Ziegelmeier
682b82aad8
Improve documentation: Some words about multiple execution contexts in lwIP
2016-09-29 12:51:45 +02:00