Re: [PATCH 3/5] staging: typec: pd: Document struct pd_message

Sergei Shtylyov
2017-09-11T10:09:47Z

Hello.

On 9/10/2017 11:37 PM, Guenter Roeck wrote:

> struct pd_message is the format of a PD message as seen on the wire.
>
> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
> ---
> drivers/staging/typec/pd.h | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/drivers/staging/typec/pd.h b/drivers/staging/typec/pd.h
> index 30b32ad72acd..42a10883a2cb 100644
> --- a/drivers/staging/typec/pd.h
> +++ b/drivers/staging/typec/pd.h
> @@ -104,6 +104,11 @@ static inline unsigned int pd_header_msgid_le(__le16 header)
>
> #define PD_MAX_PAYLOAD 7
>
> +/*

The kernel-doc comments (to which this comment looks alike) should start
with /**.

> + * struct pd_message - PD message as seen on wire
> + * @header: PD message header
> + * @payload: PD message payload
> + */
> struct pd_message {
> __le16 header;
> __le32 payload[PD_MAX_PAYLOAD];

MBR, Sergei