[media] docs-rst: improve the kAPI documentation for the mediactl

Browse source

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>

...

This commit is contained in:

Mauro Carvalho Chehab 2016-08-29 16:09:11 -03:00

parent 36aefa35f4

commit 48a7c4bac9

3 changed files with 231 additions and 123 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

115

include/media/media-device.h

View file

2

include/media/media-devnode.h

View file

237

include/media/media-entity.h

View file