From: Pekka J Enberg <penberg@cs.Helsinki.FI>
Date: Sat, 10 Sep 2005 07:26:44 +0000 (-0700)
Subject: [PATCH] Add kerneldoc reference to CodingStyle
X-Git-Tag: v2.6.14-rc1~194
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e776eba0feaea9a3eba7aff73f50701b9804b57f;p=linux-2.6

[PATCH] Add kerneldoc reference to CodingStyle

Signed-off-by: Pekka Enberg <penberg@cs.helsinki.fi>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
---

diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index f25b3953f5..22e5f9036f 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -236,6 +236,9 @@ ugly), but try to avoid excess.  Instead, put the comments at the head
 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