diff options
author | Jonathan Corbet <corbet@lwn.net> | 2016-06-09 15:35:05 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-06-09 15:35:05 -0400 |
commit | 8569de68e79e94cce6709831edd94accb6942ade (patch) | |
tree | e6dd9a4b5a2e5356674c969183a597cf77de7edb | |
parent | c9de4a82c852d621975f5978157f689e0550a48e (diff) |
docs: kernel-doc: Add "example" and "note" to the magic section types
Lots of kerneldoc entries use "example:" or "note:" as section headers.
Until such a time as we can make them use proper markup, make them work as
intended.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rwxr-xr-x | scripts/kernel-doc | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 5192213c5005..27757c21551a 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc | |||
@@ -406,7 +406,8 @@ my $doc_com = '\s*\*\s*'; | |||
406 | my $doc_com_body = '\s*\* ?'; | 406 | my $doc_com_body = '\s*\* ?'; |
407 | my $doc_decl = $doc_com . '(\w+)'; | 407 | my $doc_decl = $doc_com . '(\w+)'; |
408 | # @params and a strictly limited set of supported section names | 408 | # @params and a strictly limited set of supported section names |
409 | my $doc_sect = $doc_com . '\s*(\@\w+|description|context|returns?)\s*:(.*)'; | 409 | my $doc_sect = $doc_com . |
410 | '\s*(\@\w+|description|context|returns?|notes?|examples?)\s*:(.*)'; | ||
410 | my $doc_content = $doc_com_body . '(.*)'; | 411 | my $doc_content = $doc_com_body . '(.*)'; |
411 | my $doc_block = $doc_com . 'DOC:\s*(.*)?'; | 412 | my $doc_block = $doc_com . 'DOC:\s*(.*)?'; |
412 | my $doc_inline_start = '^\s*/\*\*\s*$'; | 413 | my $doc_inline_start = '^\s*/\*\*\s*$'; |