
Dear Wolfgang Denk,
Dear Marek Vasut,
In message 201210011107.45164.marex@denx.de you wrote:
Agreed, not the whole file. But, can you check the rules I tried to outline?
Is there a summary somewhere? Something we could add to the wiki?
I sent this on friday:
So I've been hacking on it for a bit, see the first stab at [1]. As for the ruleset, I propose this addition for the Wiki [2]:
-->8--
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 [3] appliest with no changes.
--8<--
[1] http://twilight.ponies.cz/kerneldoc/ [2] http://www.denx.de/wiki/U-Boot/CodingStyle [3] http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Do... doc-nano-HOWTO.txt
Best regards,
Wolfgang Denk
Best regards, Marek Vasut