Doug / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 262d9b0130edf9aef1819b211d69f48883d2ac10

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent b6d6454fdb
Exists in master and in 7 other branches imx_3.0.35_4.1.0, imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga, smarc-l5.0.0_1.0.0-ga

[PATCH] kernel-doc: include struct short description in title output 

Output of a function or struct in html mode needs to include the short
description from the function/struct name line in the output title line.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Acked-by: Johannes Berg <johannes@sipsolutions.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 1 changed file with 2 additions and 2 deletions Side-by-side Diff

... ... @@ -452,7 +452,7 @@
452 452 my %args = %{$_[0]};
453 453 my ($parameter);
454 454  
455   - print "<h2>".$args{'type'}." ".$args{'struct'}."</h2>\n";
  455 + print "<h2>".$args{'type'}." ".$args{'struct'}. " - " .$args{'purpose'}."</h2>\n";
456 456 print "<b>".$args{'type'}." ".$args{'struct'}."</b> {<br>\n";
457 457 foreach $parameter (@{$args{'parameterlist'}}) {
458 458 if ($parameter =~ /^#/) {
459 459  
... ... @@ -498,8 +498,8 @@
498 498 my %args = %{$_[0]};
499 499 my ($parameter, $section);
500 500 my $count;
501   - print "<h2>Function</h2>\n";
502 501  
  502 + print "<h2>" .$args{'function'}." - ".$args{'purpose'}."</h2>\n";
503 503 print "<i>".$args{'functiontype'}."</i>\n";
504 504 print "<b>".$args{'function'}."</b>\n";
505 505 print "(";