Techwizz/kernel-fxtec-pro1x
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

kernel-doc: cleanup perl script

Browse source 
Various cleanups of scripts/kernel-doc:
- don't use **/ as an ending kernel-doc block since it's not preferred;
- typos/spellos
- add whitespace around ==, after comma, & around . operator;

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
This commit is contained in:
Randy Dunlap 2009-06-09 08:50:38 -07:00 committed by Sam Ravnborg
parent ef53dae865
commit b9d97328e2
1 changed files with 87 additions and 87 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
scripts/kernel-doc
View file

@ -5,7 +5,7 @@ use strict;
## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## ## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
## Copyright (C) 2001 Simon Huggins ## ## Copyright (C) 2001 Simon Huggins ##
## Copyright (C) 2005-2008 Randy Dunlap ## ## Copyright (C) 2005-2009 Randy Dunlap ##
## ## ## ##
## #define enhancements by Armin Kuster <akuster@mvista.com> ## ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
## Copyright (c) 2000 MontaVista Software, Inc. ## ## Copyright (c) 2000 MontaVista Software, Inc. ##
@ -85,7 +85,7 @@ use strict;
# #
# /** # /**
# * my_function # * my_function
# **/ # */
# #
# If the Description: header tag is omitted, then there must be a blank line # If the Description: header tag is omitted, then there must be a blank line
# after the last parameter specification. # after the last parameter specification.
@ -105,7 +105,7 @@ use strict;
# */ # */
# etc. # etc.
# #
# Beside functions you can also write documentation for structs, unions, # Besides functions you can also write documentation for structs, unions,
# enums and typedefs. Instead of the function name you must write the name # enums and typedefs. Instead of the function name you must write the name
# of the declaration; the struct/union/enum/typedef must always precede # of the declaration; the struct/union/enum/typedef must always precede
# the name. Nesting of declarations is not supported. # the name. Nesting of declarations is not supported.
@ -240,8 +240,8 @@ my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
" " . ((localtime)[5]+1900); " " . ((localtime)[5]+1900);
# Essentially these are globals # Essentially these are globals
# They probably want to be tidied up made more localised or summat. # They probably want to be tidied up, made more localised or something.
# CAVEAT EMPTOR! Some of the others I localised may not want to be which # CAVEAT EMPTOR! Some of the others I localised may not want to be, which
# could cause "use of undefined value" or other bugs. # could cause "use of undefined value" or other bugs.
my ($function, %function_table, %parametertypes, $declaration_purpose); my ($function, %function_table, %parametertypes, $declaration_purpose);
my ($type, $declaration_name, $return_type); my ($type, $declaration_name, $return_type);