[PATCH 05/14] iio: docs: add description for a new function member

Mauro Carvalho Chehab
2020-09-10T10:24:46Z

Changeset 78289b4a58b5 ("iio: core: pass parent device as parameter during allocation")
added a new parameter to the allocation function, but didn't
add the corresponding kernel-doc markup, as reported:
./drivers/iio/industrialio-core.c:1531: warning: Function parameter or member 'parent' not described in 'iio_device_alloc'

Copy the parameter description for the devm_ variant.

Fixes: 78289b4a58b5 ("iio: core: pass parent device as parameter during allocation")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
drivers/iio/industrialio-core.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
index b05ff9154310..f60e7bda7f38 100644
--- a/drivers/iio/industrialio-core.c
+++ b/drivers/iio/industrialio-core.c
@@ -1524,6 +1524,8 @@ struct device_type iio_device_type = {

/**
* iio_device_alloc() - allocate an iio_dev from a driver
+ * @parent: Device to allocate iio_dev for, and parent for
+ * this IIO device
* @sizeof_priv: Space to allocate for private structure.
**/
struct iio_dev *iio_device_alloc(struct device *parent, int sizeof_priv)
--
2.26.2