diff options
| author | Randy Dunlap <randy.dunlap@oracle.com> | 2007-02-10 12:45:53 +0300 |
|---|---|---|
| committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-02-11 21:51:32 +0300 |
| commit | 891dcd2f7ab15e2aaad07f6925b3a53fd8d5c02f (patch) | |
| tree | 643fea439770f91b3b0246bd304c6883761b591c /Documentation | |
| parent | 3de3af130b75a79c7381573e5ea69cb59502023f (diff) | |
| download | linux-891dcd2f7ab15e2aaad07f6925b3a53fd8d5c02f.tar.xz | |
[PATCH] kernel-doc: allow a little whitespace
In kernel-doc syntax, be a little flexible: allow whitespace between
a function parameter name and the colon that must follow it, such as:
@pdev : PCI device to unplug
(This allows lots of megaraid kernel-doc to work without tons of
editing.)
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index 284e7e198e93..6ca507f40749 100644 --- a/Documentation/kernel-doc-nano-HOWTO.txt +++ b/Documentation/kernel-doc-nano-HOWTO.txt @@ -101,7 +101,7 @@ The format of the block comment is like this: /** * function_name(:)? (- short description)? -(* @parameterx: (description of parameter x)?)* +(* @parameterx(space)*: (description of parameter x)?)* (* a blank line)? * (Description:)? (Description of function)? * (section header: (section description)? )* |