Dirk Ziegelmeier
aa04944ae0
Add DHCPv6 to documentation
2018-02-23 12:35:45 +01:00
Dirk Ziegelmeier
47c55c3d96
Improve documentation for 6LOWPAN and SLIPIF
2018-02-18 17:49:54 +01:00
goldsimon
c6b5527710
Improve LWIP_ASSERT_CORE_LOCKED documentation a bit
2018-02-04 13:20:55 +01:00
goldsimon
0e85582bc0
tcp: introduce ext_args per pcb
...
This introduces the concept of ext (external/extended) arguments per
tcp_pcb (also for listening pcbs) to store more data than just one
"void *arg" per pcb. The "arg" is for use to applications, whereas
the ext_args may be used by frameworks and leave "arg" untouched.
In addition to a void pointer, callbacks are added to help frameworks
migrate arguments from listen pcb to connection pcb and to free args
when the pcb is freed.
Signed-off-by: goldsimon <goldsimon@gmx.de>
2018-02-01 09:19:16 +01:00
Dirk Ziegelmeier
72fc4a6ca5
Documentation - "Common pitfalls": Add some words about buffer alignment
2018-01-16 10:59:42 +01:00
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
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
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
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
d9b279d150
Cleanup documentation a bit: rename "Addons" to "NETIFs" - its a more appropriate name
2017-03-15 20:03:55 +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
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
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
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
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
Dirk Ziegelmeier
5d811d799c
Minor: Documentation updates
2016-09-27 21:18:03 +02:00
Dirk Ziegelmeier
0d510dd66d
Add API macros for netif client data handling and update documentation accordingly
2016-08-26 11:21:49 +02:00
Dirk Ziegelmeier
d9eaf6f310
docs: Remove link to example ports again, this should rather go to lwIP wiki...
2016-08-23 09:34:44 +02:00
Dirk Ziegelmeier
21c99b6ebb
Add documentation page about example lwIP ports. Start with FreeRTOS from Pavel Pisa.
2016-08-20 09:23:29 +02:00
Dirk Ziegelmeier
7c0d952379
Add explicit documentation page about reporting bugs
2016-08-18 21:09:34 +02:00
Dirk Ziegelmeier
0c7a59b5db
Minor: Documentation fixes
2016-08-18 11:06:50 +02:00
Dirk Ziegelmeier
c9ad58308a
Minor documentation fixes
2016-08-18 10:59:18 +02:00
Dirk Ziegelmeier
306113c8c3
Add MDNS to doxygen docs
2016-08-14 15:22:05 +02:00
Dirk Ziegelmeier
13251526fa
Strip path prefix in doxygen docs - no /home/dziegel/ in the future :-)
2016-08-11 21:25:28 +02:00
Dirk Ziegelmeier
6ba03d543f
Activate TCP backlog in documentation
2016-08-09 08:18:42 +02:00
Dirk Ziegelmeier
898e69118a
Minor: documentation fix
2016-08-07 20:21:27 +02:00
Dirk Ziegelmeier
f55c0e7864
Move rawapi.txt description to main page - this doc really should be found and read by users
2016-08-07 20:21:27 +02:00
Dirk Ziegelmeier
8d07629b71
Some documentation cleanups and include more comments that have been already in code into doxygen docs
2016-08-07 10:05:34 +02:00
Dirk Ziegelmeier
4c06a737a4
Add redirection page for HTML doxygen output so one does not have to search for index.html in the huge output/html directory
2016-08-03 12:34:17 +02:00
Dirk Ziegelmeier
e4d75a75ea
Remove accidentally committed file
2016-07-31 20:01:33 +02:00
Dirk Ziegelmeier
e76b8b2551
Document SNMP MIB2 netif stats counters
2016-07-31 16:02:22 +02:00
Dirk Ziegelmeier
6cc7f38c99
Fix typo in lwip.Doxyfile
2016-07-30 11:08:05 +02:00
Dirk Ziegelmeier
90fba8773f
Revert "Fix my messing of opt.h and the other options files - it was actually caused by a cyclic #include which I did not see"
...
It still does not work, due to #undef of options in opt.h, the documentation of many files is incomplete
This reverts commit 3f0dae29e9
2016-07-28 23:34:16 +02:00
Dirk Ziegelmeier
3f0dae29e9
Fix my messing of opt.h and the other options files - it was actually caused by a cyclic #include which I did not see
...
Read the comments inside opt.h if you are interested.
2016-07-28 18:59:36 +02:00
Dirk Ziegelmeier
8c620d9206
Restructure IPv6 config options
...
Add generate.bat to generate docs quickly under Windows OS
2016-07-28 09:21:16 +02:00
Dirk Ziegelmeier
b0284a6927
Move definition of options group from main_page.h to opt.h - it's more consistent like that
2016-07-28 08:27:49 +02:00
