[v1] i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members

[PATCH] i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members

Posted by Rosen Penev 1 week, 1 day ago

Add kernel-doc documentation for the struct members that were previously
undocumented. This fixes warnings when building with W=1 and ensures
the struct is fully documented per kernel-doc conventions.

Assisted-by: Opencode:Big-pickle
Signed-off-by: Rosen Penev &lt;rosenp@gmail.com&gt;
---
 drivers/i2c/busses/i2c-mxs.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/drivers/i2c/busses/i2c-mxs.c b/drivers/i2c/busses/i2c-mxs.c
index 08c9091a1e35..4e07babea9c3 100644
--- a/drivers/i2c/busses/i2c-mxs.c
+++ b/drivers/i2c/busses/i2c-mxs.c
@@ -108,6 +108,14 @@ enum mxs_i2c_devtype {
  * @cmd_complete: completion object for transaction wait
  * @cmd_err: error code for last transaction
  * @adapter: i2c subsystem adapter node
+ * @timing0: I2C TIMING0 register value
+ * @timing1: I2C TIMING1 register value
+ * @timing2: I2C TIMING2 register value
+ * @dmach: DMA channel
+ * @pio_data: PIO data for DMA
+ * @addr_data: address data for DMA
+ * @sg_io: scatterlist for I/O
+ * @dma_read: flag indicating DMA read
  */
 struct mxs_i2c_dev {
 	struct device *dev;
--
2.54.0

Re: [PATCH] i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members

Posted by Frank Li 5 days, 10 hours ago

On Sat, May 30, 2026 at 01:05:54PM -0700, Rosen Penev wrote:
> Add kernel-doc documentation for the struct members that were previously
> undocumented. This fixes warnings when building with W=1 and ensures
> the struct is fully documented per kernel-doc conventions.
>
> Assisted-by: Opencode:Big-pickle
> Signed-off-by: Rosen Penev &lt;rosenp@gmail.com&gt;

&lt; is html tags. Please fix it.

Frank

> ---
>  drivers/i2c/busses/i2c-mxs.c | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/drivers/i2c/busses/i2c-mxs.c b/drivers/i2c/busses/i2c-mxs.c
> index 08c9091a1e35..4e07babea9c3 100644
> --- a/drivers/i2c/busses/i2c-mxs.c
> +++ b/drivers/i2c/busses/i2c-mxs.c
> @@ -108,6 +108,14 @@ enum mxs_i2c_devtype {
>   * @cmd_complete: completion object for transaction wait
>   * @cmd_err: error code for last transaction
>   * @adapter: i2c subsystem adapter node
> + * @timing0: I2C TIMING0 register value
> + * @timing1: I2C TIMING1 register value
> + * @timing2: I2C TIMING2 register value
> + * @dmach: DMA channel
> + * @pio_data: PIO data for DMA
> + * @addr_data: address data for DMA
> + * @sg_io: scatterlist for I/O
> + * @dma_read: flag indicating DMA read
>   */
>  struct mxs_i2c_dev {
>  	struct device *dev;
> --
> 2.54.0
>