marex at denx.de
Fri Sep 28 21:48:00 CEST 2012
Dear Marek Vasut,
> 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
> See  in Linux kernel tree for what I mean.
>  Documentation/kernel-doc-nano-HOWTO.txt
So I've been hacking on it for a bit, see the first stab at . As for the
ruleset, I propose this addition for the Wiki :
U-Boot code documentation
U-Boot adopted the kernel-doc annotation style, this is the only exception from
multi-line comment rule of Coding Style. While not mandatory, adding
documentation is strongly advised. The Linux kernel kernel-doc document 
appliest with no changes.
More information about the U-Boot