Messages in this thread | | | Date | Tue, 27 Jun 2006 21:22:51 +0200 | From | Lukas Jelinek <> | Subject | Kernel API Reference Documentation |
| |
Hello,
a few months ago I looked for something like "Linux Kernel API Reference Documentation". This search was unsuccessful and somebody recommended me to generate this documentation from the kernel headers.
I have used Doxygen for this work. But the headers have needed to be preprocessed by 'sed' using some regexp rules (due to various incompatible comment formats).
Now I decide to share the result worldwide. The current generated "Kernel API Reference" can be found at http://www.kernel-api.org. Although it is very buggy this time I think it may be useful for module developers.
To allow this work to be better, I suggest to establish some rules for writing code comments (especially for function prototypes, data structures etc.) and to add the comments to the kernel headers. The rules should be chosen carefully to be well accepted by various documentation generators (at least by Doxygen).
Thank you for your time dedicated to this idea.
Regards
Lukas Jelinek
- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |