[media] doc-rst: Fix conversion for v4l2 core functions
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 17 Jul 2016 11:44:08 +0000 (08:44 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 17 Jul 2016 17:02:43 +0000 (14:02 -0300)
commit89cb3ddbe7cc5ce49ffa814f30fb019fc531865d
tree5c128535f9ec12a3b0c3acdcc811321cd9787ff8
parent5b6137dc84f627e8497e554890ae02378c54f9f0
[media] doc-rst: Fix conversion for v4l2 core functions

The conversion from DocBook lead into some conversion issues,
basically due to the lack of proper support at kernel-doc.

So, address them:

- 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.

- kernel-doc doesn't escape things like *pointer, so we
  need to manually add a escape char before it.

- On some cases, kernel-doc conversion requires violating
  the 80-cols, as otherwise it won't properly parse the
  source code.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/kapi/v4l2-core.rst
include/media/tuner-types.h
include/media/tveeprom.h
include/media/v4l2-mc.h
include/media/v4l2-subdev.h
include/media/videobuf2-core.h