[lwip-users] doxygen documentation

[chrysn]

hey,

as the lwip doxygen documentation online[1] is quite outdated (from
2008, 1.3.0), i tried to build it locally. 

with the default settings (`doxygen -g`, INPUT = src, RECURSIVE = YES) i
do get results, but they are not as nice as what was generated at [1],
and lack large parts of documentation (probably due to #ifdef'd sections
without the appropriate PREDEFINED settings in Doxyfile).

* could we have the Doxyfile that created [1] checked into the source
  repository?

* an updated online documentation would be great, possibly in a new
  subdirctory reflecting the version, so we can have documentation for
  1.3.0 (seems to be widespread still?), 1.4.1 and development at the
  same time.

* the files in doc/ are not a prominent part of the lwip documentation
  as presented on the web, even though they are very helpful.

  since modern doxygen versions allow direct inclusion of markdwon files
  (which the docs almost are -- it's roughly plain text), the settings
  EXTENSION_MAPPING = txt=md and FILE_PATTERNS = ... *.txt would
  integrate these files. they should be linked from the README page
  which already is the main page of the 1.3.0 version; even if not, they
  show up under "Related Pages".

if there is support from the web master who'd manage the website itself,
i can offer to do some polishing on the markdown side of things.

best regards
chrysn

[1] http://www.nongnu.org/lwip/

-- 
To use raw power is to make yourself infinitely vulnerable to greater powers.
  -- Bene Gesserit axiom

signature.asc
Description: Digital signature