Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 262d9b01 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

[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: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Acked-by: default avatarJohannes Berg <johannes@sipsolutions.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent b6d6454f

scripts/kernel-doc

+2 −2
Original line number Diff line number Diff line
@@ -452,7 +452,7 @@ sub output_struct_html(%) { 
    my %args = %{$_[0]};

    my ($parameter);



    print "<h2>".$args{'type'}." ".$args{'struct'}."</h2>\n";

    print "<h2>".$args{'type'}." ".$args{'struct'}. " - " .$args{'purpose'}."</h2>\n";

    print "<b>".$args{'type'}." ".$args{'struct'}."</b> {<br>\n";

    foreach $parameter (@{$args{'parameterlist'}}) {

	if ($parameter =~ /^#/) {
@@ -498,8 +498,8 @@ sub output_function_html(%) { 
    my %args = %{$_[0]};

    my ($parameter, $section);

    my $count;

    print "<h2>Function</h2>\n";



    print "<h2>" .$args{'function'}." - ".$args{'purpose'}."</h2>\n";

    print "<i>".$args{'functiontype'}."</i>\n";

    print "<b>".$args{'function'}."</b>\n";

    print "(";