[PATCH] Add kerneldoc reference to CodingStyle

Signed-off-by: Pekka Enberg <[email protected]>
---

 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.
+
 
 		Chapter 8: You've made a mess of it
 
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

---

• Follow-Ups:
  • Re: [PATCH] Add kerneldoc reference to CodingStyle
    • From: randy_dunlap <[email protected]>

• Prev by Date: problem about Kconfig default value
• Next by Date: Re: share/private/slave a subtree - define vs enum
• Previous by thread: problem about Kconfig default value
• Next by thread: Re: [PATCH] Add kerneldoc reference to CodingStyle
• Index(es):
  • Date
  • Thread

[Index of Archives]     [Kernel Newbies]     [Netfilter]     [Bugtraq]     [Photo]     [Gimp]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Video 4 Linux]     [Linux for the blind]