[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>
This commit is contained in:

committed by
Linus Torvalds

parent
7045f37b17
commit
d28bee0c0a
@@ -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);
|
||||
|
Reference in New Issue
Block a user