On Thu, Dec 08, 2022 at 05:57:23PM +0200, Andy Shevchenko wrote: > On Thu, Dec 08, 2022 at 04:40:58PM +0200, Tomi Valkeinen wrote: > > On 08/12/2022 14:26, Andy Shevchenko wrote: > > > On Thu, Dec 08, 2022 at 12:42:13PM +0200, Tomi Valkeinen wrote: > > > > On 08/12/2022 12:39, Tomi Valkeinen wrote: ... > > > > /** > > > > - * Helper to add I2C ATR features to a device driver. > > > > + * struct i2c_atr - Represents the I2C ATR instance > > > > */ > > > > > > This is incomplete. Have you run kernel doc validator against this file? > > > > What's kernel doc validator? Do you mean that it's incomplete and kernel doc > > doesn't work correctly, or that there should be more information here? > > > > I don't get any errors/warnings from any tool I have used. But I agree it > > looks a bit odd with only the name of the struct in the doc. > > ... > > $ scripts/kernel-doc -none -v include/linux/i2c.h > include/linux/i2c.h:79: warning: No description found for return value of 'i2c_master_recv' > include/linux/i2c.h:94: warning: No description found for return value of 'i2c_master_recv_dmasafe' > include/linux/i2c.h:109: warning: No description found for return value of 'i2c_master_send' > include/linux/i2c.h:124: warning: No description found for return value of 'i2c_master_send_dmasafe' > 4 warnings Note, this is just example against existing file, not your case. -- With Best Regards, Andy Shevchenko
