diff options
| author | Ingo Molnar <mingo@elte.hu> | 2009-02-13 12:05:57 (GMT) |
|---|---|---|
| committer | Ingo Molnar <mingo@elte.hu> | 2009-02-13 12:05:57 (GMT) |
| commit | d040c1614c24162adc3fe106b182596999264e26 (patch) | |
| tree | 5af02052e633bcde0e33f77cac52ab4685ad07f1 /Documentation/kernel-doc-nano-HOWTO.txt | |
| parent | d88316c243e5458a1888edbe0353c4dec6e61c73 (diff) | |
| parent | 7032e8696726354d6180d8a2d17191f958cd93ae (diff) | |
| download | linux-d040c1614c24162adc3fe106b182596999264e26.tar.xz | |
Merge branch 'x86/core' into x86/headers
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 d73fbd2..026ec7d 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, 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. |