diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2007-05-08 00:29:51 -0700 |
---|---|---|
committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-05-08 11:15:10 -0700 |
commit | 3eb014a103701bedfaa11bc321f470e918c71ff7 (patch) | |
tree | 7b8c205b80d0f63874849ed4c27a0df49717c27c /scripts | |
parent | 3361c7bebbf207f57f3dd1282cd87e1e37c082ac (diff) | |
download | lwn-3eb014a103701bedfaa11bc321f470e918c71ff7.tar.gz lwn-3eb014a103701bedfaa11bc321f470e918c71ff7.zip |
kernel-doc: html mode struct highlights
Johannes Berg reported that struct names are not highlighted
(bold, italic, etc.) in html kernel-doc output. (Also not in
text-mode output, but I don't see that changing.)
This patch adds the following:
- highlight struct names in html output mode
- highlight environment var. names in html output mode
- indent struct fields in the original struct layout
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Johannes Berg <johannes@sipsolutions.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'scripts')
-rwxr-xr-x | scripts/kernel-doc | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index c47eb31d604c..a3e23b10ae97 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -159,7 +159,8 @@ my $warnings = 0; my $type_constant = '\%([-_\w]+)'; my $type_func = '(\w+)\(\)'; my $type_param = '\@(\w+)'; -my $type_struct = '\&((struct\s*)?[_\w]+)'; +my $type_struct = '\&((struct\s*)*[_\w]+)'; +my $type_struct_xml = '\\\amp;((struct\s*)*[_\w]+)'; my $type_env = '(\$\w+)'; # Output conversion substitutions. @@ -168,7 +169,8 @@ my $type_env = '(\$\w+)'; # these work fairly well my %highlights_html = ( $type_constant, "<i>\$1</i>", $type_func, "<b>\$1</b>", - $type_struct, "<i>\$1</i>", + $type_struct_xml, "<i>\$1</i>", + $type_env, "<b><i>\$1</i></b>", $type_param, "<tt><b>\$1</b></tt>" ); my $blankline_html = "<p>"; @@ -331,7 +333,7 @@ while ($ARGV[0] =~ m/^-(.*)/) { # using the s// operator. my $dohighlight = ""; foreach my $pattern (keys %highlights) { -# print "scanning pattern $pattern ($highlights{$pattern})\n"; +# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n"; $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n"; } @@ -378,8 +380,14 @@ sub output_highlight { # confess "output_highlight got called with no args?\n"; # } +# print STDERR "contents b4:$contents\n"; eval $dohighlight; die $@ if $@; + if ($output_mode eq "html") { + $contents =~ s/\\\\//; + } +# print STDERR "contents af:$contents\n"; + foreach $line (split "\n", $contents) { if ($line eq ""){ print $lineprefix, $blankline; @@ -466,11 +474,12 @@ sub output_struct_html(%) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function - print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n"; + print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n"; } elsif ($type =~ m/^(.*?)\s*(:.*)/) { - print " <i>$1</i> <b>$parameter</b>$2;<br>\n"; + # bitfield + print " <i>$1</i> <b>$parameter</b>$2;<br>\n"; } else { - print " <i>$type</i> <b>$parameter</b>;<br>\n"; + print " <i>$type</i> <b>$parameter</b>;<br>\n"; } } print "};<br>\n"; |