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

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

[Randy Dunlap]

Use the documented notation for nested struct members.
Add a Returns: 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 <rdunlap@infradead.org>
Cc: Bjorn Andersson <andersson@kernel.org>
Cc: Konrad Dybcio <konrad.dybcio@linaro.org>
Cc: linux-arm-msm@vger.kernel.org
---
 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.
+ *
+ * Returns: %IRQ_HANDLED
  */
 static irqreturn_t qcom_smp2p_intr(int irq, void *data)
 {

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

[Konrad Dybcio]

On 19.01.2024 04:28, Randy Dunlap wrote:
> Use the documented notation for nested struct members.
> Add a Returns: 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 <rdunlap@infradead.org>
> Cc: Bjorn Andersson <andersson@kernel.org>
> Cc: Konrad Dybcio <konrad.dybcio@linaro.org>
> Cc: linux-arm-msm@vger.kernel.org
> ---

Thanks!

Acked-by: Konrad Dybcio <konrad.dybcio@linaro.org>

Konrad