Skip to content

Commit

Permalink
---
Browse files Browse the repository at this point in the history
yaml
---
r: 131287
b: refs/heads/master
c: f40b45a
h: refs/heads/master
i:
  131285: 8aa6fd2
  131283: 19b905b
  131279: 0a9953c
v: v3
  • Loading branch information
Randy Dunlap authored and Linus Torvalds committed Feb 11, 2009
1 parent ed47161 commit 5f607db
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion [refs]
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
---
refs/heads/master: 2e9c23724328ae4e56c42a35a717a956d7d3001d
refs/heads/master: f40b45a2e45b0f02aeedfcfbb28d8e2d4b8b86b1
7 changes: 4 additions & 3 deletions trunk/Documentation/kernel-doc-nano-HOWTO.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

Expand All @@ -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.
Expand Down

0 comments on commit 5f607db

Please sign in to comment.