gpiolib: convert gpiod_lookup description to kernel-doc

The patch moves description of the fields to the top of struct definition and
converts them to the kernel-doc format.

There is no functional change.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: Alexandre Courbot <acourbot@nvidia.com>
Reviewed-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index 44c66b29a2d9ca0c0af3b428381d9a826a4aaa2e..a3e181e0963607854222259904ebd046e35d8d12 100644 (file)
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -137,29 +137,21 @@ enum gpio_lookup_flags {
 };
 
 /**
- * Lookup table for associating GPIOs to specific devices and functions using
- * platform data.
+ * struct gpiod_lookup - lookup table
+ * @chip_label: name of the chip the GPIO belongs to
+ * @chip_hwnum: hardware number (i.e. relative to the chip) of the GPIO
+ * @con_id: name of the GPIO from the device's point of view
+ * @idx: index of the GPIO in case several GPIOs share the same name
+ * @flags: mask of GPIO_* values
+ *
+ * gpiod_lookup is a lookup table for associating GPIOs to specific devices and
+ * functions using platform data.
  */
 struct gpiod_lookup {
-       /*
-        * name of the chip the GPIO belongs to
-        */
        const char *chip_label;
-       /*
-        * hardware number (i.e. relative to the chip) of the GPIO
-        */
        u16 chip_hwnum;
-       /*
-        * name of the GPIO from the device's point of view
-        */
        const char *con_id;
-       /*
-        * index of the GPIO in case several GPIOs share the same name
-        */
        unsigned int idx;
-       /*
-        * mask of GPIO_* values
-        */
        enum gpio_lookup_flags flags;
 };