diff options
| author | Greg KH <gregkh@suse.de> | 2005-09-12 12:45:04 -0700 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@suse.de> | 2005-09-12 12:45:04 -0700 |
| commit | d58dde0f552a5c5c4485b962d8b6e9dd54fefb30 (patch) | |
| tree | d9a7e35eb88fea6265d5aadcc3d4ed39122b052a /Documentation/CodingStyle | |
| parent | 877599fdef5ea4a7dd1956e22fa9d6923add97f8 (diff) | |
| parent | 2ade81473636b33aaac64495f89a7dc572c529f0 (diff) | |
Merge ../torvalds-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 f25b3953f51..22e5f9036f3 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 |