summaryrefslogtreecommitdiffstats
path: root/scripts/kernel-doc
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2017-01-02 16:22:25 +0100
committerJonathan Corbet <corbet@lwn.net>2017-01-04 15:07:53 -0700
commitfc6d7af89fa968c378d4437d7905ccd76efa6af4 (patch)
tree930842d087a149f5b913d9913e90e53aae267499 /scripts/kernel-doc
parentb1aaa546b52baf7cdc97961e9ba445a26948c1af (diff)
downloadlinux-stable-fc6d7af89fa968c378d4437d7905ccd76efa6af4.tar.gz
linux-stable-fc6d7af89fa968c378d4437d7905ccd76efa6af4.tar.bz2
linux-stable-fc6d7af89fa968c378d4437d7905ccd76efa6af4.zip
kernel-doc: include parameter type in docbook output
The restructuredText output includes both the parameter type and the name for functions and function-typed members. Do the same for docbook. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Acked-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-xscripts/kernel-doc6
1 files changed, 4 insertions, 2 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 99b4847f9bb2..5476cf4f4673 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1131,8 +1131,9 @@ sub output_function_xml(%) {
foreach $parameter (@{$args{'parameterlist'}}) {
my $parameter_name = $parameter;
$parameter_name =~ s/\[.*//;
+ $type = $args{'parametertypes'}{$parameter};
- print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
+ print " <varlistentry>\n <term><parameter>$type $parameter</parameter></term>\n";
print " <listitem>\n <para>\n";
$lineprefix=" ";
output_highlight($args{'parameterdescs'}{$parameter_name});
@@ -1223,8 +1224,9 @@ sub output_struct_xml(%) {
defined($args{'parameterdescs'}{$parameter_name}) || next;
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
+ $type = $args{'parametertypes'}{$parameter};
print " <varlistentry>";
- print " <term>$parameter</term>\n";
+ print " <term><literal>$type $parameter</literal></term>\n";
print " <listitem><para>\n";
output_highlight($args{'parameterdescs'}{$parameter_name});
print " </para></listitem>\n";