]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/commit
[media] doc-rst: Fix conversion for MC core functions
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 17 Jul 2016 12:18:03 +0000 (09:18 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 17 Jul 2016 17:02:44 +0000 (14:02 -0300)
commit74604b7390af3afb1bcb055b87787b5cfabd03a0
tree4de9f0a2071a48f384a9e078fcb41ba97d803043
parent89cb3ddbe7cc5ce49ffa814f30fb019fc531865d
[media] doc-rst: Fix conversion for MC core functions

There were lots of issues at the media controller side,
after the conversion:

- Some documentation at the header files weren't using the
  kernel-doc start block;

- Now, the C files with the exported symbols also need to be
  added. So, all headers need to be included twice: one to
  get the structs/enums/.. and another one for the functions;

- Notes should use the ReST tag, as kernel-doc doesn't
  recognizes it anymore;

- Identation needs to be fixed, as ReST uses it to identify
  when a format "tag" ends.

- Fix the cross-references at the media controller description.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/kapi/mc-core.rst
include/media/media-device.h
include/media/media-entity.h