lkml.org 
[lkml]   [2021]   [May]   [23]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    SubjectRe: [PATCH] NFC: nfcmrvl: fix kernel-doc syntax in file headers
    From
    Date
    On 5/23/21 2:09 PM, Aditya Srivastava wrote:
    > 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>

    Thanks.

    > ---
    > drivers/nfc/nfcmrvl/fw_dnld.h | 2 +-
    > drivers/nfc/nfcmrvl/i2c.c | 2 +-
    > drivers/nfc/nfcmrvl/nfcmrvl.h | 2 +-
    > drivers/nfc/nfcmrvl/spi.c | 2 +-
    > drivers/nfc/nfcmrvl/uart.c | 2 +-
    > drivers/nfc/nfcmrvl/usb.c | 2 +-
    > 6 files changed, 6 insertions(+), 6 deletions(-)
    >
    > diff --git a/drivers/nfc/nfcmrvl/fw_dnld.h b/drivers/nfc/nfcmrvl/fw_dnld.h
    > index ee4a339c05fd..058ce77b3cbc 100644
    > --- a/drivers/nfc/nfcmrvl/fw_dnld.h
    > +++ b/drivers/nfc/nfcmrvl/fw_dnld.h
    > @@ -1,4 +1,4 @@
    > -/**
    > +/*
    > * Marvell NFC driver: Firmware downloader
    > *
    > * Copyright (C) 2015, Marvell International Ltd.
    > diff --git a/drivers/nfc/nfcmrvl/i2c.c b/drivers/nfc/nfcmrvl/i2c.c
    > index 18cd96284b77..c5420616b7bc 100644
    > --- a/drivers/nfc/nfcmrvl/i2c.c
    > +++ b/drivers/nfc/nfcmrvl/i2c.c
    > @@ -1,4 +1,4 @@
    > -/**
    > +/*
    > * Marvell NFC-over-I2C driver: I2C interface related functions
    > *
    > * Copyright (C) 2015, Marvell International Ltd.
    > diff --git a/drivers/nfc/nfcmrvl/nfcmrvl.h b/drivers/nfc/nfcmrvl/nfcmrvl.h
    > index de68ff45e49a..e84ee18c73ae 100644
    > --- a/drivers/nfc/nfcmrvl/nfcmrvl.h
    > +++ b/drivers/nfc/nfcmrvl/nfcmrvl.h
    > @@ -1,4 +1,4 @@
    > -/**
    > +/*
    > * Marvell NFC driver
    > *
    > * Copyright (C) 2014-2015, Marvell International Ltd.
    > diff --git a/drivers/nfc/nfcmrvl/spi.c b/drivers/nfc/nfcmrvl/spi.c
    > index 8e0ddb434770..dec0d3eb3648 100644
    > --- a/drivers/nfc/nfcmrvl/spi.c
    > +++ b/drivers/nfc/nfcmrvl/spi.c
    > @@ -1,4 +1,4 @@
    > -/**
    > +/*
    > * Marvell NFC-over-SPI driver: SPI interface related functions
    > *
    > * Copyright (C) 2015, Marvell International Ltd.
    > diff --git a/drivers/nfc/nfcmrvl/uart.c b/drivers/nfc/nfcmrvl/uart.c
    > index e5a622ce4b95..7194dd7ef0f1 100644
    > --- a/drivers/nfc/nfcmrvl/uart.c
    > +++ b/drivers/nfc/nfcmrvl/uart.c
    > @@ -1,4 +1,4 @@
    > -/**
    > +/*
    > * Marvell NFC-over-UART driver
    > *
    > * Copyright (C) 2015, Marvell International Ltd.
    > diff --git a/drivers/nfc/nfcmrvl/usb.c b/drivers/nfc/nfcmrvl/usb.c
    > index 888e298f610b..bcd563cb556c 100644
    > --- a/drivers/nfc/nfcmrvl/usb.c
    > +++ b/drivers/nfc/nfcmrvl/usb.c
    > @@ -1,4 +1,4 @@
    > -/**
    > +/*
    > * Marvell NFC-over-USB driver: USB interface related functions
    > *
    > * Copyright (C) 2014, Marvell International Ltd.
    >


    --
    ~Randy

    \
     
     \ /
      Last update: 2021-05-23 23:32    [W:2.777 / U:0.016 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site