diff options
Diffstat (limited to 'Documentation')
-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 | |||
236 | of the function, telling people what it does, and possibly WHY it does | 236 | of the function, telling people what it does, and possibly WHY it does |
237 | it. | 237 | it. |
238 | 238 | ||
239 | When commenting the kernel API functions, please use the kerneldoc format. | ||
240 | See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc | ||
241 | for details. | ||
239 | 242 | ||
240 | Chapter 8: You've made a mess of it | 243 | Chapter 8: You've made a mess of it |
241 | 244 | ||