2024-01-23 09:12:09

by Randy Dunlap

Subject: [PATCH v2] soc: qcom: smp2p: fix all kernel-doc warnings

Use the documented notation for nested struct members.
Add a Return: comment for qcom_smp2p_intr().

These changes prevent these kernel-doc warnings:

smp2p.c:78: warning: Excess struct member 'name' description in 'smp2p_smem_item'
smp2p.c:78: warning: Excess struct member 'value' description in 'smp2p_smem_item'
smp2p.c:280: warning: No description found for return value of 'qcom_smp2p_intr'

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Bjorn Andersson <[email protected]>
Cc: Konrad Dybcio <[email protected]>
Cc: [email protected]
Cc: Jeff Johnson <[email protected]>
---
v2: use Return: instead of Returns: for consistency with documentation
(Jeff Johnson)

drivers/soc/qcom/smp2p.c | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)

diff -- a/drivers/soc/qcom/smp2p.c b/drivers/soc/qcom/smp2p.c
--- a/drivers/soc/qcom/smp2p.c
+++ b/drivers/soc/qcom/smp2p.c
@@ -58,8 +58,8 @@
* @valid_entries: number of allocated entries
* @flags:
* @entries: individual communication entries
- * @name: name of the entry
- * @value: content of the entry
+ * @entries.name: name of the entry
+ * @entries.value: content of the entry
*/
struct smp2p_smem_item {
u32 magic;
@@ -275,6 +275,8 @@ static void qcom_smp2p_notify_in(struct
*
* Handle notifications from the remote side to handle newly allocated entries
* or any changes to the state bits of existing entries.
+ *
+ * Return: %IRQ_HANDLED
*/
static irqreturn_t qcom_smp2p_intr(int irq, void *data)
{

2024-01-27 22:37:16

by Bjorn Andersson

Subject: Re: [PATCH v2] soc: qcom: smp2p: fix all kernel-doc warnings

On Mon, 22 Jan 2024 21:33:29 -0800, Randy Dunlap wrote:
> Use the documented notation for nested struct members.
> Add a Return: comment for qcom_smp2p_intr().
>
> These changes prevent these kernel-doc warnings:
>
> smp2p.c:78: warning: Excess struct member 'name' description in 'smp2p_smem_item'
> smp2p.c:78: warning: Excess struct member 'value' description in 'smp2p_smem_item'
> smp2p.c:280: warning: No description found for return value of 'qcom_smp2p_intr'
>
> [...]

Applied, thanks!

[1/1] soc: qcom: smp2p: fix all kernel-doc warnings
commit: 4abcc42a3f874b515c27bf2d33f1c1d567afcf7f

Best regards,
--
Bjorn Andersson <[email protected]>