Dirk Ziegelmeier
1cf9fc0d39
Update doxygen version to 2.0.3 as in init.h
...
(cherry picked from commit 59fba75cd8
2017-09-14 09:16:18 +02:00
Dirk Ziegelmeier
0b299f96e9
Add CHANGELOG to lwIP HTML documentation
...
(cherry picked from commit ee3154999a
2017-02-27 12:18:26 +01:00
Dirk Ziegelmeier
0a73e0ff30
Set lwIP version to 2.0.2 in doxygen script
...
(cherry picked from commit 861dab5b22
2017-02-27 12:16:15 +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
Dirk Ziegelmeier
1bb2539f74
Make options documentation a child of lwIP section
2016-07-27 20:49:19 +02:00
Dirk Ziegelmeier
0e6f2049ad
Minor main_page.h cosmetics
2016-07-27 20:34:23 +02:00
Dirk Ziegelmeier
fb7998699d
Minor doxygen options fix
2016-07-27 20:34:23 +02:00
Dirk Ziegelmeier
63fdb3bb62
Document opt.h - due to a bad bug in doxygen, I had to litter the whole file with "|| __DOXYGEN__" to make it work :-(
...
Doxygen does not handle #ifndef foo #define foo #endif properly. It does not see the #define foo inside.
If someone has objections or a fix for it, please tell me.
2016-07-27 20:34:23 +02:00
Dirk Ziegelmeier
31f941e172
More documentation updates
2016-07-27 20:34:23 +02:00
Dirk Ziegelmeier
0cb1d1144d
Integrate README file into doxygen docs instead of duplicating its content in main_page.h
2016-07-27 19:09:52 +02:00
Dirk Ziegelmeier
fc7aa7a247
Move content from contrib.h and upgrading.h to main_page.h
2016-07-27 13:07:29 +02:00
Dirk Ziegelmeier
6618189342
Add UPGRADING document to doxygen docs
2016-07-27 08:21:54 +02:00
Dirk Ziegelmeier
6b524367a3
Documentation review with Simon, minor changes
2016-07-27 08:05:38 +02:00
Dirk Ziegelmeier
7e4d934f7a
Docs: generate search index
2016-07-26 23:14:38 +02:00
Dirk Ziegelmeier
7b770dd9b6
Document 6LoWPAN and SLIP netif
2016-07-26 20:10:17 +02:00
Dirk Ziegelmeier
7f43fcab71
Document system abstraction layer in doxygen module style
2016-07-26 20:03:04 +02:00
Dirk Ziegelmeier
c6831648e2
Document apps in doxygen module style, create more top-level categories to structure documentation
2016-07-26 19:30:05 +02:00
Dirk Ziegelmeier
8a9de94b1f
Restructure documentation. Create two top-level sections for thread-safe and callback-style APIs.
2016-07-26 18:39:53 +02:00
Dirk Ziegelmeier
8643782e5d
Document netif and lwIP in doxygen module style
2016-07-26 16:53:27 +02:00
Dirk Ziegelmeier
bd79f6c055
Document DNS, memory pools and PBUFs as modules
2016-07-26 16:40:13 +02:00
Dirk Ziegelmeier
59295be4ef
Some more RAW API documentation updates
...
Improve structure of documentation: PPP is now a module, too
2016-07-26 13:53:59 +02:00
Dirk Ziegelmeier
d75ece2505
Add some of the .txt files in /doc subdir to doxygen documentation
2016-07-25 08:16:39 +02:00
Dirk Ziegelmeier
299a19e135
Add travis-ci Continous integration to docs
2016-07-20 20:06:45 +02:00
Dirk Ziegelmeier
cb99ca099e
docs: RTF manual does not look good, deactivate it in lwip.Doxyfile
2016-07-19 08:27:09 +02:00
