Commit 891dcd2f authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds

[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: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 3de3af13
...@@ -101,7 +101,7 @@ The format of the block comment is like this: ...@@ -101,7 +101,7 @@ The format of the block comment is like this:
/** /**
* function_name(:)? (- short description)? * function_name(:)? (- short description)?
(* @parameterx: (description of parameter x)?)* (* @parameterx(space)*: (description of parameter x)?)*
(* a blank line)? (* a blank line)?
* (Description:)? (Description of function)? * (Description:)? (Description of function)?
* (section header: (section description)? )* * (section header: (section description)? )*
......
...@@ -83,7 +83,7 @@ use strict; ...@@ -83,7 +83,7 @@ use strict;
# * my_function # * my_function
# **/ # **/
# #
# If the Description: header tag is ommitted, then there must be a blank line # If the Description: header tag is omitted, then there must be a blank line
# after the last parameter specification. # after the last parameter specification.
# e.g. # e.g.
# /** # /**
...@@ -265,7 +265,7 @@ my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. ...@@ -265,7 +265,7 @@ my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
my $doc_end = '\*/'; my $doc_end = '\*/';
my $doc_com = '\s*\*\s*'; my $doc_com = '\s*\*\s*';
my $doc_decl = $doc_com.'(\w+)'; my $doc_decl = $doc_com.'(\w+)';
my $doc_sect = $doc_com.'(['.$doc_special.']?[\w ]+):(.*)'; my $doc_sect = $doc_com.'(['.$doc_special.']?[\w\s]+):(.*)';
my $doc_content = $doc_com.'(.*)'; my $doc_content = $doc_com.'(.*)';
my $doc_block = $doc_com.'DOC:\s*(.*)?'; my $doc_block = $doc_com.'DOC:\s*(.*)?';
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment