linux/Documentation/media/kapi/v4l2-core.rst
Mauro Carvalho Chehab 89cb3ddbe7 [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>
2016-07-17 14:02:43 -03:00

58 lines
1.4 KiB
ReStructuredText

Video2Linux devices
-------------------
.. kernel-doc:: include/media/tuner.h
.. kernel-doc:: include/media/tuner-types.h
.. kernel-doc:: include/media/tveeprom.h
.. kernel-doc:: include/media/v4l2-async.h
.. kernel-doc:: include/media/v4l2-ctrls.h
.. kernel-doc:: include/media/v4l2-dv-timings.h
.. kernel-doc:: include/media/v4l2-event.h
.. kernel-doc:: include/media/v4l2-flash-led-class.h
.. kernel-doc:: include/media/v4l2-mc.h
.. kernel-doc:: include/media/v4l2-mediabus.h
.. kernel-doc:: include/media/v4l2-mem2mem.h
.. kernel-doc:: include/media/v4l2-of.h
.. kernel-doc:: include/media/v4l2-rect.h
.. kernel-doc:: include/media/v4l2-subdev.h
.. kernel-doc:: include/media/videobuf2-core.h
.. kernel-doc:: include/media/videobuf2-v4l2.h
.. kernel-doc:: include/media/videobuf2-memops.h
.. kernel-doc:: include/media/tveeprom.h
:export: drivers/media/common/tveeprom.c
.. kernel-doc:: include/media/v4l2-ctrls.h
:export: drivers/media/v4l2-core/v4l2-ctrls.c
.. kernel-doc:: include/media/v4l2-dv-timings.h
:export: drivers/media/v4l2-core/v4l2-dv-timings.c
.. kernel-doc:: include/media/v4l2-flash-led-class.h
:export: drivers/media/v4l2-core/v4l2-flash-led-class.c
.. kernel-doc:: include/media/v4l2-mc.h
:export: drivers/media/v4l2-core/v4l2-mc.c
.. kernel-doc:: include/media/videobuf2-core.h
:export: drivers/media/v4l2-core/videobuf2-core.c