From: Pekka J Enberg Signed-off-by: Pekka Enberg Signed-off-by: Andrew Morton --- Documentation/CodingStyle | 3 +++ 1 files changed, 3 insertions(+) diff -puN Documentation/CodingStyle~add-kerneldoc-reference-to-codingstyle Documentation/CodingStyle --- devel/Documentation/CodingStyle~add-kerneldoc-reference-to-codingstyle 2005-07-11 23:27:45.000000000 -0700 +++ devel-akpm/Documentation/CodingStyle 2005-07-11 23:27:45.000000000 -0700 @@ -236,6 +236,9 @@ ugly), but try to avoid excess. Instead of the function, telling people what it does, and possibly WHY it does it. +When commenting the kernel API functions, please use the kerneldoc format. +See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc +for details. Chapter 8: You've made a mess of it _