Skip to content

Commit

Permalink
NFC: nfcmrvl: fix kernel-doc syntax in file headers
Browse files Browse the repository at this point in the history
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/nfc/nfcmrvl follows this syntax, but the content
inside does not comply with kernel-doc.

This line was probably not meant for kernel-doc parsing, but is parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warnings from kernel-doc.
For e.g., running scripts/kernel-doc -none on drivers/nfc/nfcmrvl/spi.c
causes warning:
warning: expecting prototype for Marvell NFC(). Prototype was for SPI_WAIT_HANDSHAKE() instead

Provide a simple fix by replacing such occurrences with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.

Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
  • Loading branch information
Aditya Srivastava authored and David S. Miller committed May 24, 2021
1 parent 474a2dd commit 4dd649d
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion drivers/nfc/nfcmrvl/fw_dnld.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Marvell NFC driver: Firmware downloader
*
* Copyright (C) 2015, Marvell International Ltd.
Expand Down
2 changes: 1 addition & 1 deletion drivers/nfc/nfcmrvl/i2c.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Marvell NFC-over-I2C driver: I2C interface related functions
*
* Copyright (C) 2015, Marvell International Ltd.
Expand Down
2 changes: 1 addition & 1 deletion drivers/nfc/nfcmrvl/nfcmrvl.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Marvell NFC driver
*
* Copyright (C) 2014-2015, Marvell International Ltd.
Expand Down
2 changes: 1 addition & 1 deletion drivers/nfc/nfcmrvl/spi.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Marvell NFC-over-SPI driver: SPI interface related functions
*
* Copyright (C) 2015, Marvell International Ltd.
Expand Down
2 changes: 1 addition & 1 deletion drivers/nfc/nfcmrvl/uart.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Marvell NFC-over-UART driver
*
* Copyright (C) 2015, Marvell International Ltd.
Expand Down
2 changes: 1 addition & 1 deletion drivers/nfc/nfcmrvl/usb.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Marvell NFC-over-USB driver: USB interface related functions
*
* Copyright (C) 2014, Marvell International Ltd.
Expand Down

0 comments on commit 4dd649d

Please sign in to comment.