diff options
author | Jonathan Corbet <corbet@lwn.net> | 2025-07-02 13:05:56 -0600 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2025-07-15 13:43:16 -0600 |
commit | de6f7ac91a08d723a6eaa9c5bbce30c5a126c861 (patch) | |
tree | dfc29196cbd44df8ad1bca8df4ea6260deae9a5c /scripts/lib/kdoc/kdoc_item.py | |
parent | efacdf85135ae02a8c25452e40547b773bb1b6b3 (diff) |
docs: kdoc: Coalesce parameter-list handling
Callers to output_declaration() always pass the parameter information from
self.entry; remove all of the boilerplate arguments and just get at that
information directly. Formalize its placement in the KdocItem class.
It would be nice to get rid of parameterlist as well, but that has the
effect of reordering the output of function parameters and struct fields to
match the order in the kerneldoc comment rather than in the declaration.
One could argue about which is more correct, but the ordering has been left
unchanged for now.
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/lib/kdoc/kdoc_item.py')
-rw-r--r-- | scripts/lib/kdoc/kdoc_item.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/scripts/lib/kdoc/kdoc_item.py b/scripts/lib/kdoc/kdoc_item.py index f0b2b9082c56d..ccabb448b5d4d 100644 --- a/scripts/lib/kdoc/kdoc_item.py +++ b/scripts/lib/kdoc/kdoc_item.py @@ -11,6 +11,10 @@ class KdocItem: self.declaration_start_line = start_line self.sections = {} self.sections_start_lines = {} + self.parameterlist = [] + self.parameterdesc_start_lines = [] + self.parameterdescs = {} + self.parametertypes = {} # # Just save everything else into our own dict so that the output # side can grab it directly as before. As we move things into more @@ -28,8 +32,14 @@ class KdocItem: return self.get(key) # - # Tracking of section information. + # Tracking of section and parameter information. # def set_sections(self, sections, start_lines): self.sections = sections self.section_start_lines = start_lines + + def set_params(self, names, descs, types, starts): + self.parameterlist = names + self.parameterdescs = descs + self.parametertypes = types + self.parameterdesc_start_lines = starts |