-------------------------------------------------- From: "m0n0" <ole@monochrom.net> Sent: Monday, August 23, 2010 4:00 PM To: "mint" <mint@lists.fishpool.fi> Subject: Re: [MiNT] Kernel documentation shortcomings
Of course we could write an converter, from wiki to man page... but maybe it would be better if a small script translates them to wiki content? That way we could keep the sources and at least syscall documentation together. Maybe there are other docs which should be left in the source tree,...
I think it's a bad idea to maintain the API docs in a wiki. The syscalls/API should be documented in the code itself, where the API is implemented, using a system like Doxygen (which is already used for the GEM bindings). Then export this to plain HTML and link to it from the wiki.
If you export it to the wiki, then suddenly people can start editing these docs in the wiki. Then the docs are out of sync, and the additions (perhaps valuable corrections) doesn't make it into the source but are lost during the next export to the wiki.
Jo Even