docs: kernel-doc: Add "example" and "note" to the magic section types
authorJonathan Corbet <corbet@lwn.net>
Thu, 9 Jun 2016 19:35:05 +0000 (13:35 -0600)
committerJonathan Corbet <corbet@lwn.net>
Thu, 9 Jun 2016 19:35:05 +0000 (13:35 -0600)
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>
scripts/kernel-doc

index 5192213c5005ae073766ee6f972769e040824148..27757c21551aecf804aa95ccd56434c9a33c3832 100755 (executable)
@@ -406,7 +406,8 @@ my $doc_com = '\s*\*\s*';
 my $doc_com_body = '\s*\* ?';
 my $doc_decl = $doc_com . '(\w+)';
 # @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_block = $doc_com . 'DOC:\s*(.*)?';
 my $doc_inline_start = '^\s*/\*\*\s*$';