Commit ada5f446 authored by Gabriel Krisman Bertazi's avatar Gabriel Krisman Bertazi Committed by Jonathan Corbet

kernel-doc: properly document array arguments of function

Documentation for array parameters passed in a function, like the first
argument in the function below, weren't getting exported in the rst
format, although they work fine for html and pdf formats:

  void drm_clflush_pages(struct page * pages[], unsigned long num_pages)

That's because the string key to store the description in the
parameterdescs dictionary doesn't have the [] suffix.  This cleans up
the suffix from the key before accessing the dictionary.
Signed-off-by: default avatarGabriel Krisman Bertazi <krisman@collabora.co.uk>
Fixes: c0d1b6ee ("kernel-doc: produce RestructuredText output")
Reviewed-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent ff58fa7f
...@@ -1925,7 +1925,7 @@ sub output_function_rst(%) { ...@@ -1925,7 +1925,7 @@ sub output_function_rst(%) {
$lineprefix = " "; $lineprefix = " ";
foreach $parameter (@{$args{'parameterlist'}}) { foreach $parameter (@{$args{'parameterlist'}}) {
my $parameter_name = $parameter; my $parameter_name = $parameter;
#$parameter_name =~ s/\[.*//; $parameter_name =~ s/\[.*//;
$type = $args{'parametertypes'}{$parameter}; $type = $args{'parametertypes'}{$parameter};
if ($type ne "") { if ($type ne "") {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment