regulator: stpmic1_regulator: Properly document 'struct stpmic1_regulator_cfg'
authorLee Jones <lee.jones@linaro.org>
Fri, 26 Jun 2020 06:57:33 +0000 (07:57 +0100)
committerMark Brown <broonie@kernel.org>
Fri, 26 Jun 2020 14:34:20 +0000 (15:34 +0100)
In kerneldoc format, data structures have to start with 'struct'
else the kerneldoc tooling/parsers/validators get confused.

Fixes the following W=1 kernel build warning:

 drivers/regulator/stpmic1_regulator.c:25: warning: cannot understand function prototype: 'struct stpmic1_regulator_cfg '

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Cc: Pascal Paillet <p.paillet@st.com>
Link: https://lore.kernel.org/r/20200626065738.93412-5-lee.jones@linaro.org
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/regulator/stpmic1_regulator.c

index adc9973..73e0ab2 100644 (file)
@@ -15,7 +15,7 @@
 #include <dt-bindings/mfd/st,stpmic1.h>
 
 /**
- * stpmic1 regulator description: this structure is used as driver data
+ * struct stpmic1 regulator description: this structure is used as driver data
  * @desc: regulator framework description
  * @mask_reset_reg: mask reset register address
  * @mask_reset_mask: mask rank and mask reset register mask