From e776eba0feaea9a3eba7aff73f50701b9804b57f Mon Sep 17 00:00:00 2001 From: Pekka J Enberg Date: Sat, 10 Sep 2005 00:26:44 -0700 Subject: [PATCH] Add kerneldoc reference to CodingStyle Signed-off-by: Pekka Enberg Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/CodingStyle | 3 +++ 1 file changed, 3 insertions(+) (limited to 'Documentation/CodingStyle') 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 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 -- cgit v1.2.3