Skip to contentSkip to conversation

extcon: adc-jack: Document missing struct members

PATCH Applied Yang Li 2 participants 2 messages Apr 26, 2024 – May 8, 2024 External connector subsystem (extcon)

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 extcon: adc-jack: Document missing struct members

This patch adds kernel-doc comments for the previously undocumented members dev and wakeup_source in the struct adc_jack_data in adc-jack device driver.

---
 drivers/extcon/extcon-adc-jack.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/extcon/extcon-adc-jack.c +2 -0
index cf5050a244b2..125016da7fde 100644
@@ -26,6 +26,7 @@
 
 /**
  * struct adc_jack_data - internal data for adc_jack device driver
+ * @dev:		The device structure associated with the adc_jack.
  * @edev:		extcon device.
  * @cable_names:	list of supported cables.
  * @adc_conditions:	list of adc value conditions.
@@ -35,6 +36,7 @@
  *			handling at handling_delay jiffies.
  * @handler:		extcon event handler called by interrupt handler.
  * @chan:		iio channel being queried.
+ * @wakeup_source:	Indicates if the device can wake up the system.
  */
 struct adc_jack_data {
 	struct device *dev;
Signature · 1 line
2.20.1.7.g153144c
Applied
#1 lore raw
Quoted 31 lines · Yang Li

This patch adds kernel-doc comments for the previously undocumented members dev and wakeup_source in the struct adc_jack_data in adc-jack device driver.

---
 drivers/extcon/extcon-adc-jack.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/extcon/extcon-adc-jack.c +2 -1
index cf5050a244b2..125016da7fde 100644
@@ -26,6 +26,7 @@
 
 /**
  * struct adc_jack_data - internal data for adc_jack device driver
+ * @dev:               The device structure associated with the adc_jack.
  * @edev:              extcon device.
  * @cable_names:       list of supported cables.
  * @adc_conditions:    list of adc value conditions.
@@ -35,6 +36,7 @@
  *                     handling at handling_delay jiffies.
  * @handler:           extcon event handler called by interrupt handler.
  * @chan:              iio channel being queried.
+ * @wakeup_source:     Indicates if the device can wake up the system.
  */
 struct adc_jack_data {
        struct device *dev;
--
Quoted 3 lines

2.20.1.7.g153144c

Applied it. Thanks.

Signature · 3 lines
Best Regards,
Chanwoo Choi
Samsung Electronics