Browse Source

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>
Jonathan Corbet 9 years ago
parent
commit
8569de68e7
1 changed files with 2 additions and 1 deletions
  1. 2 1
      scripts/kernel-doc

+ 2 - 1
scripts/kernel-doc

@@ -406,7 +406,8 @@ my $doc_com = '\s*\*\s*';
 my $doc_com_body = '\s*\* ?';
 my $doc_com_body = '\s*\* ?';
 my $doc_decl = $doc_com . '(\w+)';
 my $doc_decl = $doc_com . '(\w+)';
 # @params and a strictly limited set of supported section names
 # @params and a strictly limited set of supported section names
-my $doc_sect = $doc_com . '\s*(\@\w+|description|context|returns?)\s*:(.*)';
+my $doc_sect = $doc_com . 
+    '\s*(\@\w+|description|context|returns?|notes?|examples?)\s*:(.*)';
 my $doc_content = $doc_com_body . '(.*)';
 my $doc_content = $doc_com_body . '(.*)';
 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
 my $doc_inline_start = '^\s*/\*\*\s*$';
 my $doc_inline_start = '^\s*/\*\*\s*$';