Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e776eba0 authored by Pekka J Enberg's avatar Pekka J Enberg Committed by Linus Torvalds
Browse files

[PATCH] Add kerneldoc reference to CodingStyle 



Signed-off-by: default avatarPekka Enberg <penberg@cs.helsinki.fi>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent c05e0664

Documentation/CodingStyle

+3 −0
Original line number Diff line number Diff line
@@ -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