]> git.baikalelectronics.ru Git - kernel.git/commit
net: encx24j600: fix kernel-doc syntax in file headers
authorAditya Srivastava <yashsri421@gmail.com>
Thu, 20 May 2021 18:49:15 +0000 (00:19 +0530)
committerDavid S. Miller <davem@davemloft.net>
Thu, 20 May 2021 22:25:38 +0000 (15:25 -0700)
commit2676ba9727edbb2ffdb269c2552a5e340d841693
tree8ed9a2a2ee9dbdb1be844f720c192874633bace9
parentd73878664f0a9ca69282bc275ef8a29addcd2651
net: encx24j600: fix kernel-doc syntax in file headers

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/net/ethernet/microchip/encx24j600 files 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 warning from kernel-doc.
For e.g., running scripts/kernel-doc -none
drivers/net/ethernet/microchip/encx24j600_hw.h emits:
warning: expecting prototype for h(). Prototype was for _ENCX24J600_HW_H() 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>
drivers/net/ethernet/microchip/encx24j600.c
drivers/net/ethernet/microchip/encx24j600_hw.h