Browse Source

[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>
Pekka J Enberg 19 years ago
parent
commit
e776eba0fe
1 changed files with 3 additions and 0 deletions
  1. 3 0
      Documentation/CodingStyle

+ 3 - 0
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
 of the function, telling people what it does, and possibly WHY it does
 it.
 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
 		Chapter 8: You've made a mess of it