Re: [PATCH] Add kerneldoc reference to CodingStyle

[randy_dunlap <rdunlap@xenotime.net>]

On Mon, 11 Jul 2005 09:32:00 +0300 (EEST) Pekka J Enberg wrote:

| Signed-off-by: Pekka Enberg <penberg@cs.helsinki.fi>
| ---
| 
|  CodingStyle |    3 +++
|  1 files changed, 3 insertions(+)
| 
| Index: 2.6/Documentation/CodingStyle
| ===================================================================
| --- 2.6.orig/Documentation/CodingStyle
| +++ 2.6/Documentation/CodingStyle
| @@ -236,6 +236,9 @@ ugly), but try to avoid excess.  Instead
|  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 file scripts/kernel-doc for details.
   See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
   for details.
| +
|  
|  		Chapter 8: You've made a mess of it
|  
| -


---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/