diff options
Diffstat (limited to 'Documentation/kernel-doc-nano-HOWTO.txt')
-rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index d73fbd2b2b45..026ec7d57384 100644 --- a/Documentation/kernel-doc-nano-HOWTO.txt +++ b/Documentation/kernel-doc-nano-HOWTO.txt | |||
@@ -43,7 +43,8 @@ Only comments so marked will be considered by the kernel-doc scripts, | |||
43 | and any comment so marked must be in kernel-doc format. Do not use | 43 | and any comment so marked must be in kernel-doc format. Do not use |
44 | "/**" to be begin a comment block unless the comment block contains | 44 | "/**" to be begin a comment block unless the comment block contains |
45 | kernel-doc formatted comments. The closing comment marker for | 45 | kernel-doc formatted comments. The closing comment marker for |
46 | kernel-doc comments can be either "*/" or "**/". | 46 | kernel-doc comments can be either "*/" or "**/", but "*/" is |
47 | preferred in the Linux kernel tree. | ||
47 | 48 | ||
48 | Kernel-doc comments should be placed just before the function | 49 | Kernel-doc comments should be placed just before the function |
49 | or data structure being described. | 50 | or data structure being described. |
@@ -63,7 +64,7 @@ Example kernel-doc function comment: | |||
63 | * comment lines. | 64 | * comment lines. |
64 | * | 65 | * |
65 | * The longer description can have multiple paragraphs. | 66 | * The longer description can have multiple paragraphs. |
66 | **/ | 67 | */ |
67 | 68 | ||
68 | The first line, with the short description, must be on a single line. | 69 | The first line, with the short description, must be on a single line. |
69 | 70 | ||
@@ -85,7 +86,7 @@ Example kernel-doc data structure comment. | |||
85 | * perhaps with more lines and words. | 86 | * perhaps with more lines and words. |
86 | * | 87 | * |
87 | * Longer description of this structure. | 88 | * Longer description of this structure. |
88 | **/ | 89 | */ |
89 | 90 | ||
90 | The kernel-doc function comments describe each parameter to the | 91 | The kernel-doc function comments describe each parameter to the |
91 | function, in order, with the @name lines. | 92 | function, in order, with the @name lines. |