diff mbox series

[v1,01/14] extcon: Fix kernel doc of property fields to avoid warnings

Message ID 20230322144005.40368-2-andriy.shevchenko@linux.intel.com
State New
Headers
Series extcon: Core cleanups and documentation fixes |

Commit Message

Andy Shevchenko March 22, 2023, 2:39 p.m. UTC 
  Kernel documentation has to be synchronized with a code, otherwise
the validator is not happy:

     Function parameter or member 'usb_propval' not described in 'extcon_cable'
     Function parameter or member 'chg_propval' not described in 'extcon_cable'
     Function parameter or member 'jack_propval' not described in 'extcon_cable'
     Function parameter or member 'disp_propval' not described in 'extcon_cable'

Describe the fields added in the past.

Fixes: 067c1652e7a7 ("extcon: Add the support for extcon property according to extcon type")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/extcon/extcon.c | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Chanwoo Choi April 3, 2023, 1:50 p.m. UTC | #1 
On 23. 3. 22. 23:39, Andy Shevchenko wrote:
> Kernel documentation has to be synchronized with a code, otherwise
> the validator is not happy:
> 
>      Function parameter or member 'usb_propval' not described in 'extcon_cable'
>      Function parameter or member 'chg_propval' not described in 'extcon_cable'
>      Function parameter or member 'jack_propval' not described in 'extcon_cable'
>      Function parameter or member 'disp_propval' not described in 'extcon_cable'
> 
> Describe the fields added in the past.
> 
> Fixes: 067c1652e7a7 ("extcon: Add the support for extcon property according to extcon type")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
>  drivers/extcon/extcon.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/extcon/extcon.c b/drivers/extcon/extcon.c
> index 3997b39680b7..1bc2639704c2 100644
> --- a/drivers/extcon/extcon.c
> +++ b/drivers/extcon/extcon.c
> @@ -206,6 +206,10 @@ static const struct __extcon_info {
>   * @attr_name:		"name" sysfs entry
>   * @attr_state:		"state" sysfs entry
>   * @attrs:		the array pointing to attr_name and attr_state for attr_g
> + * @usb_propval:	the array of USB connector properties
> + * @chg_propval:	the array of charger connector properties
> + * @jack_propval:	the array of jack connector properties
> + * @disp_propval:	the array of display connector properties
>   */
>  struct extcon_cable {
>  	struct extcon_dev *edev;

Applied it. Thanks.
diff mbox series

Patch

diff --git a/drivers/extcon/extcon.c b/drivers/extcon/extcon.c
index 3997b39680b7..1bc2639704c2 100644
--- a/drivers/extcon/extcon.c
+++ b/drivers/extcon/extcon.c
@@ -206,6 +206,10 @@  static const struct __extcon_info {
  * @attr_name:		"name" sysfs entry
  * @attr_state:		"state" sysfs entry
  * @attrs:		the array pointing to attr_name and attr_state for attr_g
+ * @usb_propval:	the array of USB connector properties
+ * @chg_propval:	the array of charger connector properties
+ * @jack_propval:	the array of jack connector properties
+ * @disp_propval:	the array of display connector properties
  */
 struct extcon_cable {
 	struct extcon_dev *edev;