OSDN Git Service

media: lgdt330x: use kernel-doc instead of inlined comments
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 9 Mar 2018 15:53:26 +0000 (10:53 -0500)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Fri, 4 May 2018 15:03:38 +0000 (11:03 -0400)
Change the lgdt330x_config documentation to use kernel-doc
style.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
drivers/media/dvb-frontends/lgdt330x.h

index 61434cb..18bd54e 100644 (file)
@@ -26,25 +26,26 @@ typedef enum lg_chip_t {
                LGDT3303
 }lg_chip_type;
 
+/**
+ * struct lgdt330x_config - contains lgdt330x configuration
+ *
+ * @demod_address:     The demodulator's i2c address
+ * @demod_chip:                LG demodulator chip LGDT3302 or LGDT3303
+ * @serial_mpeg:       MPEG hardware interface - 0:parallel 1:serial
+ * @pll_rf_set:                Callback function to set PLL interface
+ * @set_ts_params:     Callback function to set device param for start_dma
+ * @clock_polarity_flip:
+ *     Flip the polarity of the mpeg data transfer clock using alternate
+ *     init data.
+ *     This option applies ONLY to LGDT3303 - 0:disabled (default) 1:enabled
+ */
 struct lgdt330x_config
 {
-       /* The demodulator's i2c address */
        u8 demod_address;
-
-       /* LG demodulator chip LGDT3302 or LGDT3303 */
        lg_chip_type demod_chip;
-
-       /* MPEG hardware interface - 0:parallel 1:serial */
        int serial_mpeg;
-
-       /* PLL interface */
        int (*pll_rf_set) (struct dvb_frontend* fe, int index);
-
-       /* Need to set device param for start_dma */
        int (*set_ts_params)(struct dvb_frontend* fe, int is_punctured);
-
-       /* Flip the polarity of the mpeg data transfer clock using alternate init data
-        * This option applies ONLY to LGDT3303 - 0:disabled (default) 1:enabled */
        int clock_polarity_flip;
 };