Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8569de68 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

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: default avatarJonathan Corbet <corbet@lwn.net>
parent c9de4a82

scripts/kernel-doc

+2 −1
Original line number Diff line number Diff line
@@ -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*$';