Skip to content

Commit 0db5c79

Browse files
committed
[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 <[email protected]>
1 parent 66fa120 commit 0db5c79

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

include/media/media-devnode.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,9 @@ struct media_file_operations {
6969

7070
/**
7171
* struct media_devnode - Media device node
72+
* @media_dev: pointer to struct &media_device
7273
* @fops: pointer to struct &media_file_operations with media device ops
73-
* @dev: struct device pointer for the media controller device
74+
* @dev: pointer to struct &device containing the media controller device
7475
* @cdev: struct cdev pointer character device
7576
* @parent: parent device
7677
* @minor: device node minor number
@@ -107,7 +108,7 @@ struct media_devnode {
107108
/**
108109
* media_devnode_register - register a media device node
109110
*
110-
* @media_dev: struct media_device we want to register a device node
111+
* @mdev: struct media_device we want to register a device node
111112
* @devnode: media device node structure we want to register
112113
* @owner: should be filled with %THIS_MODULE
113114
*

0 commit comments

Comments
 (0)