All of lore.kernel.org
 help / color / mirror / Atom feed
From: Guenter Roeck <linux@roeck-us.net>
To: Vivien Didelot <vivien.didelot@savoirfairelinux.com>
Cc: lm-sensors@lm-sensors.org, Jean Delvare <khali@linux-fr.org>,
	linux-kernel@vger.kernel.org, Steve Hardy <shardy@redhat.com>
Subject: Re: [lm-sensors] [PATCH v2 1/2] hwmon: (ads7828) driver cleanup
Date: Tue, 02 Oct 2012 02:55:04 +0000	[thread overview]
Message-ID: <20121002025504.GA3108@roeck-us.net> (raw)
In-Reply-To: <1349144167.5876.13.camel@trivette>

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

_______________________________________________
lm-sensors mailing list
lm-sensors@lm-sensors.org
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors

WARNING: multiple messages have this Message-ID (diff)
From: Guenter Roeck <linux@roeck-us.net>
To: Vivien Didelot <vivien.didelot@savoirfairelinux.com>
Cc: lm-sensors@lm-sensors.org, Jean Delvare <khali@linux-fr.org>,
	linux-kernel@vger.kernel.org, Steve Hardy <shardy@redhat.com>
Subject: Re: [PATCH v2 1/2] hwmon: (ads7828) driver cleanup
Date: Mon, 1 Oct 2012 19:55:04 -0700	[thread overview]
Message-ID: <20121002025504.GA3108@roeck-us.net> (raw)
In-Reply-To: <1349144167.5876.13.camel@trivette>

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

  reply	other threads:[~2012-10-02  2:55 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-10-01 23:16 [lm-sensors] [PATCH v2 1/2] hwmon: (ads7828) driver cleanup Vivien Didelot
2012-10-01 23:16 ` Vivien Didelot
2012-10-01 23:16 ` [lm-sensors] [PATCH v2 2/2] hwmon: (ads7828) add support for ADS7830 Vivien Didelot
2012-10-01 23:16   ` Vivien Didelot
2012-10-02  1:20   ` [lm-sensors] " Guenter Roeck
2012-10-02  1:20     ` Guenter Roeck
2012-10-02  3:28     ` [lm-sensors] " Vivien Didelot
2012-10-02  3:28       ` Vivien Didelot
2012-10-02  4:35       ` [lm-sensors] " Guenter Roeck
2012-10-02  4:35         ` Guenter Roeck
2012-10-02  1:07 ` [lm-sensors] [PATCH v2 1/2] hwmon: (ads7828) driver cleanup Guenter Roeck
2012-10-02  1:07   ` Guenter Roeck
2012-10-02  2:16   ` [lm-sensors] " Vivien Didelot
2012-10-02  2:16     ` Vivien Didelot
2012-10-02  2:55     ` Guenter Roeck [this message]
2012-10-02  2:55       ` Guenter Roeck

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20121002025504.GA3108@roeck-us.net \
    --to=linux@roeck-us.net \
    --cc=khali@linux-fr.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lm-sensors@lm-sensors.org \
    --cc=shardy@redhat.com \
    --cc=vivien.didelot@savoirfairelinux.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.