Re: Kernel API Reference Documentation

From: Petr Tesarik
Date: Wed Jun 28 2006 - 07:45:38 EST


On Tue, 2006-06-27 at 21:22 +0200, Lukas Jelinek wrote:
> 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.

I looked at
http://www.kernel-api.org/docs/online/2.6.17/da/dab/structsk__buff.html

and you apparently ignore kernel-doc for structs. Cf.
include/linux/skbuff.h:177 ff.

Regards,
Petr Tesarik

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/