iio:temperature:mlx90632: Add kerneldoc to the internal struct
authorCrt Mori <cmo@melexis.com>
Tue, 18 Aug 2020 21:37:34 +0000 (23:37 +0200)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Thu, 3 Sep 2020 18:40:54 +0000 (19:40 +0100)
Document internal/private struct for mlx90632 device.

Signed-off-by: Crt Mori <cmo@melexis.com>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Link: https://lore.kernel.org/r/20200818213737.140613-3-cmo@melexis.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
drivers/iio/temperature/mlx90632.c

index c3de10b..ce75f5a 100644 (file)
 #define MLX90632_MAX_MEAS_NUM  31 /**< Maximum measurements in list */
 #define MLX90632_SLEEP_DELAY_MS 3000 /**< Autosleep delay */
 
+/**
+ * struct mlx90632_data - private data for the MLX90632 device
+ * @client: I2C client of the device
+ * @lock: Internal mutex for multiple reads for single measurement
+ * @regmap: Regmap of the device
+ * @emissivity: Object emissivity from 0 to 1000 where 1000 = 1.
+ */
 struct mlx90632_data {
        struct i2c_client *client;
-       struct mutex lock; /* Multiple reads for single measurement */
+       struct mutex lock;
        struct regmap *regmap;
        u16 emissivity;
 };