diff options
| author | Jeff Garzik <jgarzik@pobox.com> | 2005-09-14 08:01:25 -0400 |
|---|---|---|
| committer | Jeff Garzik <jgarzik@pobox.com> | 2005-09-14 08:01:25 -0400 |
| commit | d7f6884ae0ae6e406ec3500fcde16e8f51642460 (patch) | |
| tree | efceb246a4fa12921b7dbd3946a88fa257684405 /Documentation/CodingStyle | |
| parent | cd28ab6a4e50a7601d22752aa7ce0c8197b10bdf (diff) | |
| parent | 2f4ba45a75d6383b4a1201169a808ffea416ffa0 (diff) | |
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 |