diff options
| author | Mauro Carvalho Chehab <mchehab@kernel.org> | 2022-12-03 06:09:31 +0000 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@kernel.org> | 2023-05-14 16:05:27 +0100 |
| commit | 633733f5c2aa66583450a107dd0f22786ac30400 (patch) | |
| tree | a1c1b0638490d9941bddf79739b0ae29fe054449 /include | |
| parent | f28701cc24fcfd7f7b2fdd8b87e529b2034314d7 (diff) | |
| download | linux-stable-633733f5c2aa66583450a107dd0f22786ac30400.tar.gz linux-stable-633733f5c2aa66583450a107dd0f22786ac30400.tar.bz2 linux-stable-633733f5c2aa66583450a107dd0f22786ac30400.zip | |
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>
Diffstat (limited to 'include')
| -rw-r--r-- | include/media/dvbdev.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/media/dvbdev.h b/include/media/dvbdev.h index 8958e5e2fc5b..e5a00d126612 100644 --- a/include/media/dvbdev.h +++ b/include/media/dvbdev.h @@ -130,7 +130,7 @@ struct dvb_adapter { * struct dvb_device - represents a DVB device node * * @list_head: List head with all DVB devices - * @ref: reference counter + * @ref: reference count for this device * @fops: pointer to struct file_operations * @adapter: pointer to the adapter that holds this device node * @type: type of the device, as defined by &enum dvb_device_type. @@ -266,10 +266,10 @@ int dvb_register_device(struct dvb_adapter *adap, /** * dvb_remove_device - Remove a registered DVB device * + * @dvbdev: pointer to struct dvb_device + * * This does not free memory. dvb_free_device() will do that when * reference counter is empty - * - * @dvbdev: pointer to struct dvb_device */ void dvb_remove_device(struct dvb_device *dvbdev); |