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 <[email protected]>
niw · Jun 9, 2016 · 8569de6 · 8569de6
1 parent c9de4a8
commit 8569de6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
@@ -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*$';