[PATCH v2] usb: gadget: add doc to struct usb_composite_dev

[PATCH v2] usb: gadget: add doc to struct usb_composite_dev

[Jó Ágila Bitsch]

Added documentation to new struct members for WebUSB:
* bcd_webusb_version
* b_webusb_vendor_code
* landing_page
* use_webusb
to avoid warnings in the build of htmldocs

Fixes: 93c473948c58 ("usb: gadget: add WebUSB landing page support")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Jó Ágila Bitsch <jgilab@gmail.com>
---
V0 -> V1: added Reported-By and Fixes Tags
V1 -> V2: fixed Reported-by tag (capitalization of "-by" was wrong)
          also post to linux-usb

 include/linux/usb/composite.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
index 91d22c3ed458..7ef8cea67f50 100644
--- a/include/linux/usb/composite.h
+++ b/include/linux/usb/composite.h
@@ -432,6 +432,10 @@ static inline struct usb_composite_driver *to_cdriver(
  * @qw_sign: qwSignature part of the OS string
  * @b_vendor_code: bMS_VendorCode part of the OS string
  * @use_os_string: false by default, interested gadgets set it
+ * @bcd_webusb_version: 0x0100 by default, WebUSB specification version
+ * @b_webusb_vendor_code: 0x0 by default, vendor code for WebUSB
+ * @landing_page: empty by default, landing page to announce in WebUSB
+ * @use_webusb:: false by default, interested gadgets set it
  * @os_desc_config: the configuration to be used with OS descriptors
  * @setup_pending: true when setup request is queued but not completed
  * @os_desc_pending: true when os_desc request is queued but not completed
-- 
2.37.2

Re: [PATCH v2] usb: gadget: add doc to struct usb_composite_dev

[Randy Dunlap]

Hi,

On 2/4/23 04:15, Jó Ágila Bitsch wrote:
> Added documentation to new struct members for WebUSB:
> * bcd_webusb_version
> * b_webusb_vendor_code
> * landing_page
> * use_webusb
> to avoid warnings in the build of htmldocs
> 
> Fixes: 93c473948c58 ("usb: gadget: add WebUSB landing page support")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Jó Ágila Bitsch <jgilab@gmail.com>
> ---
> V0 -> V1: added Reported-By and Fixes Tags
> V1 -> V2: fixed Reported-by tag (capitalization of "-by" was wrong)
>           also post to linux-usb
> 
>  include/linux/usb/composite.h | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
> index 91d22c3ed458..7ef8cea67f50 100644
> --- a/include/linux/usb/composite.h
> +++ b/include/linux/usb/composite.h
> @@ -432,6 +432,10 @@ static inline struct usb_composite_driver *to_cdriver(
>   * @qw_sign: qwSignature part of the OS string
>   * @b_vendor_code: bMS_VendorCode part of the OS string
>   * @use_os_string: false by default, interested gadgets set it
> + * @bcd_webusb_version: 0x0100 by default, WebUSB specification version
> + * @b_webusb_vendor_code: 0x0 by default, vendor code for WebUSB
> + * @landing_page: empty by default, landing page to announce in WebUSB
> + * @use_webusb:: false by default, interested gadgets set it

Please drop one ':' above so that kernel-doc does not complain:

include/linux/usb/composite.h:523: warning: Function parameter or member 'use_webusb' not described in 'usb_composite_dev'

>   * @os_desc_config: the configuration to be used with OS descriptors
>   * @setup_pending: true when setup request is queued but not completed
>   * @os_desc_pending: true when os_desc request is queued but not completed

Thanks.
-- 
~Randy