diff options
| author | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-12-16 13:53:04 -0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2016-01-11 12:19:22 -0200 |
| commit | 92777994a52e6c1fe0a6156a8b49e83efea6fd2c (patch) | |
| tree | d4dad944838e23813a302a8795bb2d470b4ed9ff /include/media/media-device.h | |
| parent | 0798ce4a386d605af9ddbed724a8f4c8cccc1dab (diff) | |
[media] move documentation to the header files
Some exported functions were still documented at the .c file,
instead of documenting at the .h one.
Move the documentation to the right place, as we only use headers
at media device-drivers.xml DocBook.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Diffstat (limited to 'include/media/media-device.h')
| -rw-r--r-- | include/media/media-device.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/include/media/media-device.h b/include/media/media-device.h index da4e12ca259c..706afdb22d0d 100644 --- a/include/media/media-device.h +++ b/include/media/media-device.h @@ -428,6 +428,8 @@ void media_device_cleanup(struct media_device *mdev); * a sysfs attribute. * * Unregistering a media device that hasn't been registered is *NOT* safe. + * + * Return: returns zero on success or a negative error code. */ int __must_check __media_device_register(struct media_device *mdev, struct module *owner); @@ -437,6 +439,10 @@ int __must_check __media_device_register(struct media_device *mdev, * __media_device_unregister() - Unegisters a media device element * * @mdev: pointer to struct &media_device + * + * + * It is safe to call this function on an unregistered (but initialised) + * media device. */ void media_device_unregister(struct media_device *mdev); |