2024-04-26 10:03:31

by Yang Li

Subject: [PATCH -next] 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.

Signed-off-by: Yang Li <[email protected]>
---
drivers/extcon/extcon-adc-jack.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/drivers/extcon/extcon-adc-jack.c b/drivers/extcon/extcon-adc-jack.c
index cf5050a244b2..125016da7fde 100644
--- a/drivers/extcon/extcon-adc-jack.c
+++ b/drivers/extcon/extcon-adc-jack.c
@@ -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;
--
2.20.1.7.g153144c

2024-05-08 15:06:19

by Chanwoo Choi

Subject: Re: [PATCH -next] extcon: adc-jack: Document missing struct members

On Fri, Apr 26, 2024 at 7:01 PM Yang Li <[email protected]> wrote:
>
> 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.
>
> Signed-off-by: Yang Li <[email protected]>
> ---
> drivers/extcon/extcon-adc-jack.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/drivers/extcon/extcon-adc-jack.c b/drivers/extcon/extcon-adc-jack.c
> index cf5050a244b2..125016da7fde 100644
> --- a/drivers/extcon/extcon-adc-jack.c
> +++ b/drivers/extcon/extcon-adc-jack.c
> @@ -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;
> --
> 2.20.1.7.g153144c
>
>

Applied it. Thanks.

--
Best Regards,
Chanwoo Choi
Samsung Electronics