soc: qcom: smp2p: fix all kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Tue, 23 Jan 2024 05:33:29 +0000 (21:33 -0800)
committerBjorn Andersson <andersson@kernel.org>
Tue, 23 Jan 2024 15:37:20 +0000 (09:37 -0600)
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 <rdunlap@infradead.org>
Cc: Bjorn Andersson <andersson@kernel.org>
Cc: Konrad Dybcio <konrad.dybcio@linaro.org>
Cc: linux-arm-msm@vger.kernel.org
Cc: Jeff Johnson <quic_jjohnson@quicinc.com>
Link: https://lore.kernel.org/r/20240123053329.12893-1-rdunlap@infradead.org
Signed-off-by: Bjorn Andersson <andersson@kernel.org>
drivers/soc/qcom/smp2p.c

index 914b2246148fcb4c44ec3e267bb41868761e2b9c..a21241cbeec7bab72ab89eec731f7fbf2aaec502 100644 (file)
@@ -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 qcom_smp2p *smp2p)
  *
  * 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)
 {