[U-Boot] KernelDoc

Marek Vasut
2012-09-25T20:46:10Z

Hi all!

I've had a discussion with Wolfgang just now about U-Boot coding style. I tried
using KernelDoc in a patch, which is not part of the U-Boot Coding Style now,
thus it was rejected.

I really like the idea of annotating functions with proper description, thus I
would like to ask, can we reach a general agreement and start using kerneldoc in
U-Boot to annotate functions and possibly generate documentation? Or shall we
use anything else?

Or any other annotation stuff? Doxygen style? Shall it be optional or mandatory?

See [1] in Linux kernel tree for what I mean.

[1] Documentation/kernel-doc-nano-HOWTO.txt

Best regards,
Marek Vasut