Commit fc6d7af8 authored by Paolo Bonzini's avatar Paolo Bonzini Committed by Jonathan Corbet
Browse files

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: default avatarPaolo Bonzini <pbonzini@redhat.com>
Acked-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent b1aaa546

scripts/kernel-doc

+4 −2
Original line number Diff line number Diff line
@@ -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";

CRA Git | Maintained and supported by SUSTech CRA and CCSE