diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-29 21:09:11 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-09 14:28:55 +0200 |
| commit | 48a7c4bac94dfb367d1d64123b5182536912c03e (patch) | |
| tree | f52da0344a4a9af35872a4fa06dd7a21b2470fcf /include/media/media-devnode.h | |
| parent | [media] demux.h: fix a documentation warning (diff) | |
| download | linux-48a7c4bac94dfb367d1d64123b5182536912c03e.tar.xz linux-48a7c4bac94dfb367d1d64123b5182536912c03e.zip | |
[media] docs-rst: improve the kAPI documentation for the mediactl
There are several issues on the documentation:
- the media.h header were not properly referenced;
- verbatim expressions were not properly marked as such;
- struct member references were wrong;
- some notes were not using the right markup;
- a comment that were moved to the kernel-doc markup were
duplicated as a comment inside the struct media_entity;
- some args were not pointing to the struct they're using;
- macros weren't documented.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'include/media/media-devnode.h')
| -rw-r--r-- | include/media/media-devnode.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/include/media/media-devnode.h b/include/media/media-devnode.h index 37d494805944..972168e90413 100644 --- a/include/media/media-devnode.h +++ b/include/media/media-devnode.h @@ -75,7 +75,7 @@ struct media_file_operations { * @cdev: struct cdev pointer character device * @parent: parent device * @minor: device node minor number - * @flags: flags, combination of the MEDIA_FLAG_* constants + * @flags: flags, combination of the ``MEDIA_FLAG_*`` constants * @release: release callback called at the end of media_devnode_release() * * This structure represents a media-related device node. |