aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPekka J Enberg <penberg@cs.Helsinki.FI>2005-09-10 03:26:44 -0400
committerLinus Torvalds <torvalds@g5.osdl.org>2005-09-10 13:06:28 -0400
commite776eba0feaea9a3eba7aff73f50701b9804b57f (patch)
tree383288122ca4d86ca61c0cc9752b7575bc3b63da
parentc05e0664e1d080344d6ce346de43e51895541e21 (diff)
[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>
-rw-r--r--Documentation/CodingStyle3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index f25b3953f513..22e5f9036f3c 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -236,6 +236,9 @@ ugly), but try to avoid excess. Instead, put the comments at the head
236of the function, telling people what it does, and possibly WHY it does 236of the function, telling people what it does, and possibly WHY it does
237it. 237it.
238 238
239When commenting the kernel API functions, please use the kerneldoc format.
240See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
241for details.
239 242
240 Chapter 8: You've made a mess of it 243 Chapter 8: You've made a mess of it
241 244