Re: [PATCH v2 1/2] hwmon: (ads7828) driver cleanup

From: Guenter Roeck
Date: Mon Oct 01 2012 - 22:54:30 EST


On Mon, Oct 01, 2012 at 10:16:07PM -0400, Vivien Didelot wrote:
> Hi Guenter,
>
[ ... ]
> > >
> > > -/* Each client has this additional data */
> > > +/**
> > > + * struct ads7828_data - client specific data
> > > + * @hwmon_dev: The hwmon device.
> > > + * @update_lock: Mutex protecting updates.
> > > + * @valid: Validity flag.
> > > + * @last_updated: Last updated time (in jiffies).
> > > + * @adc_input: ADS7828_NCH samples.
> > > + */
> > This isn't really an externally visible API, so I wonder if it provides value to
> > document it this way. No strong opinion, just wondering.
> I found the version below a bit cluttered, that's why I used the
> KernelDoc notation. Would you prefer something else, like right-aligned
> comments?

Tab aligned, maybe ? Not sure if that works out, though.

Guenter
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/