From 5f607db66220330adf2ea520aa6142d765618576 Mon Sep 17 00:00:00 2001 From: Randy Dunlap Date: Wed, 11 Feb 2009 13:04:31 -0800 Subject: [PATCH] --- yaml --- r: 131287 b: refs/heads/master c: f40b45a2e45b0f02aeedfcfbb28d8e2d4b8b86b1 h: refs/heads/master i: 131285: 8aa6fd273d8c31258b6956f0e5ae8ea3864b8d88 131283: 19b905b23fbafb2356a7a76a4e949e48555816e9 131279: 0a9953c7d37992c6410752930e43348046f18b50 v: v3 --- [refs] | 2 +- trunk/Documentation/kernel-doc-nano-HOWTO.txt | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/[refs] b/[refs] index 3aab1bd3a01a..4e3d7e1d902c 100644 --- a/[refs] +++ b/[refs] @@ -1,2 +1,2 @@ --- -refs/heads/master: 2e9c23724328ae4e56c42a35a717a956d7d3001d +refs/heads/master: f40b45a2e45b0f02aeedfcfbb28d8e2d4b8b86b1 diff --git a/trunk/Documentation/kernel-doc-nano-HOWTO.txt b/trunk/Documentation/kernel-doc-nano-HOWTO.txt index d73fbd2b2b45..026ec7d57384 100644 --- a/trunk/Documentation/kernel-doc-nano-HOWTO.txt +++ b/trunk/Documentation/kernel-doc-nano-HOWTO.txt @@ -43,7 +43,8 @@ Only comments so marked will be considered by the kernel-doc scripts, and any comment so marked must be in kernel-doc format. Do not use "/**" to be begin a comment block unless the comment block contains kernel-doc formatted comments. The closing comment marker for -kernel-doc comments can be either "*/" or "**/". +kernel-doc comments can be either "*/" or "**/", but "*/" is +preferred in the Linux kernel tree. Kernel-doc comments should be placed just before the function or data structure being described. @@ -63,7 +64,7 @@ Example kernel-doc function comment: * comment lines. * * The longer description can have multiple paragraphs. - **/ + */ The first line, with the short description, must be on a single line. @@ -85,7 +86,7 @@ Example kernel-doc data structure comment. * perhaps with more lines and words. * * Longer description of this structure. - **/ + */ The kernel-doc function comments describe each parameter to the function, in order, with the @name lines.