Re: [PATCH] megaraid: fix kernel-doc

[Randy Dunlap <randy.dunlap@oracle.com>]

On Fri, 5 Jan 2007 22:41:48 -0800 Randy Dunlap wrote:

> From: Randy Dunlap <randy.dunlap@oracle.com>

Oh, this applies on top of today's patch from Sumant (which Andrew
has put into -mm)...


> kernel-doc modifications:
> - change "@param var" notation to @var;
> - change function/description separator from ':' to '-';
> - change var/description separator from '-' to ':';
> - fix a few doc. typos;
> - don't use kernel-doc /** lead-in when the doc. block is not kernel-doc;
> - use Linux common */ ending comment format instead of **/;
> - use correct function parameter names;
> - place function parameters immediately after the function short description;
> - place kernel-doc immediately before its function or macro;
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
> ---
>  drivers/scsi/megaraid/mega_common.h    |  120 ++++++-------
>  drivers/scsi/megaraid/megaraid_ioctl.h |   36 ++--
>  drivers/scsi/megaraid/megaraid_mbox.c  |  285 ++++++++++++++++-----------------
>  drivers/scsi/megaraid/megaraid_mbox.h  |   42 ++--
>  drivers/scsi/megaraid/megaraid_mm.c    |   65 +++----
>  drivers/scsi/megaraid/megaraid_sas.h   |   14 -
>  6 files changed, 275 insertions(+), 287 deletions(-)


---
~Randy