raspi/linux
1
0
Fork 1
mirror of https://github.com/raspberrypi/linux.git synced 2025-12-07 02:19:54 +00:00
Code Issues Projects Releases Wiki Activity

docs: kdoc: coalesce the end-of-comment processing

Browse Source 
Separate out the end-of-comment logic into its own helper and remove the
duplicated code introduced earlier.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250621203512.223189-8-corbet@lwn.net
This commit is contained in:
Jonathan Corbet
2025-06-21 14:35:10 -06:00
parent e65d54e191
commit 2ad02b9491
1 changed files with 14 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
scripts/lib/kdoc/kdoc_parser.py
View File

@@ -1351,13 +1351,10 @@ class KernelDoc:
return True
return False
def process_decl(self, ln, line):
"""
STATE_DECLARATION: We've seen the beginning of a declaration
"""
if self.is_new_section(ln, line):
return
#
# Helper function to detect (and effect) the end of a kerneldoc comment.
#
def is_comment_end(self, ln, line):
if doc_end.search(line):
self.dump_section()
@@ -1370,6 +1367,15 @@ class KernelDoc:
self.entry.new_start_line = ln + 1
self.state = state.PROTO
return True
return False
def process_decl(self, ln, line):
"""
STATE_DECLARATION: We've seen the beginning of a declaration
"""
if self.is_new_section(ln, line) or self.is_comment_end(ln, line):
return
if doc_content.search(line):
@@ -1406,21 +1412,7 @@ class KernelDoc:
"""
STATE_BODY: the bulk of a kerneldoc comment.
"""
if self.is_new_section(ln, line):
return
if doc_end.search(line):
self.dump_section()
# Look for doc_com + <text> + doc_end:
r = KernRe(r'\s*\*\s*[a-zA-Z_0-9:\.]+\*/')
if r.match(line):
self.emit_msg(ln, f"suspicious ending line: {line}")
self.entry.prototype = ""
self.entry.new_start_line = ln + 1
self.state = state.PROTO
if self.is_new_section(ln, line) or self.is_comment_end(ln, line):
return
if doc_content.search(line):