浏览代码

[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 20 年之前
父节点
当前提交
e776eba0fe
共有 1 个文件被更改,包括 3 次插入0 次删除
  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