From: Jonathan Corbet <corbet@lwn.net>
Date: Thu, 9 Jun 2016 19:35:05 +0000 (-0600)
Subject: docs: kernel-doc: Add "example" and "note" to the magic section types
X-Git-Tag: v4.8-rc1~3^2~35
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8569de68e79e94cce6709831edd94accb6942ade;p=platform%2Fkernel%2Flinux-exynos.git

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>
---

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 5192213..27757c21 100755
--- 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*$';