summaryrefslogtreecommitdiff
path: root/include/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-06-16 08:04:40 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-06-16 08:14:56 -0300
commit0db5c79989de2c68d5abb7ba891bfdb3cd3b7e05 (patch)
tree4869a6c48fd7695d8c9e4d1cb1d9387f338afd99 /include/media
parent66fa12003678512a599fb6f7f753e3f4f512a100 (diff)
[media] media-devnode.h: Fix documentation
Two parameters were documented with a wrong name, and a struct device pointer description was missing. That caused the following warnings, when building documentation: include/media/media-devnode.h:102: warning: No description found for parameter 'media_dev' include/media/media-devnode.h:126: warning: No description found for parameter 'mdev' include/media/media-devnode.h:126: warning: Excess function parameter 'media_dev' description in 'media_devnode_register' Rename the description, to match the function parameter and fix Documentation. No funcional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'include/media')
-rw-r--r--include/media/media-devnode.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/media/media-devnode.h b/include/media/media-devnode.h
index f0b7dd79fb92..37d494805944 100644
--- a/include/media/media-devnode.h
+++ b/include/media/media-devnode.h
@@ -69,8 +69,9 @@ struct media_file_operations {
/**
* struct media_devnode - Media device node
+ * @media_dev: pointer to struct &media_device
* @fops: pointer to struct &media_file_operations with media device ops
- * @dev: struct device pointer for the media controller device
+ * @dev: pointer to struct &device containing the media controller device
* @cdev: struct cdev pointer character device
* @parent: parent device
* @minor: device node minor number
@@ -107,7 +108,7 @@ struct media_devnode {
/**
* media_devnode_register - register a media device node
*
- * @media_dev: struct media_device we want to register a device node
+ * @mdev: struct media_device we want to register a device node
* @devnode: media device node structure we want to register
* @owner: should be filled with %THIS_MODULE
*