| Message ID | 20230113064108.29172-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | backlight: ili922x: fix kernel-doc warnings | expand |
On Thu, Jan 12, 2023 at 10:41:08PM -0800, Randy Dunlap wrote: > Convert comments for START_BYTE() and CHECK_FREQ_REG() macros into > kernel-doc notation to avoid these kernel-doc warnings: > > drivers/video/backlight/ili922x.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * START_BYTE(id, rs, rw) > drivers/video/backlight/ili922x.c:118: warning: expecting prototype for CHECK_FREQ_REG(spi_device s, spi_transfer x)(). Prototype was for CHECK_FREQ_REG() instead > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Lee Jones <lee@kernel.org> > Cc: Daniel Thompson <daniel.thompson@linaro.org> > Cc: Jingoo Han <jingoohan1@gmail.com> > Cc: Helge Deller <deller@gmx.de> > Cc: dri-devel@lists.freedesktop.org > Cc: linux-fbdev@vger.kernel.org Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org> Daniel.
On Thu, 12 Jan 2023, Randy Dunlap wrote: > Convert comments for START_BYTE() and CHECK_FREQ_REG() macros into > kernel-doc notation to avoid these kernel-doc warnings: > > drivers/video/backlight/ili922x.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * START_BYTE(id, rs, rw) > drivers/video/backlight/ili922x.c:118: warning: expecting prototype for CHECK_FREQ_REG(spi_device s, spi_transfer x)(). Prototype was for CHECK_FREQ_REG() instead > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Lee Jones <lee@kernel.org> > Cc: Daniel Thompson <daniel.thompson@linaro.org> > Cc: Jingoo Han <jingoohan1@gmail.com> > Cc: Helge Deller <deller@gmx.de> > Cc: dri-devel@lists.freedesktop.org > Cc: linux-fbdev@vger.kernel.org > --- > drivers/video/backlight/ili922x.c | 24 ++++++++++++------------ > 1 file changed, 12 insertions(+), 12 deletions(-) Applied, thanks
diff -- a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c --- a/drivers/video/backlight/ili922x.c +++ b/drivers/video/backlight/ili922x.c @@ -82,13 +82,7 @@ #define START_RW_READ 1 /** - * START_BYTE(id, rs, rw) - * - * Set the start byte according to the required operation. - * The start byte is defined as: - * ---------------------------------- - * | 0 | 1 | 1 | 1 | 0 | ID | RS | RW | - * ---------------------------------- + * START_BYTE - Set the start byte according to the required operation. * @id: display's id as set by the manufacturer * @rs: operation type bit, one of: * - START_RS_INDEX set the index register @@ -96,19 +90,25 @@ * @rw: read/write operation * - START_RW_WRITE write * - START_RW_READ read + * + * The start byte is defined as: + * ---------------------------------- + * | 0 | 1 | 1 | 1 | 0 | ID | RS | RW | + * ---------------------------------- */ #define START_BYTE(id, rs, rw) \ (0x70 | (((id) & 0x01) << 2) | (((rs) & 0x01) << 1) | ((rw) & 0x01)) /** - * CHECK_FREQ_REG(spi_device s, spi_transfer x) - Check the frequency - * for the SPI transfer. According to the datasheet, the controller - * accept higher frequency for the GRAM transfer, but it requires + * CHECK_FREQ_REG - Check the frequency for the SPI transfer. + * @s: pointer to an SPI device + * @x: pointer to the spi_transfer spec (for read/write buffer pair) + * + * According to the datasheet, the controller + * accepts a higher frequency for the GRAM transfer, but it requires * lower frequency when the registers are read/written. * The macro sets the frequency in the spi_transfer structure if * the frequency exceeds the maximum value. - * @s: pointer to an SPI device - * @x: pointer to the read/write buffer pair */ #define CHECK_FREQ_REG(s, x) \ do { \
Convert comments for START_BYTE() and CHECK_FREQ_REG() macros into kernel-doc notation to avoid these kernel-doc warnings: drivers/video/backlight/ili922x.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * START_BYTE(id, rs, rw) drivers/video/backlight/ili922x.c:118: warning: expecting prototype for CHECK_FREQ_REG(spi_device s, spi_transfer x)(). Prototype was for CHECK_FREQ_REG() instead Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Lee Jones <lee@kernel.org> Cc: Daniel Thompson <daniel.thompson@linaro.org> Cc: Jingoo Han <jingoohan1@gmail.com> Cc: Helge Deller <deller@gmx.de> Cc: dri-devel@lists.freedesktop.org Cc: linux-fbdev@vger.kernel.org --- drivers/video/backlight/ili922x.c | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-)