Re: [PATCH 3/3] staging: vt6655: card.c, srom.c, vntwifi.c: Codecleanup

[Dan Carpenter]

On Fri, Dec 02, 2011 at 07:58:12PM +0000, Marcos Paulo de Souza wrote:
> This patch removes commented code, useless comments, blank lines and fix
> coding style of the headers of functions.
> 
> Signed-off-by: Marcos Paulo de Souza <marcos.mage@xxxxxxxxx>
> Cc: Greg Kroah-Hartman <gregkh@xxxxxxx>
> Cc: devel@xxxxxxxxxxxxxxxxxxxx
> ---
>  /*
> - * Description: Test if bits off in eeprom
> - *
> - * Parameters:
> - *  In:
> - *      dwIoBase        - I/O base address
> - *      byContntOffset  - address of EEPROM
> - *      byTestBits      - bits to test
> - *  Out:
> - *      none
> - *
> - * Return Value: true if all test bits off; otherwise false
> - *
> + * Test if bits off in eeprom
>   */

Some of these seems sort of useful.  It might be better to change
them to doc-book format instead of deleting them:

/**
 * SROMbIsRegBitsOff() - Test if bits off in eeprom
 * @dwIoBase:       I/O base address
 * @byContntOffset: Address of EEPROM
 * @byTestBits:     Bits to test
 *
 * Returns true if all test bits off; otherwise false.
 */

There is a howto in Documentation/kernel-doc-nano-HOWTO.txt.

regards,
dan carpenter

Attachment: signature.asc
Description: Digital signature