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: final dump_function() cleanups

Browse Source 
Add some more comments to dump_function(), add some comments, and trim out
an unneeded duplicate output_declaration() call.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Jonathan Corbet
2025-09-08 16:21:28 -06:00
parent 370f430527
commit 3dff54410e
1 changed files with 13 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -999,32 +999,28 @@ class KernelDoc:
declaration_name)
found = True
break
#
# Parsing done; make sure that things are as we expect.
#
if not found:
self.emit_msg(ln,
f"cannot understand function prototype: '{prototype}'")
return
if self.entry.identifier != declaration_name:
self.emit_msg(ln,
f"expecting prototype for {self.entry.identifier}(). Prototype was for {declaration_name}() instead")
self.emit_msg(ln, f"expecting prototype for {self.entry.identifier}(). "
f"Prototype was for {declaration_name}() instead")
return
self.check_sections(ln, declaration_name, "function")
self.check_return_section(ln, declaration_name, return_type)
#
# Store the result.
#
self.output_declaration(decl_type, declaration_name,
typedef=('typedef' in return_type),
functiontype=return_type,
purpose=self.entry.declaration_purpose,
func_macro=func_macro)
if 'typedef' in return_type:
self.output_declaration(decl_type, declaration_name,
typedef=True,
functiontype=return_type,
purpose=self.entry.declaration_purpose,
func_macro=func_macro)
else:
self.output_declaration(decl_type, declaration_name,
typedef=False,
functiontype=return_type,
purpose=self.entry.declaration_purpose,
func_macro=func_macro)
def dump_typedef(self, ln, proto):
"""