Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1191825

[PATCH 1/6] iio: core: Add function params for kernel docs

Show all headers | View raw

This patch adds the missing fields in kernel docs to remove
some warnings that appear when the IIO Documentation DocBook
is generated.

Signed-off-by: Cristina Opriceana <cristina.opriceana@gmail.com>
---
 drivers/iio/industrialio-core.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
index d8051cd..da643b9 100644
--- a/drivers/iio/industrialio-core.c
+++ b/drivers/iio/industrialio-core.c
@@ -406,10 +406,16 @@ EXPORT_SYMBOL_GPL(iio_enum_write);
 
 /**
  * iio_format_value() - Formats a IIO value into its string representation
- * @buf: The buffer to which the formated value gets written
- * @type: One of the IIO_VAL_... constants. This decides how the val and val2
- *        parameters are formatted.
- * @vals: pointer to the values, exact meaning depends on the type parameter.
+ * @buf:	The buffer to which the formated value gets written
+ * @type:	One of the IIO_VAL_... constants. This decides how the val
+ *		and val2 parameters are formatted.
+ * @size:	Number of IIO value entries contained in vals
+ * @vals:	Pointer to the values, exact meaning depends on the
+ *		type parameter.
+ *
+ * Return: 0 by default, a negative number on failiure or the
+ *	   total number of characters written for a type that belongs
+ *	   to the IIO_VAL_... constant.
  */
 ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals)
 {
@@ -1096,6 +1102,11 @@ EXPORT_SYMBOL_GPL(devm_iio_device_free);
 
 /**
  * iio_chrdev_open() - chrdev file open for buffer access and ioctls
+ * @inode:	Inode structure for identifying the device in the file system
+ * @filp:	File structure for iio device used to keep and later access
+ *		private data
+ *
+ * Return: 0 on success or -EBUSY if the device is already opened
  **/
 static int iio_chrdev_open(struct inode *inode, struct file *filp)
 {
@@ -1114,7 +1125,11 @@ static int iio_chrdev_open(struct inode *inode, struct file *filp)
 
 /**
  * iio_chrdev_release() - chrdev file close buffer access and ioctls
- **/
+ * @inode:	Inode structure pointer for the char device
+ * @filp:	File structure pointer for the char device
+ *
+ * Return: 0 for successful release
+ */
 static int iio_chrdev_release(struct inode *inode, struct file *filp)
 {
 	struct iio_dev *indio_dev = container_of(inode->i_cdev,
-- 
1.9.1

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

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[PATCH 0/6] iio: Fix kernel docs warnings Cristina Opriceana <cristina.opriceana@gmail.com> - 2015-07-24 15:20 +0200
  [PATCH 2/6] iio: buffer: Fix kernel docs warnings Cristina Opriceana <cristina.opriceana@gmail.com> - 2015-07-24 15:20 +0200
    Re: [PATCH 2/6] iio: buffer: Fix kernel docs warnings Hartmut Knaack <knaack.h@gmx.de> - 2015-08-02 21:40 +0200
      Re: [PATCH 2/6] iio: buffer: Fix kernel docs warnings Hartmut Knaack <knaack.h@gmx.de> - 2015-08-02 21:50 +0200
        Re: [PATCH 2/6] iio: buffer: Fix kernel docs warnings Cristina Georgiana Opriceana <cristina.opriceana@gmail.com> - 2015-08-03 12:50 +0200
    Re: [PATCH 2/6] iio: buffer: Fix kernel docs warnings Jonathan Cameron <jic23@kernel.org> - 2015-08-02 19:30 +0200
  [PATCH 1/6] iio: core: Add function params for kernel docs Cristina Opriceana <cristina.opriceana@gmail.com> - 2015-07-24 15:20 +0200
    Re: [PATCH 1/6] iio: core: Add function params for kernel docs Jonathan Cameron <jic23@kernel.org> - 2015-08-02 19:30 +0200
  [PATCH 3/6] iio: trigger: Add missing fields in kernel docs Cristina Opriceana <cristina.opriceana@gmail.com> - 2015-07-24 15:30 +0200
    Re: [PATCH 3/6] iio: trigger: Add missing fields in kernel docs Jonathan Cameron <jic23@kernel.org> - 2015-08-02 19:40 +0200
  [PATCH 5/6] include: linux: iio: Fix function parameter name in  kernel doc Cristina Opriceana <cristina.opriceana@gmail.com> - 2015-07-24 15:30 +0200
    Re: [PATCH 5/6] include: linux: iio: Fix function parameter name in  kernel doc Jonathan Cameron <jic23@kernel.org> - 2015-08-02 19:40 +0200
  [PATCH 6/6] include: linux: iio: Add missing kernel doc field Cristina Opriceana <cristina.opriceana@gmail.com> - 2015-07-24 15:30 +0200
    Re: [PATCH 6/6] include: linux: iio: Add missing kernel doc field Jonathan Cameron <jic23@kernel.org> - 2015-08-02 19:40 +0200
  [PATCH 4/6] iio: event: Add missing fields in kernel docs Cristina Opriceana <cristina.opriceana@gmail.com> - 2015-07-24 15:30 +0200
    Re: [PATCH 4/6] iio: event: Add missing fields in kernel docs Hartmut Knaack <knaack.h@gmx.de> - 2015-08-02 21:50 +0200
      Re: [PATCH 4/6] iio: event: Add missing fields in kernel docs Lars-Peter Clausen <lars@metafoo.de> - 2015-08-03 11:10 +0200
      Re: [PATCH 4/6] iio: event: Add missing fields in kernel docs Cristina Georgiana Opriceana <cristina.opriceana@gmail.com> - 2015-08-03 11:10 +0200
    Re: [PATCH 4/6] iio: event: Add missing fields in kernel docs Jonathan Cameron <jic23@kernel.org> - 2015-08-02 19:40 +0200

csiph-web