diff options
| author | Pekka J Enberg <penberg@cs.Helsinki.FI> | 2005-09-10 00:26:44 -0700 |
|---|---|---|
| committer | Linus Torvalds <torvalds@g5.osdl.org> | 2005-09-10 10:06:28 -0700 |
| commit | e776eba0feaea9a3eba7aff73f50701b9804b57f (patch) | |
| tree | 383288122ca4d86ca61c0cc9752b7575bc3b63da /Documentation/CodingStyle | |
| parent | c05e0664e1d080344d6ce346de43e51895541e21 (diff) | |
| download | linux-stable-e776eba0feaea9a3eba7aff73f50701b9804b57f.tar.gz linux-stable-e776eba0feaea9a3eba7aff73f50701b9804b57f.tar.bz2 linux-stable-e776eba0feaea9a3eba7aff73f50701b9804b57f.zip | |
[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>
Diffstat (limited to 'Documentation/CodingStyle')
| -rw-r--r-- | Documentation/CodingStyle | 3 |
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 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 |