soc: qcom: address kernel-doc warnings
authorLukas Bulwahn <lukas.bulwahn@gmail.com>
Sat, 27 Mar 2021 06:56:42 +0000 (07:56 +0100)
committerBjorn Andersson <bjorn.andersson@linaro.org>
Tue, 30 Mar 2021 03:49:54 +0000 (22:49 -0500)
commit8058dfa05ab765153f20020fc4ea3b296e391a00
treeefa8d7c3a5cbba841c8a287fb961810cdf98c6cb
parent99d52c872d34b9d75fccab1782474cde45426708
soc: qcom: address kernel-doc warnings

The command:

  find ./include/linux/soc/qcom/ | xargs ./scripts/kernel-doc -none

reports:

  ./include/linux/soc/qcom/qmi.h:26: warning: cannot understand function prototype: 'struct qmi_header '
  ./include/linux/soc/qcom/qmi.h:101: warning: cannot understand function prototype: 'struct qmi_response_type_v01 '
  ./include/linux/soc/qcom/irq.h:19: warning: expecting prototype for QCOM specific IRQ domain flags that distinguishes the handling of wakeup(). Prototype was for IRQ_DOMAIN_FLAG_QCOM_PDC_WAKEUP() instead
  ./include/linux/soc/qcom/apr.h:126: warning: Function parameter or member '__apr_driver' not described in 'module_apr_driver'
  ./include/linux/soc/qcom/apr.h:126: warning: Excess function parameter '__aprbus_driver' description in 'module_apr_driver'
  ./include/linux/soc/qcom/llcc-qcom.h:43: warning: cannot understand function prototype: 'struct llcc_slice_desc '
  ./include/linux/soc/qcom/llcc-qcom.h:60: warning: cannot understand function prototype: 'struct llcc_edac_reg_data '
  ./include/linux/soc/qcom/llcc-qcom.h:86: warning: cannot understand function prototype: 'struct llcc_drv_data '

Address all those warnings by:
  - prefixing kernel-doc descriptions for structs with the keyword 'struct',
  - turning a kernel-doc comment that does not follow the kernel-doc syntax
  into a normal comment, and
  - correcting a parameter name in a kernel-doc comment.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Link: https://lore.kernel.org/r/20210327065642.11969-3-lukas.bulwahn@gmail.com
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
include/linux/soc/qcom/apr.h
include/linux/soc/qcom/irq.h
include/linux/soc/qcom/llcc-qcom.h
include/linux/soc/qcom/qmi.h