[wpan-next,4/4] net: ieee802154: Add a kernel doc header to the ieee802154_addr structure

From: David Girault <david.girault@qorvo.com>

While not being absolutely needed, it at least explain the mode vs. enum
fields.

Signed-off-by: David Girault <david.girault@qorvo.com>
[miquel.raynal@bootlin.com: Isolate this change from a bigger commit and
                            reword the comment]
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 include/net/cfg802154.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

Hello.

On 20.01.22 01:43, Miquel Raynal wrote:
> From: David Girault <david.girault@qorvo.com>
> 
> While not being absolutely needed, it at least explain the mode vs. enum
> fields.
> 
> Signed-off-by: David Girault <david.girault@qorvo.com>
> [miquel.raynal@bootlin.com: Isolate this change from a bigger commit and
>                              reword the comment]
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> ---
>   include/net/cfg802154.h | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 
> diff --git a/include/net/cfg802154.h b/include/net/cfg802154.h
> index 4193c242d96e..0b8b1812cea1 100644
> --- a/include/net/cfg802154.h
> +++ b/include/net/cfg802154.h
> @@ -29,6 +29,16 @@ struct ieee802154_llsec_key_id;
>   struct ieee802154_llsec_key;
>   #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
>   
> +/**
> + * struct ieee802154_addr - IEEE802.15.4 device address
> + * @mode: Address mode from frame header. Can be one of:
> + *        - @IEEE802154_ADDR_NONE
> + *        - @IEEE802154_ADDR_SHORT
> + *        - @IEEE802154_ADDR_LONG
> + * @pan_id: The PAN ID this address belongs to
> + * @short_addr: address if @mode is @IEEE802154_ADDR_SHORT
> + * @extended_addr: address if @mode is @IEEE802154_ADDR_LONG
> + */
>   struct ieee802154_addr {
>   	u8 mode;
>   	__le16 pan_id;
> 

Same here, please fold into the addr moving patch. I see no reason why 
splitting these would make it easier or do I miss something?

regards
Stefan Schmidt

Hi Stefan,

stefan@datenfreihafen.org wrote on Thu, 27 Jan 2022 17:05:42 +0100:

> Hello.
> 
> On 20.01.22 01:43, Miquel Raynal wrote:
> > From: David Girault <david.girault@qorvo.com>
> > 
> > While not being absolutely needed, it at least explain the mode vs. enum
> > fields.
> > 
> > Signed-off-by: David Girault <david.girault@qorvo.com>
> > [miquel.raynal@bootlin.com: Isolate this change from a bigger commit and
> >                              reword the comment]
> > Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> > ---
> >   include/net/cfg802154.h | 10 ++++++++++
> >   1 file changed, 10 insertions(+)
> > 
> > diff --git a/include/net/cfg802154.h b/include/net/cfg802154.h
> > index 4193c242d96e..0b8b1812cea1 100644
> > --- a/include/net/cfg802154.h
> > +++ b/include/net/cfg802154.h
> > @@ -29,6 +29,16 @@ struct ieee802154_llsec_key_id;
> >   struct ieee802154_llsec_key;
> >   #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */  
> >   > +/**  
> > + * struct ieee802154_addr - IEEE802.15.4 device address
> > + * @mode: Address mode from frame header. Can be one of:
> > + *        - @IEEE802154_ADDR_NONE
> > + *        - @IEEE802154_ADDR_SHORT
> > + *        - @IEEE802154_ADDR_LONG
> > + * @pan_id: The PAN ID this address belongs to
> > + * @short_addr: address if @mode is @IEEE802154_ADDR_SHORT
> > + * @extended_addr: address if @mode is @IEEE802154_ADDR_LONG
> > + */
> >   struct ieee802154_addr {
> >   	u8 mode;
> >   	__le16 pan_id;
> >   
> 
> Same here, please fold into the addr moving patch. I see no reason why splitting these would make it easier or do I miss something?

I really split every change that I could as a habit, but there is no
problem with squashing them both.

Thanks,
Miquèl