• Aditya Srivastava's avatar
    NFC: nfcmrvl: fix kernel-doc syntax in file headers · 4dd649d1
    Aditya Srivastava authored
    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: default avatarAditya Srivastava <yashsri421@gmail.com>
    Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
    4dd649d1
nfcmrvl.h 2.97 KB