Linux I2C development
 help / color / mirror / Atom feed
From: Jean Delvare <khali-PUYAD+kWke1g9hUCZPvPmw@public.gmane.org>
To: Randy Dunlap <rdunlap-/UHa2rfvQTnk1uMJSBkQmQ@public.gmane.org>
Cc: David Brownell <david-b-yBeKhBN/0LDR7s880joybQ@public.gmane.org>,
	Linux I2C <i2c-GZX6beZjE8VD60Wz+7aTrA@public.gmane.org>
Subject: Re: i2c kernel-doc warnings
Date: Mon, 18 Aug 2008 22:36:09 +0200	[thread overview]
Message-ID: <20080818223609.7b570357@hyperion.delvare> (raw)
In-Reply-To: <20080721102454.0ffe7631.rdunlap-/UHa2rfvQTnk1uMJSBkQmQ@public.gmane.org>

Hi Randy,

On Mon, 21 Jul 2008 10:24:54 -0700, Randy Dunlap wrote:
> Hi Jean,
> 
> Can you try to have someone fix these, please?
> 
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'id'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'attach_adapter'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'detach_adapter'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'detach_client'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'probe'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'remove'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'shutdown'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'suspend'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'resume'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'command'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'driver'
> Warning(/local/linsrc/repo/linhead//include/linux/i2c.h:169): No description found for parameter 'id_table'

Something like this?

Add missing kernel descriptions of struct i2c_driver members.

Signed-off-by: Jean Delvare <khali-PUYAD+kWke1g9hUCZPvPmw@public.gmane.org>
Cc: Randy Dunlap <rdunlap-/UHa2rfvQTnk1uMJSBkQmQ@public.gmane.org>
Cc: David Brownell <david-b-yBeKhBN/0LDR7s880joybQ@public.gmane.org>
---
 include/linux/i2c.h |   12 ++++++++++++
 1 file changed, 12 insertions(+)

--- linux-2.6.27-rc3.orig/include/linux/i2c.h	2008-08-05 18:18:01.000000000 +0200
+++ linux-2.6.27-rc3/include/linux/i2c.h	2008-08-18 22:33:51.000000000 +0200
@@ -97,7 +97,19 @@ extern s32 i2c_smbus_write_i2c_block_dat
 
 /**
  * struct i2c_driver - represent an I2C device driver
+ * @id: Unique driver ID (optional)
  * @class: What kind of i2c device we instantiate (for detect)
+ * @attach_adapter: Callback for bus addition (for legacy drivers)
+ * @detach_adapter: Callback for bus removal (for legacy drivers)
+ * @detach_client: Callback for device removal (for legacy drivers)
+ * @probe: Callback for device binding (new-style drivers)
+ * @remove: Callback for device unbinding (new-style drivers)
+ * @shutdown: Callback for device shutdown
+ * @suspend: Callback for device suspend
+ * @resume: Callback for device resume
+ * @command: Callback for bus-wide signaling (optional)
+ * @driver: Device driver model driver
+ * @id_table: List of I2C devices supported by this driver
  * @detect: Callback for device detection
  * @address_data: The I2C addresses to probe, ignore or force (for detect)
  * @clients: List of detected clients we created (for i2c-core use only)



-- 
Jean Delvare

_______________________________________________
i2c mailing list
i2c-GZX6beZjE8VD60Wz+7aTrA@public.gmane.org
http://lists.lm-sensors.org/mailman/listinfo/i2c

       reply	other threads:[~2008-08-18 20:36 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20080721102454.0ffe7631.rdunlap@xenotime.net>
     [not found] ` <20080721102454.0ffe7631.rdunlap-/UHa2rfvQTnk1uMJSBkQmQ@public.gmane.org>
2008-08-18 20:36   ` Jean Delvare [this message]
     [not found]     ` <20080818223609.7b570357-ig7AzVSIIG7kN2dkZ6Wm7A@public.gmane.org>
2008-08-18 21:08       ` i2c kernel-doc warnings Randy Dunlap

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=20080818223609.7b570357@hyperion.delvare \
    --to=khali-puyad+kwke1g9huczpvpmw@public.gmane.org \
    --cc=david-b-yBeKhBN/0LDR7s880joybQ@public.gmane.org \
    --cc=i2c-GZX6beZjE8VD60Wz+7aTrA@public.gmane.org \
    --cc=rdunlap-/UHa2rfvQTnk1uMJSBkQmQ@public.gmane.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox