summaryrefslogtreecommitdiffstats
path: root/doc/kernel-doc
diff options
context:
space:
mode:
authorMartin Mares <mj@ucw.cz>2000-06-05 18:19:27 +0200
committerMartin Mares <mj@ucw.cz>2000-06-05 18:19:27 +0200
commitb458ce83d7cdc507aa18e5fed2ab206847bc317e (patch)
tree8edb1f0c49dd28ae57a6f25ad4dee8eac0b7d25a /doc/kernel-doc
parent2a5d7caa951d37c50d52ebef8ef269fa587dec5e (diff)
downloadbird-b458ce83d7cdc507aa18e5fed2ab206847bc317e.tar
bird-b458ce83d7cdc507aa18e5fed2ab206847bc317e.zip
Print out function synopsis as a part of the declaration.
Also, reverted my previous hack for `&' and replaced it by just disabling the `& -> &amp;' conversions.
Diffstat (limited to 'doc/kernel-doc')
-rwxr-xr-xdoc/kernel-doc21
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/kernel-doc b/doc/kernel-doc
index 6784487..14aa37f 100755
--- a/doc/kernel-doc
+++ b/doc/kernel-doc
@@ -76,7 +76,7 @@
#
# 'funcname()' - function
# '$ENVVAR' - environmental variable
-# '&struct_name' - name of a structure
+# '&struct_name' - name of a structure or a type
# '@parameter' - name of a parameter
# '%CONST' - name of a constant.
# '|code|' - literal string
@@ -85,7 +85,7 @@
$type_constant = "\\\%(\\w+)";
$type_func = "(\\w+\\(\\))";
$type_param = "\\\@(\\w+)";
-$type_struct = "\\\\\\\\\\\\amp;(\\w+)";
+$type_struct = "\\\&(\\w+)";
$type_env = "(\\\$\\w+)";
$type_code = "\\|([^|]*)\\|";
@@ -543,7 +543,12 @@ sub output_bird {
print ", ";
}
}
- print ")\n";
+ print ")";
+ if (defined $args{'purpose'}) {
+ print " -- ";
+ output_highlight($args{'purpose'});
+ }
+ print "\n";
if ($ntyped) {
print "<funcsect>Arguments\n";
@@ -834,7 +839,7 @@ foreach $file (@ARGV) {
$newcontents = $2;
if ($contents ne "") {
- $contents =~ s/\&/\\\\\\amp;/g;
+# $contents =~ s/\&/\\\\\\amp;/g;
$contents =~ s/\</\\\\\\lt;/g;
$contents =~ s/\>/\\\\\\gt;/g;
dump_section($section, $contents);
@@ -849,7 +854,7 @@ foreach $file (@ARGV) {
} elsif (/$doc_end/) {
if ($contents ne "") {
- $contents =~ s/\&/\\\\\\amp;/g;
+# $contents =~ s/\&/\\\\\\amp;/g;
$contents =~ s/\</\\\\\\lt;/g;
$contents =~ s/\>/\\\\\\gt;/g;
dump_section($section, $contents);
@@ -864,7 +869,7 @@ foreach $file (@ARGV) {
# miguel-style comment kludge, look for blank lines after
# @parameter line to signify start of description
if ($1 eq "" && $section =~ m/^@/) {
- $contents =~ s/\&/\\\\\\amp;/g;
+# $contents =~ s/\&/\\\\\\amp;/g;
$contents =~ s/\</\\\\\\lt;/g;
$contents =~ s/\>/\\\\\\gt;/g;
dump_section($section, $contents);
@@ -904,7 +909,7 @@ foreach $file (@ARGV) {
} elsif ($state == 4) {
# Documentation block
if (/$doc_block/) {
- $contents =~ s/\&/\\\\\\amp;/g;
+# $contents =~ s/\&/\\\\\\amp;/g;
$contents =~ s/\</\\\\\\lt;/g;
$contents =~ s/\>/\\\\\\gt;/g;
dump_section($section, $contents);
@@ -927,7 +932,7 @@ foreach $file (@ARGV) {
}
elsif (/$doc_end/)
{
- $contents =~ s/\&/\\\\\\amp;/g;
+# $contents =~ s/\&/\\\\\\amp;/g;
$contents =~ s/\</\\\\\\lt;/g;
$contents =~ s/\>/\\\\\\gt;/g;
dump_section($section, $contents);