]> git.karo-electronics.de Git - karo-tx-linux.git/commitdiff
kernel-doc: include parameter type in docbook output
authorPaolo Bonzini <pbonzini@redhat.com>
Mon, 2 Jan 2017 15:22:25 +0000 (16:22 +0100)
committerJonathan Corbet <corbet@lwn.net>
Wed, 4 Jan 2017 22:07:53 +0000 (15:07 -0700)
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>
scripts/kernel-doc

index 99b4847f9bb225dde733a0ecbb78c1370db9ccb1..5476cf4f4673f807fcc4e6c30fa20428c9944c73 100755 (executable)
@@ -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";