Skip to content

Commit fc6d7af

Browse files
bonziniJonathan Corbet
authored andcommitted
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>
1 parent b1aaa54 commit fc6d7af

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

scripts/kernel-doc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,8 +1131,9 @@ sub output_function_xml(%) {
11311131
foreach $parameter (@{$args{'parameterlist'}}) {
11321132
my $parameter_name = $parameter;
11331133
$parameter_name =~ s/\[.*//;
1134+
$type = $args{'parametertypes'}{$parameter};
11341135

1135-
print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
1136+
print " <varlistentry>\n <term><parameter>$type $parameter</parameter></term>\n";
11361137
print " <listitem>\n <para>\n";
11371138
$lineprefix=" ";
11381139
output_highlight($args{'parameterdescs'}{$parameter_name});
@@ -1223,8 +1224,9 @@ sub output_struct_xml(%) {
12231224

12241225
defined($args{'parameterdescs'}{$parameter_name}) || next;
12251226
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1227+
$type = $args{'parametertypes'}{$parameter};
12261228
print " <varlistentry>";
1227-
print " <term>$parameter</term>\n";
1229+
print " <term><literal>$type $parameter</literal></term>\n";
12281230
print " <listitem><para>\n";
12291231
output_highlight($args{'parameterdescs'}{$parameter_name});
12301232
print " </para></listitem>\n";

0 commit comments

Comments
 (0)