Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
media: dvbdev.h: do some kernel-doc cleanups
Some kernel-doc warnings in <media/dvbdev.h> were introduced. A fixup
patch addressed them was already merged, but Randy's approach from:
https://lore.kernel.org/linux-media/20221203060931.19953-1-rdunlap@infradead.org
Had some advantages, as it moves the @dvbdev to the right place inside
dvb_remove_device() documentation and it makes clearer about what
refcounter struct dvb_device refers to.
So, apply the changes suggested by Randy.
Suggested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
+3
-3
+3
-3
include/media/dvbdev.h
+3
-3
include/media/dvbdev.h
···
130
130
* struct dvb_device - represents a DVB device node
131
131
*
132
132
* @list_head: List head with all DVB devices
133
-
* @ref: reference counter
133
+
* @ref: reference count for this device
134
134
* @fops: pointer to struct file_operations
135
135
* @adapter: pointer to the adapter that holds this device node
136
136
* @type: type of the device, as defined by &enum dvb_device_type.
···
266
266
/**
267
267
* dvb_remove_device - Remove a registered DVB device
268
268
*
269
+
* @dvbdev: pointer to struct dvb_device
270
+
*
269
271
* This does not free memory. dvb_free_device() will do that when
270
272
* reference counter is empty
271
-
*
272
-
* @dvbdev: pointer to struct dvb_device
273
273
*/
274
274
void dvb_remove_device(struct dvb_device *dvbdev);
275
275