diff options
| author | Jeff Garzik <jgarzik@pobox.com> | 2005-09-14 16:57:30 +0400 |
|---|---|---|
| committer | Jeff Garzik <jgarzik@pobox.com> | 2005-09-14 16:57:30 +0400 |
| commit | dbaa9a9d2b37d838125fb7f2b9fdc5dc5fa4eaa9 (patch) | |
| tree | 8641efeba632bddfa0e486b41a5f19578b1a1a31 /Documentation/CodingStyle | |
| parent | 142e27fc8a3619471669d6241784eec9167c47d1 (diff) | |
| parent | 2f4ba45a75d6383b4a1201169a808ffea416ffa0 (diff) | |
| download | linux-dbaa9a9d2b37d838125fb7f2b9fdc5dc5fa4eaa9.tar.xz | |
Merge /spare/repo/linux-2.6/
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 |