diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2007-02-20 16:58:04 -0500 |
---|---|---|
committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-02-20 20:10:14 -0500 |
commit | 262d9b0130edf9aef1819b211d69f48883d2ac10 (patch) | |
tree | 2d02ed11cd71a3dfe25a12f0428770c9a9a9e624 | |
parent | b6d6454fdb66f3829af8b92ab06825b6060fdf7e (diff) |
[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>
-rwxr-xr-x | scripts/kernel-doc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 4d928b859845..fb43c6440e54 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc | |||
@@ -452,7 +452,7 @@ sub output_struct_html(%) { | |||
452 | my %args = %{$_[0]}; | 452 | my %args = %{$_[0]}; |
453 | my ($parameter); | 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 | print "<b>".$args{'type'}." ".$args{'struct'}."</b> {<br>\n"; | 456 | print "<b>".$args{'type'}." ".$args{'struct'}."</b> {<br>\n"; |
457 | foreach $parameter (@{$args{'parameterlist'}}) { | 457 | foreach $parameter (@{$args{'parameterlist'}}) { |
458 | if ($parameter =~ /^#/) { | 458 | if ($parameter =~ /^#/) { |
@@ -498,8 +498,8 @@ sub output_function_html(%) { | |||
498 | my %args = %{$_[0]}; | 498 | my %args = %{$_[0]}; |
499 | my ($parameter, $section); | 499 | my ($parameter, $section); |
500 | my $count; | 500 | my $count; |
501 | print "<h2>Function</h2>\n"; | ||
502 | 501 | ||
502 | print "<h2>" .$args{'function'}." - ".$args{'purpose'}."</h2>\n"; | ||
503 | print "<i>".$args{'functiontype'}."</i>\n"; | 503 | print "<i>".$args{'functiontype'}."</i>\n"; |
504 | print "<b>".$args{'function'}."</b>\n"; | 504 | print "<b>".$args{'function'}."</b>\n"; |
505 | print "("; | 505 | print "("; |