summaryrefslogtreecommitdiffstats
path: root/scripts/kernel-doc
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@xenotime.net>2006-02-01 03:06:57 -0800
committerLinus Torvalds <torvalds@g5.osdl.org>2006-02-01 08:53:27 -0800
commitd28bee0c0a9c6abddf1d14c69f188400e994eb5a (patch)
treefb05862b35aa6f4f96867c9baeb4d6508d55bdb9 /scripts/kernel-doc
parent7045f37b17ffa6e85435ca980122b46a74caa7e4 (diff)
downloadlinux-d28bee0c0a9c6abddf1d14c69f188400e994eb5a.tar.gz
linux-d28bee0c0a9c6abddf1d14c69f188400e994eb5a.tar.bz2
linux-d28bee0c0a9c6abddf1d14c69f188400e994eb5a.zip
[PATCH] Doc/kernel-doc: add more usage info
- Add info that structs, unions, enums, and typedefs are supported. - Add doc about "private:" and "public:" tags for struct fields. - Fix some typos. - Remove some trailing whitespace. Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-xscripts/kernel-doc6
1 files changed, 3 insertions, 3 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index b927fd25e968..940fe348009f 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -45,7 +45,7 @@ use strict;
# Note: This only supports 'c'.
# usage:
-# kerneldoc [ -docbook | -html | -text | -man ]
+# kernel-doc [ -docbook | -html | -text | -man ]
# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
# or
# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
@@ -59,7 +59,7 @@ use strict;
# -nofunction funcname
# If set, then only generate documentation for the other function(s). All
# other functions are ignored. Cannot be used with -function together
-# (yes thats a bug - perl hackers can fix it 8))
+# (yes, that's a bug -- perl hackers can fix it 8))
#
# c files - list of 'c' files to process
#
@@ -434,7 +434,7 @@ sub output_enum_html(%) {
print "<hr>\n";
}
-# output tyepdef in html
+# output typedef in html
sub output_typedef_html(%) {
my %args = %{$_[0]};
my ($parameter);