Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Lukas Bulwahn and committed by
Bjorn Andersson
8058dfa0 99d52c87

+7 -7
+1 -1
include/linux/soc/qcom/apr.h
··· 113 113 114 114 /** 115 115 * module_apr_driver() - Helper macro for registering a aprbus driver 116 - * @__aprbus_driver: aprbus_driver struct 116 + * @__apr_driver: apr_driver struct 117 117 * 118 118 * Helper macro for aprbus drivers which do not do anything special in 119 119 * module init/exit. This eliminates a lot of boilerplate. Each module
+1 -1
include/linux/soc/qcom/irq.h
··· 7 7 8 8 #define GPIO_NO_WAKE_IRQ ~0U 9 9 10 - /** 10 + /* 11 11 * QCOM specific IRQ domain flags that distinguishes the handling of wakeup 12 12 * capable interrupts by different interrupt controllers. 13 13 *
+3 -3
include/linux/soc/qcom/llcc-qcom.h
··· 35 35 #define LLCC_WRCACHE 31 36 36 37 37 /** 38 - * llcc_slice_desc - Cache slice descriptor 38 + * struct llcc_slice_desc - Cache slice descriptor 39 39 * @slice_id: llcc slice id 40 40 * @slice_size: Size allocated for the llcc slice 41 41 */ ··· 45 45 }; 46 46 47 47 /** 48 - * llcc_edac_reg_data - llcc edac registers data for each error type 48 + * struct llcc_edac_reg_data - llcc edac registers data for each error type 49 49 * @name: Name of the error 50 50 * @synd_reg: Syndrome register address 51 51 * @count_status_reg: Status register address to read the error count ··· 69 69 }; 70 70 71 71 /** 72 - * llcc_drv_data - Data associated with the llcc driver 72 + * struct llcc_drv_data - Data associated with the llcc driver 73 73 * @regmap: regmap associated with the llcc device 74 74 * @bcast_regmap: regmap associated with llcc broadcast offset 75 75 * @cfg: pointer to the data structure for slice configuration
+2 -2
include/linux/soc/qcom/qmi.h
··· 16 16 struct socket; 17 17 18 18 /** 19 - * qmi_header - wireformat header of QMI messages 19 + * struct qmi_header - wireformat header of QMI messages 20 20 * @type: type of message 21 21 * @txn_id: transaction id 22 22 * @msg_id: message id ··· 93 93 #define QMI_ERR_NOT_SUPPORTED_V01 94 94 94 95 95 /** 96 - * qmi_response_type_v01 - common response header (decoded) 96 + * struct qmi_response_type_v01 - common response header (decoded) 97 97 * @result: result of the transaction 98 98 * @error: error value, when @result is QMI_RESULT_FAILURE_V01 99 99 */