]> www.infradead.org Git - users/jedix/linux-maple.git/commit
kernel-doc: allow object-like macros in ReST output
authorRandy Dunlap <rdunlap@infradead.org>
Tue, 15 Oct 2024 18:11:07 +0000 (11:11 -0700)
committerJonathan Corbet <corbet@lwn.net>
Thu, 17 Oct 2024 15:33:29 +0000 (09:33 -0600)
commitbb8fd09e2811e2386bb40b9f0d3c7dd6e7961a1e
tree94308b147bd561337725c1e47d98d693fc2a5b4a
parent878b56e011af224386464c79e3b1b1a73342d847
kernel-doc: allow object-like macros in ReST output

output_function_rst() does not handle object-like macros. It presents
a trailing "()" while output_function_man() handles these macros
correctly.

Update output_function_rst() to handle object-like macros.
Don't show the "Parameters" heading if there are no parameters.

For output_function_man(), don't show the "ARGUMENTS" heading if there
are no parameters.

I have tested this quite a bit with my ad hoc test files for both ReST
and man format outputs. The generated output looks good.

Fixes: cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Horia Geanta <horia.geanta@freescale.com>
Tested-by: Vlastimil Babka <vbabka@suse.cz>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241015181107.536894-1-rdunlap@infradead.org
scripts/kernel-doc