Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b9d97328 authored by Randy Dunlap's avatar Randy Dunlap Committed by Sam Ravnborg
Browse files

kernel-doc: cleanup perl script 



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: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarSam Ravnborg <sam@ravnborg.org>
parent ef53dae8

scripts/kernel-doc

+87 −87
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ use strict; 
## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##

## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##

## 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>	 ##

## Copyright (c) 2000 MontaVista Software, Inc.			 ##
@@ -85,7 +85,7 @@ use strict; 
#

# /**

#  * my_function

#  **/

#  */

#

# If the Description: header tag is omitted, then there must be a blank line

# after the last parameter specification.
@@ -105,7 +105,7 @@ use strict; 
#  */

# 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

# of the declaration;  the struct/union/enum/typedef must always precede

# the name. Nesting of declarations is not supported.
@@ -240,8 +240,8 @@ my $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 
  " " . ((localtime)[5]+1900);



# Essentially these are globals

# They probably want to be tidied up made more localised or summat.

# CAVEAT EMPTOR!  Some of the others I localised may not want to be which

# 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

# could cause "use of undefined value" or other bugs.

my ($function, %function_table, %parametertypes, $declaration_purpose);

my ($type, $declaration_name, $return_type);