staging: comedi: s626: Kernel doc format comments

Checkpatch emits WARNING: Block comments use a trailing */ on a
separate line. Offending comments are commenting variables within
the main data structure of s626 driver. We can move these comments
to kernel doc format with the benefit of clearing the warning and
improving the documentation for the driver.

Remove comments on structure members. Add original comments to the
head of the structure definition in kernel doc format.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
Reviewed-by: Ian Abbott <abbotti@mev.co.uk>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/staging/comedi/drivers/s626.c b/drivers/staging/comedi/drivers/s626.c
index 97939b4..4523378 100644 (file)
--- a/drivers/staging/comedi/drivers/s626.c
+++ b/drivers/staging/comedi/drivers/s626.c
@@ -74,26 +74,34 @@ struct s626_buffer_dma {
        void *logical_base;
 };
 
+/**
+ * struct s626_private - Working data for s626 driver.
+ * @ai_cmd_running: non-zero if ai_cmd is running.
+ * @ai_sample_timer: time between samples in units of the timer.
+ * @ai_convert_count: conversion counter.
+ * @ai_convert_timer: time between conversion in units of the timer.
+ * @counter_int_enabs: counter interrupt enable mask for MISC2 register.
+ * @adc_items: number of items in ADC poll list.
+ * @rps_buf: DMA buffer used to hold ADC (RPS1) program.
+ * @ana_buf:  DMA buffer used to receive ADC data and hold DAC data.
+ * @dac_wbuf: pointer to logical adrs of DMA buffer used to hold DAC data.
+ * @dacpol: image of DAC polarity register.
+ * @trim_setpoint: images of TrimDAC setpoints.
+ * @i2c_adrs: I2C device address for onboard EEPROM (board rev dependent)
+ */
 struct s626_private {
-       u8 ai_cmd_running;              /* ai_cmd is running */
-       unsigned int ai_sample_timer;   /* time between samples in
-                                        * units of the timer */
-       int ai_convert_count;           /* conversion counter */
-       unsigned int ai_convert_timer;  /* time between conversion in
-                                        * units of the timer */
-       u16 counter_int_enabs;          /* counter interrupt enable mask
-                                        * for MISC2 register */
-       u8 adc_items;                   /* number of items in ADC poll list */
-       struct s626_buffer_dma rps_buf; /* DMA buffer used to hold ADC (RPS1)
-                                        * program */
-       struct s626_buffer_dma ana_buf; /* DMA buffer used to receive ADC data
-                                        * and hold DAC data */
-       u32 *dac_wbuf;                  /* pointer to logical adrs of DMA buffer
-                                        * used to hold DAC data */
-       u16 dacpol;                     /* image of DAC polarity register */
-       u8 trim_setpoint[12];           /* images of TrimDAC setpoints */
-       u32 i2c_adrs;                   /* I2C device address for onboard EEPROM
-                                        * (board rev dependent) */
+       u8 ai_cmd_running;
+       unsigned int ai_sample_timer;
+       int ai_convert_count;
+       unsigned int ai_convert_timer;
+       u16 counter_int_enabs;
+       u8 adc_items;
+       struct s626_buffer_dma rps_buf;
+       struct s626_buffer_dma ana_buf;
+       u32 *dac_wbuf;
+       u16 dacpol;
+       u8 trim_setpoint[12];
+       u32 i2c_adrs;
 };
 
 /* Counter overflow/index event flag masks for RDMISC2. */