aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2017-01-02 10:22:25 -0500
committerJonathan Corbet <corbet@lwn.net>2017-01-04 17:07:53 -0500
commitfc6d7af89fa968c378d4437d7905ccd76efa6af4 (patch)
tree930842d087a149f5b913d9913e90e53aae267499
parentb1aaa546b52baf7cdc97961e9ba445a26948c1af (diff)
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>
-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(%) {
1131 foreach $parameter (@{$args{'parameterlist'}}) { 1131 foreach $parameter (@{$args{'parameterlist'}}) {
1132 my $parameter_name = $parameter; 1132 my $parameter_name = $parameter;
1133 $parameter_name =~ s/\[.*//; 1133 $parameter_name =~ s/\[.*//;
1134 $type = $args{'parametertypes'}{$parameter};
1134 1135
1135 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n"; 1136 print " <varlistentry>\n <term><parameter>$type $parameter</parameter></term>\n";
1136 print " <listitem>\n <para>\n"; 1137 print " <listitem>\n <para>\n";
1137 $lineprefix=" "; 1138 $lineprefix=" ";
1138 output_highlight($args{'parameterdescs'}{$parameter_name}); 1139 output_highlight($args{'parameterdescs'}{$parameter_name});
@@ -1223,8 +1224,9 @@ sub output_struct_xml(%) {
1223 1224
1224 defined($args{'parameterdescs'}{$parameter_name}) || next; 1225 defined($args{'parameterdescs'}{$parameter_name}) || next;
1225 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 1226 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1227 $type = $args{'parametertypes'}{$parameter};
1226 print " <varlistentry>"; 1228 print " <varlistentry>";
1227 print " <term>$parameter</term>\n"; 1229 print " <term><literal>$type $parameter</literal></term>\n";
1228 print " <listitem><para>\n"; 1230 print " <listitem><para>\n";
1229 output_highlight($args{'parameterdescs'}{$parameter_name}); 1231 output_highlight($args{'parameterdescs'}{$parameter_name});
1230 print " </para></listitem>\n"; 1232 print " </para></listitem>\n";