| Message ID | 20210314201818.27380-10-yashsri421@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | rsi: fix comment syntax in file headers | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Not a local patch |
diff --git a/drivers/net/wireless/rsi/rsi_sdio.h b/drivers/net/wireless/rsi/rsi_sdio.h index 1c756263cf15..7c91b126b350 100644 --- a/drivers/net/wireless/rsi/rsi_sdio.h +++ b/drivers/net/wireless/rsi/rsi_sdio.h @@ -1,4 +1,4 @@ -/** +/* * @section LICENSE * Copyright (c) 2014 Redpine Signals Inc. *
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. The header comment used in drivers/net/wireless/rsi/rsi_sdio.h follows kernel-doc syntax, i.e. starts with '/**'. But the content inside the comment does not comply with kernel-doc specifications (i.e., function, struct, etc). This causes unwelcomed warning from kernel-doc: "warning: Cannot understand * @section LICENSE on line 2 - I thought it was a doc line" Replace this comment syntax with general comment format, i.e. '/*' to prevent kernel-doc from parsing it. Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> --- drivers/net/wireless/rsi/rsi_sdio.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)