From 89cb3ddbe7cc5ce49ffa814f30fb019fc531865d Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Sun, 17 Jul 2016 08:44:08 -0300 Subject: [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 --- Documentation/media/kapi/v4l2-core.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'Documentation/media') diff --git a/Documentation/media/kapi/v4l2-core.rst b/Documentation/media/kapi/v4l2-core.rst index a1b73e8d6795..4e2aa721d9c8 100644 --- a/Documentation/media/kapi/v4l2-core.rst +++ b/Documentation/media/kapi/v4l2-core.rst @@ -34,3 +34,24 @@ Video2Linux devices .. 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 -- cgit v1.2.3