Messages in this thread | | | Subject | Re: [PATCH v2] kernel-doc: include struct short description in title output | From | Johannes Berg <> | Date | Tue, 13 Feb 2007 20:43:38 +0100 |
| |
On Tue, 2007-02-13 at 11:35 -0800, Randy Dunlap wrote: > > Yup, that fixes it for structs. I guess I forgot to mention this earlier > > because I didn't notice it until now... the same bug exists for > > functions as well. > > updated patch. Thanks.
Thanks, works great.
> --- > > From: Randy Dunlap <randy.dunlap@oracle.com> > > 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>
So if anyone cares:
Acked-by: Johannes Berg <johannes@sipsolutions.net>
> --- > scripts/kernel-doc | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > --- linux-2.6.20-git7.orig/scripts/kernel-doc > +++ linux-2.6.20-git7/scripts/kernel-doc > @@ -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 "("; > [unhandled content-type:application/pgp-signature] | |